SConstruct revision 11999
1955SN/A# -*- mode:python -*-
2955SN/A
311408Sandreas.sandberg@arm.com# Copyright (c) 2013, 2015, 2016 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
815863Snate@binkert.org# Check for recent-enough Python and SCons versions.
825863Snate@binkert.orgtry:
835863Snate@binkert.org    # Really old versions of scons only take two options for the
845863Snate@binkert.org    # function, so check once without the revision and once with the
855863Snate@binkert.org    # revision, the first instance will fail for stuff other than
865863Snate@binkert.org    # 0.98, and the second will fail for 0.98.0
875863Snate@binkert.org    EnsureSConsVersion(0, 98)
885863Snate@binkert.org    EnsureSConsVersion(0, 98, 1)
895863Snate@binkert.orgexcept SystemExit, e:
905863Snate@binkert.org    print """
915863Snate@binkert.orgFor more details, see:
928878Ssteve.reinhardt@amd.com    http://gem5.org/Dependencies
935863Snate@binkert.org"""
945863Snate@binkert.org    raise
955863Snate@binkert.org
969812Sandreas.hansson@arm.com# We ensure the python version early because because python-config
979812Sandreas.hansson@arm.com# requires python 2.5
985863Snate@binkert.orgtry:
999812Sandreas.hansson@arm.com    EnsurePythonVersion(2, 5)
1005863Snate@binkert.orgexcept SystemExit, e:
1015863Snate@binkert.org    print """
1025863Snate@binkert.orgYou can use a non-default installation of the Python interpreter by
1039812Sandreas.hansson@arm.comrearranging your PATH so that scons finds the non-default 'python' and
1049812Sandreas.hansson@arm.com'python-config' first.
1055863Snate@binkert.org
1065863Snate@binkert.orgFor more details, see:
1078878Ssteve.reinhardt@amd.com    http://gem5.org/wiki/index.php/Using_a_non-default_Python_installation
1085863Snate@binkert.org"""
1095863Snate@binkert.org    raise
1105863Snate@binkert.org
1116654Snate@binkert.org# Global Python includes
11210196SCurtis.Dunham@arm.comimport itertools
113955SN/Aimport os
1145396Ssaidi@eecs.umich.eduimport re
11511401Sandreas.sandberg@arm.comimport shutil
1165863Snate@binkert.orgimport subprocess
1175863Snate@binkert.orgimport sys
1184202Sbinkertn@umich.edu
1195863Snate@binkert.orgfrom os import mkdir, environ
1205863Snate@binkert.orgfrom os.path import abspath, basename, dirname, expanduser, normpath
1215863Snate@binkert.orgfrom os.path import exists,  isdir, isfile
1225863Snate@binkert.orgfrom os.path import join as joinpath, split as splitpath
123955SN/A
1246654Snate@binkert.org# SCons includes
1255273Sstever@gmail.comimport SCons
1265871Snate@binkert.orgimport SCons.Node
1275273Sstever@gmail.com
1286655Snate@binkert.orgextra_python_paths = [
1298878Ssteve.reinhardt@amd.com    Dir('src/python').srcnode().abspath, # gem5 includes
1306655Snate@binkert.org    Dir('ext/ply').srcnode().abspath, # ply is used by several files
1316655Snate@binkert.org    ]
1329219Spower.jg@gmail.com
1336655Snate@binkert.orgsys.path[1:1] = extra_python_paths
1345871Snate@binkert.org
1356654Snate@binkert.orgfrom m5.util import compareVersions, readCommand
1368947Sandreas.hansson@arm.comfrom m5.util.terminal import get_termcap
1375396Ssaidi@eecs.umich.edu
1388120Sgblack@eecs.umich.eduhelp_texts = {
1398120Sgblack@eecs.umich.edu    "options" : "",
1408120Sgblack@eecs.umich.edu    "global_vars" : "",
1418120Sgblack@eecs.umich.edu    "local_vars" : ""
1428120Sgblack@eecs.umich.edu}
1438120Sgblack@eecs.umich.edu
1448120Sgblack@eecs.umich.eduExport("help_texts")
1458120Sgblack@eecs.umich.edu
1468879Ssteve.reinhardt@amd.com
1478879Ssteve.reinhardt@amd.com# There's a bug in scons in that (1) by default, the help texts from
1488879Ssteve.reinhardt@amd.com# AddOption() are supposed to be displayed when you type 'scons -h'
1498879Ssteve.reinhardt@amd.com# and (2) you can override the help displayed by 'scons -h' using the
1508879Ssteve.reinhardt@amd.com# Help() function, but these two features are incompatible: once
1518879Ssteve.reinhardt@amd.com# you've overridden the help text using Help(), there's no way to get
1528879Ssteve.reinhardt@amd.com# at the help texts from AddOptions.  See:
1538879Ssteve.reinhardt@amd.com#     http://scons.tigris.org/issues/show_bug.cgi?id=2356
1548879Ssteve.reinhardt@amd.com#     http://scons.tigris.org/issues/show_bug.cgi?id=2611
1558879Ssteve.reinhardt@amd.com# This hack lets us extract the help text from AddOptions and
1568879Ssteve.reinhardt@amd.com# re-inject it via Help().  Ideally someday this bug will be fixed and
1578879Ssteve.reinhardt@amd.com# we can just use AddOption directly.
1588879Ssteve.reinhardt@amd.comdef AddLocalOption(*args, **kwargs):
1598120Sgblack@eecs.umich.edu    col_width = 30
1608120Sgblack@eecs.umich.edu
1618120Sgblack@eecs.umich.edu    help = "  " + ", ".join(args)
1628120Sgblack@eecs.umich.edu    if "help" in kwargs:
1638120Sgblack@eecs.umich.edu        length = len(help)
1648120Sgblack@eecs.umich.edu        if length >= col_width:
1658120Sgblack@eecs.umich.edu            help += "\n" + " " * col_width
1668120Sgblack@eecs.umich.edu        else:
1678120Sgblack@eecs.umich.edu            help += " " * (col_width - length)
1688120Sgblack@eecs.umich.edu        help += kwargs["help"]
1698120Sgblack@eecs.umich.edu    help_texts["options"] += help + "\n"
1708120Sgblack@eecs.umich.edu
1718120Sgblack@eecs.umich.edu    AddOption(*args, **kwargs)
1728120Sgblack@eecs.umich.edu
1738879Ssteve.reinhardt@amd.comAddLocalOption('--colors', dest='use_colors', action='store_true',
1748879Ssteve.reinhardt@amd.com               help="Add color to abbreviated scons output")
1758879Ssteve.reinhardt@amd.comAddLocalOption('--no-colors', dest='use_colors', action='store_false',
1768879Ssteve.reinhardt@amd.com               help="Don't add color to abbreviated scons output")
17710458Sandreas.hansson@arm.comAddLocalOption('--with-cxx-config', dest='with_cxx_config',
17810458Sandreas.hansson@arm.com               action='store_true',
17910458Sandreas.hansson@arm.com               help="Build with support for C++-based configuration")
1808879Ssteve.reinhardt@amd.comAddLocalOption('--default', dest='default', type='string', action='store',
1818879Ssteve.reinhardt@amd.com               help='Override which build_opts file to use for defaults')
1828879Ssteve.reinhardt@amd.comAddLocalOption('--ignore-style', dest='ignore_style', action='store_true',
1838879Ssteve.reinhardt@amd.com               help='Disable style checking hooks')
1849227Sandreas.hansson@arm.comAddLocalOption('--no-lto', dest='no_lto', action='store_true',
1859227Sandreas.hansson@arm.com               help='Disable Link-Time Optimization for fast')
1868879Ssteve.reinhardt@amd.comAddLocalOption('--update-ref', dest='update_ref', action='store_true',
1878879Ssteve.reinhardt@amd.com               help='Update test reference outputs')
1888879Ssteve.reinhardt@amd.comAddLocalOption('--verbose', dest='verbose', action='store_true',
1898879Ssteve.reinhardt@amd.com               help='Print full tool command lines')
19010453SAndrew.Bardsley@arm.comAddLocalOption('--without-python', dest='without_python',
19110453SAndrew.Bardsley@arm.com               action='store_true',
19210453SAndrew.Bardsley@arm.com               help='Build without Python configuration support')
19310456SCurtis.Dunham@arm.comAddLocalOption('--without-tcmalloc', dest='without_tcmalloc',
19410456SCurtis.Dunham@arm.com               action='store_true',
19510456SCurtis.Dunham@arm.com               help='Disable linking against tcmalloc')
19610457Sandreas.hansson@arm.comAddLocalOption('--with-ubsan', dest='with_ubsan', action='store_true',
19710457Sandreas.hansson@arm.com               help='Build with Undefined Behavior Sanitizer if available')
19811342Sandreas.hansson@arm.comAddLocalOption('--with-asan', dest='with_asan', action='store_true',
19911342Sandreas.hansson@arm.com               help='Build with Address Sanitizer if available')
2008120Sgblack@eecs.umich.edu
2018947Sandreas.hansson@arm.comtermcap = get_termcap(GetOption('use_colors'))
2027816Ssteve.reinhardt@amd.com
2035871Snate@binkert.org########################################################################
2045871Snate@binkert.org#
2056121Snate@binkert.org# Set up the main build environment.
2065871Snate@binkert.org#
2075871Snate@binkert.org########################################################################
2089926Sstan.czerniawski@arm.com
2099926Sstan.czerniawski@arm.com# export TERM so that clang reports errors in color
2109119Sandreas.hansson@arm.comuse_vars = set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH',
21110068Sandreas.hansson@arm.com                 'LIBRARY_PATH', 'PATH', 'PKG_CONFIG_PATH', 'PROTOC',
21211989Sandreas.sandberg@arm.com                 'PYTHONPATH', 'RANLIB', 'TERM' ])
213955SN/A
2149416SAndreas.Sandberg@ARM.comuse_prefixes = [
21511342Sandreas.hansson@arm.com    "ASAN_",           # address sanitizer symbolizer path and settings
21611212Sjoseph.gross@amd.com    "CCACHE_",         # ccache (caching compiler wrapper) configuration
21711212Sjoseph.gross@amd.com    "CCC_",            # clang static analyzer configuration
21811212Sjoseph.gross@amd.com    "DISTCC_",         # distcc (distributed compiler wrapper) configuration
21911212Sjoseph.gross@amd.com    "INCLUDE_SERVER_", # distcc pump server settings
22011212Sjoseph.gross@amd.com    "M5",              # M5 configuration (e.g., path to kernels)
2219416SAndreas.Sandberg@ARM.com    ]
2229416SAndreas.Sandberg@ARM.com
2235871Snate@binkert.orguse_env = {}
22410584Sandreas.hansson@arm.comfor key,val in sorted(os.environ.iteritems()):
2259416SAndreas.Sandberg@ARM.com    if key in use_vars or \
2269416SAndreas.Sandberg@ARM.com            any([key.startswith(prefix) for prefix in use_prefixes]):
2275871Snate@binkert.org        use_env[key] = val
228955SN/A
22910671Sandreas.hansson@arm.com# Tell scons to avoid implicit command dependencies to avoid issues
23010671Sandreas.hansson@arm.com# with the param wrappes being compiled twice (see
23110671Sandreas.hansson@arm.com# http://scons.tigris.org/issues/show_bug.cgi?id=2811)
23210671Sandreas.hansson@arm.commain = Environment(ENV=use_env, IMPLICIT_COMMAND_DEPENDENCIES=0)
2338881Smarc.orr@gmail.commain.Decider('MD5-timestamp')
2346121Snate@binkert.orgmain.root = Dir(".")         # The current directory (where this file lives).
2356121Snate@binkert.orgmain.srcdir = Dir("src")     # The source directory
2361533SN/A
2379239Sandreas.hansson@arm.commain_dict_keys = main.Dictionary().keys()
2389239Sandreas.hansson@arm.com
2399239Sandreas.hansson@arm.com# Check that we have a C/C++ compiler
2409239Sandreas.hansson@arm.comif not ('CC' in main_dict_keys and 'CXX' in main_dict_keys):
2419239Sandreas.hansson@arm.com    print "No C++ compiler installed (package g++ on Ubuntu and RedHat)"
2429239Sandreas.hansson@arm.com    Exit(1)
2439239Sandreas.hansson@arm.com
2446655Snate@binkert.org# add useful python code PYTHONPATH so it can be used by subprocesses
2456655Snate@binkert.org# as well
2466655Snate@binkert.orgmain.AppendENVPath('PYTHONPATH', extra_python_paths)
2476655Snate@binkert.org
2485871Snate@binkert.org########################################################################
2495871Snate@binkert.org#
2505863Snate@binkert.org# Mercurial Stuff.
2515871Snate@binkert.org#
2528878Ssteve.reinhardt@amd.com# If the gem5 directory is a mercurial repository, we should do some
2535871Snate@binkert.org# extra things.
2545871Snate@binkert.org#
2555871Snate@binkert.org########################################################################
2565863Snate@binkert.org
2576121Snate@binkert.orghgdir = main.root.Dir(".hg")
2585863Snate@binkert.org
25911408Sandreas.sandberg@arm.com
26011408Sandreas.sandberg@arm.comstyle_message = """
2618336Ssteve.reinhardt@amd.comYou're missing the gem5 style hook, which automatically checks your code
26211469SCurtis.Dunham@arm.comagainst the gem5 style rules on %s.
26311469SCurtis.Dunham@arm.comThis script will now install the hook in your %s.
2648336Ssteve.reinhardt@amd.comPress enter to continue, or ctrl-c to abort: """
2654678Snate@binkert.org
26611887Sandreas.sandberg@arm.commercurial_style_message = """
26711887Sandreas.sandberg@arm.comYou're missing the gem5 style hook, which automatically checks your code
26811887Sandreas.sandberg@arm.comagainst the gem5 style rules on hg commit and qrefresh commands.
26911887Sandreas.sandberg@arm.comThis script will now install the hook in your .hg/hgrc file.
27011887Sandreas.sandberg@arm.comPress enter to continue, or ctrl-c to abort: """
27111887Sandreas.sandberg@arm.com
27211887Sandreas.sandberg@arm.comgit_style_message = """
27311887Sandreas.sandberg@arm.comYou're missing the gem5 style or commit message hook. These hooks help
27411887Sandreas.sandberg@arm.comto ensure that your code follows gem5's style rules on git commit.
27511887Sandreas.sandberg@arm.comThis script will now install the hook in your .git/hooks/ directory.
27611887Sandreas.sandberg@arm.comPress enter to continue, or ctrl-c to abort: """
27711408Sandreas.sandberg@arm.com
27811401Sandreas.sandberg@arm.commercurial_style_upgrade_message = """
27911401Sandreas.sandberg@arm.comYour Mercurial style hooks are not up-to-date. This script will now
28011401Sandreas.sandberg@arm.comtry to automatically update them. A backup of your hgrc will be saved
28111401Sandreas.sandberg@arm.comin .hg/hgrc.old.
28211401Sandreas.sandberg@arm.comPress enter to continue, or ctrl-c to abort: """
28311401Sandreas.sandberg@arm.com
2848336Ssteve.reinhardt@amd.commercurial_style_hook = """
2858336Ssteve.reinhardt@amd.com# The following lines were automatically added by gem5/SConstruct
2868336Ssteve.reinhardt@amd.com# to provide the gem5 style-checking hooks
2874678Snate@binkert.org[extensions]
28811401Sandreas.sandberg@arm.comhgstyle = %s/util/hgstyle.py
2894678Snate@binkert.org
2904678Snate@binkert.org[hooks]
29111401Sandreas.sandberg@arm.compretxncommit.style = python:hgstyle.check_style
29211401Sandreas.sandberg@arm.compre-qrefresh.style = python:hgstyle.check_style
2938336Ssteve.reinhardt@amd.com# End of SConstruct additions
2944678Snate@binkert.org
2958336Ssteve.reinhardt@amd.com""" % (main.root.abspath)
2968336Ssteve.reinhardt@amd.com
2978336Ssteve.reinhardt@amd.commercurial_lib_not_found = """
2988336Ssteve.reinhardt@amd.comMercurial libraries cannot be found, ignoring style hook.  If
2998336Ssteve.reinhardt@amd.comyou are a gem5 developer, please fix this and run the style
3008336Ssteve.reinhardt@amd.comhook. It is important.
3015871Snate@binkert.org"""
3025871Snate@binkert.org
3038336Ssteve.reinhardt@amd.com# Check for style hook and prompt for installation if it's not there.
30411408Sandreas.sandberg@arm.com# Skip this if --ignore-style was specified, there's no interactive
30511408Sandreas.sandberg@arm.com# terminal to prompt, or no recognized revision control system can be
30611408Sandreas.sandberg@arm.com# found.
30711408Sandreas.sandberg@arm.comignore_style = GetOption('ignore_style') or not sys.stdin.isatty()
30811408Sandreas.sandberg@arm.com
30911408Sandreas.sandberg@arm.com# Try wire up Mercurial to the style hooks
31011408Sandreas.sandberg@arm.comif not ignore_style and hgdir.exists():
3118336Ssteve.reinhardt@amd.com    style_hook = True
31211401Sandreas.sandberg@arm.com    style_hooks = tuple()
31311401Sandreas.sandberg@arm.com    hgrc = hgdir.File('hgrc')
31411401Sandreas.sandberg@arm.com    hgrc_old = hgdir.File('hgrc.old')
3155871Snate@binkert.org    try:
3168336Ssteve.reinhardt@amd.com        from mercurial import ui
3178336Ssteve.reinhardt@amd.com        ui = ui.ui()
31811401Sandreas.sandberg@arm.com        ui.readconfig(hgrc.abspath)
31911401Sandreas.sandberg@arm.com        style_hooks = (ui.config('hooks', 'pretxncommit.style', None),
32011401Sandreas.sandberg@arm.com                       ui.config('hooks', 'pre-qrefresh.style', None))
32111401Sandreas.sandberg@arm.com        style_hook = all(style_hooks)
32211401Sandreas.sandberg@arm.com        style_extension = ui.config('extensions', 'style', None)
3234678Snate@binkert.org    except ImportError:
3245871Snate@binkert.org        print mercurial_lib_not_found
3254678Snate@binkert.org
32611401Sandreas.sandberg@arm.com    if "python:style.check_style" in style_hooks:
32711401Sandreas.sandberg@arm.com        # Try to upgrade the style hooks
32811401Sandreas.sandberg@arm.com        print mercurial_style_upgrade_message
32911401Sandreas.sandberg@arm.com        # continue unless user does ctrl-c/ctrl-d etc.
33011401Sandreas.sandberg@arm.com        try:
33111401Sandreas.sandberg@arm.com            raw_input()
33211401Sandreas.sandberg@arm.com        except:
33311401Sandreas.sandberg@arm.com            print "Input exception, exiting scons.\n"
33411401Sandreas.sandberg@arm.com            sys.exit(1)
33511401Sandreas.sandberg@arm.com        shutil.copyfile(hgrc.abspath, hgrc_old.abspath)
33611401Sandreas.sandberg@arm.com        re_style_hook = re.compile(r"^([^=#]+)\.style\s*=\s*([^#\s]+).*")
33711401Sandreas.sandberg@arm.com        re_style_extension = re.compile("style\s*=\s*([^#\s]+).*")
33811450Sandreas.sandberg@arm.com        old, new = open(hgrc_old.abspath, 'r'), open(hgrc.abspath, 'w')
33911450Sandreas.sandberg@arm.com        for l in old:
34011450Sandreas.sandberg@arm.com            m_hook = re_style_hook.match(l)
34111450Sandreas.sandberg@arm.com            m_ext = re_style_extension.match(l)
34211450Sandreas.sandberg@arm.com            if m_hook:
34311450Sandreas.sandberg@arm.com                hook, check = m_hook.groups()
34411450Sandreas.sandberg@arm.com                if check != "python:style.check_style":
34511450Sandreas.sandberg@arm.com                    print "Warning: %s.style is using a non-default " \
34611450Sandreas.sandberg@arm.com                        "checker: %s" % (hook, check)
34711450Sandreas.sandberg@arm.com                if hook not in ("pretxncommit", "pre-qrefresh"):
34811450Sandreas.sandberg@arm.com                    print "Warning: Updating unknown style hook: %s" % hook
34911401Sandreas.sandberg@arm.com
35011450Sandreas.sandberg@arm.com                l = "%s.style = python:hgstyle.check_style\n" % hook
35111450Sandreas.sandberg@arm.com            elif m_ext and m_ext.group(1) == style_extension:
35211450Sandreas.sandberg@arm.com                l = "hgstyle = %s/util/hgstyle.py\n" % main.root.abspath
35311401Sandreas.sandberg@arm.com
35411450Sandreas.sandberg@arm.com            new.write(l)
35511401Sandreas.sandberg@arm.com    elif not style_hook:
3568336Ssteve.reinhardt@amd.com        print mercurial_style_message,
3578336Ssteve.reinhardt@amd.com        # continue unless user does ctrl-c/ctrl-d etc.
3588336Ssteve.reinhardt@amd.com        try:
3598336Ssteve.reinhardt@amd.com            raw_input()
3608336Ssteve.reinhardt@amd.com        except:
3618336Ssteve.reinhardt@amd.com            print "Input exception, exiting scons.\n"
3628336Ssteve.reinhardt@amd.com            sys.exit(1)
3638336Ssteve.reinhardt@amd.com        hgrc_path = '%s/.hg/hgrc' % main.root.abspath
3648336Ssteve.reinhardt@amd.com        print "Adding style hook to", hgrc_path, "\n"
3658336Ssteve.reinhardt@amd.com        try:
36611401Sandreas.sandberg@arm.com            with open(hgrc_path, 'a') as f:
36711401Sandreas.sandberg@arm.com                f.write(mercurial_style_hook)
3688336Ssteve.reinhardt@amd.com        except:
3698336Ssteve.reinhardt@amd.com            print "Error updating", hgrc_path
3708336Ssteve.reinhardt@amd.com            sys.exit(1)
3715871Snate@binkert.org
37211476Sandreas.sandberg@arm.comdef install_git_style_hooks():
37311476Sandreas.sandberg@arm.com    try:
37411476Sandreas.sandberg@arm.com        gitdir = Dir(readCommand(
37511476Sandreas.sandberg@arm.com            ["git", "rev-parse", "--git-dir"]).strip("\n"))
37611476Sandreas.sandberg@arm.com    except Exception, e:
37711476Sandreas.sandberg@arm.com        print "Warning: Failed to find git repo directory: %s" % e
37811476Sandreas.sandberg@arm.com        return
37911476Sandreas.sandberg@arm.com
38011476Sandreas.sandberg@arm.com    git_hooks = gitdir.Dir("hooks")
38111887Sandreas.sandberg@arm.com    def hook_exists(hook_name):
38211887Sandreas.sandberg@arm.com        hook = git_hooks.File(hook_name)
38311887Sandreas.sandberg@arm.com        return hook.exists()
38411408Sandreas.sandberg@arm.com
38511887Sandreas.sandberg@arm.com    def hook_install(hook_name, script):
38611887Sandreas.sandberg@arm.com        hook = git_hooks.File(hook_name)
38711887Sandreas.sandberg@arm.com        if hook.exists():
38811887Sandreas.sandberg@arm.com            print "Warning: Can't install %s, hook already exists." % hook_name
38911887Sandreas.sandberg@arm.com            return
39011887Sandreas.sandberg@arm.com
39111926Sgabeblack@google.com        if hook.islink():
39211926Sgabeblack@google.com            print "Warning: Removing broken symlink for hook %s." % hook_name
39311926Sgabeblack@google.com            os.unlink(hook.get_abspath())
39411926Sgabeblack@google.com
39511887Sandreas.sandberg@arm.com        if not git_hooks.exists():
39611887Sandreas.sandberg@arm.com            mkdir(git_hooks.get_abspath())
39711944Sandreas.sandberg@arm.com            git_hooks.clear()
39811887Sandreas.sandberg@arm.com
39911927Sgabeblack@google.com        abs_symlink_hooks = git_hooks.islink() and \
40011927Sgabeblack@google.com            os.path.isabs(os.readlink(git_hooks.get_abspath()))
40111927Sgabeblack@google.com
40211927Sgabeblack@google.com        # Use a relative symlink if the hooks live in the source directory,
40311927Sgabeblack@google.com        # and the hooks directory is not a symlink to an absolute path.
40411927Sgabeblack@google.com        if hook.is_under(main.root) and not abs_symlink_hooks:
40511887Sandreas.sandberg@arm.com            script_path = os.path.relpath(
40611928Sgabeblack@google.com                os.path.realpath(script.get_abspath()),
40711928Sgabeblack@google.com                os.path.realpath(hook.Dir(".").get_abspath()))
40811887Sandreas.sandberg@arm.com        else:
40911887Sandreas.sandberg@arm.com            script_path = script.get_abspath()
41011887Sandreas.sandberg@arm.com
41111887Sandreas.sandberg@arm.com        try:
41211887Sandreas.sandberg@arm.com            os.symlink(script_path, hook.get_abspath())
41311887Sandreas.sandberg@arm.com        except:
41411887Sandreas.sandberg@arm.com            print "Error updating git %s hook" % hook_name
41511887Sandreas.sandberg@arm.com            raise
41611887Sandreas.sandberg@arm.com
41711887Sandreas.sandberg@arm.com    if hook_exists("pre-commit") and hook_exists("commit-msg"):
41811476Sandreas.sandberg@arm.com        return
41911476Sandreas.sandberg@arm.com
42011408Sandreas.sandberg@arm.com    print git_style_message,
42111408Sandreas.sandberg@arm.com    try:
42211408Sandreas.sandberg@arm.com        raw_input()
42311408Sandreas.sandberg@arm.com    except:
42411408Sandreas.sandberg@arm.com        print "Input exception, exiting scons.\n"
42511408Sandreas.sandberg@arm.com        sys.exit(1)
42611408Sandreas.sandberg@arm.com
42711887Sandreas.sandberg@arm.com    git_style_script = File("util/git-pre-commit.py")
42811887Sandreas.sandberg@arm.com    git_msg_script = File("ext/git-commit-msg")
42911476Sandreas.sandberg@arm.com
43011887Sandreas.sandberg@arm.com    hook_install("pre-commit", git_style_script)
43111887Sandreas.sandberg@arm.com    hook_install("commit-msg", git_msg_script)
43211476Sandreas.sandberg@arm.com
43311476Sandreas.sandberg@arm.com# Try to wire up git to the style hooks
43411476Sandreas.sandberg@arm.comif not ignore_style and main.root.Entry(".git").exists():
43511476Sandreas.sandberg@arm.com    install_git_style_hooks()
4366121Snate@binkert.org
437955SN/A###################################################
438955SN/A#
4392632Sstever@eecs.umich.edu# Figure out which configurations to set up based on the path(s) of
4402632Sstever@eecs.umich.edu# the target(s).
441955SN/A#
442955SN/A###################################################
443955SN/A
444955SN/A# Find default configuration & binary.
4458878Ssteve.reinhardt@amd.comDefault(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug'))
446955SN/A
4472632Sstever@eecs.umich.edu# helper function: find last occurrence of element in list
4482632Sstever@eecs.umich.edudef rfind(l, elt, offs = -1):
4492632Sstever@eecs.umich.edu    for i in range(len(l)+offs, 0, -1):
4502632Sstever@eecs.umich.edu        if l[i] == elt:
4512632Sstever@eecs.umich.edu            return i
4522632Sstever@eecs.umich.edu    raise ValueError, "element not found"
4532632Sstever@eecs.umich.edu
4548268Ssteve.reinhardt@amd.com# Take a list of paths (or SCons Nodes) and return a list with all
4558268Ssteve.reinhardt@amd.com# paths made absolute and ~-expanded.  Paths will be interpreted
4568268Ssteve.reinhardt@amd.com# relative to the launch directory unless a different root is provided
4578268Ssteve.reinhardt@amd.comdef makePathListAbsolute(path_list, root=GetLaunchDir()):
4588268Ssteve.reinhardt@amd.com    return [abspath(joinpath(root, expanduser(str(p))))
4598268Ssteve.reinhardt@amd.com            for p in path_list]
4608268Ssteve.reinhardt@amd.com
4612632Sstever@eecs.umich.edu# Each target must have 'build' in the interior of the path; the
4622632Sstever@eecs.umich.edu# directory below this will determine the build parameters.  For
4632632Sstever@eecs.umich.edu# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
4642632Sstever@eecs.umich.edu# recognize that ALPHA_SE specifies the configuration because it
4658268Ssteve.reinhardt@amd.com# follow 'build' in the build path.
4662632Sstever@eecs.umich.edu
4678268Ssteve.reinhardt@amd.com# The funky assignment to "[:]" is needed to replace the list contents
4688268Ssteve.reinhardt@amd.com# in place rather than reassign the symbol to a new list, which
4698268Ssteve.reinhardt@amd.com# doesn't work (obviously!).
4708268Ssteve.reinhardt@amd.comBUILD_TARGETS[:] = makePathListAbsolute(BUILD_TARGETS)
4713718Sstever@eecs.umich.edu
4722634Sstever@eecs.umich.edu# Generate a list of the unique build roots and configs that the
4732634Sstever@eecs.umich.edu# collected targets reference.
4745863Snate@binkert.orgvariant_paths = []
4752638Sstever@eecs.umich.edubuild_root = None
4768268Ssteve.reinhardt@amd.comfor t in BUILD_TARGETS:
4772632Sstever@eecs.umich.edu    path_dirs = t.split('/')
4782632Sstever@eecs.umich.edu    try:
4792632Sstever@eecs.umich.edu        build_top = rfind(path_dirs, 'build', -2)
4802632Sstever@eecs.umich.edu    except:
4812632Sstever@eecs.umich.edu        print "Error: no non-leaf 'build' dir found on target path", t
4821858SN/A        Exit(1)
4833716Sstever@eecs.umich.edu    this_build_root = joinpath('/',*path_dirs[:build_top+1])
4842638Sstever@eecs.umich.edu    if not build_root:
4852638Sstever@eecs.umich.edu        build_root = this_build_root
4862638Sstever@eecs.umich.edu    else:
4872638Sstever@eecs.umich.edu        if this_build_root != build_root:
4882638Sstever@eecs.umich.edu            print "Error: build targets not under same build root\n"\
4892638Sstever@eecs.umich.edu                  "  %s\n  %s" % (build_root, this_build_root)
4902638Sstever@eecs.umich.edu            Exit(1)
4915863Snate@binkert.org    variant_path = joinpath('/',*path_dirs[:build_top+2])
4925863Snate@binkert.org    if variant_path not in variant_paths:
4935863Snate@binkert.org        variant_paths.append(variant_path)
494955SN/A
4955341Sstever@gmail.com# Make sure build_root exists (might not if this is the first build there)
4965341Sstever@gmail.comif not isdir(build_root):
4975863Snate@binkert.org    mkdir(build_root)
4987756SAli.Saidi@ARM.commain['BUILDROOT'] = build_root
4995341Sstever@gmail.com
5006121Snate@binkert.orgExport('main')
5014494Ssaidi@eecs.umich.edu
5026121Snate@binkert.orgmain.SConsignFile(joinpath(build_root, "sconsign"))
5031105SN/A
5042667Sstever@eecs.umich.edu# Default duplicate option is to use hard links, but this messes up
5052667Sstever@eecs.umich.edu# when you use emacs to edit a file in the target dir, as emacs moves
5062667Sstever@eecs.umich.edu# file to file~ then copies to file, breaking the link.  Symbolic
5072667Sstever@eecs.umich.edu# (soft) links work better.
5086121Snate@binkert.orgmain.SetOption('duplicate', 'soft-copy')
5092667Sstever@eecs.umich.edu
5105341Sstever@gmail.com#
5115863Snate@binkert.org# Set up global sticky variables... these are common to an entire build
5125341Sstever@gmail.com# tree (not specific to a particular build like ALPHA_SE)
5135341Sstever@gmail.com#
5145341Sstever@gmail.com
5158120Sgblack@eecs.umich.eduglobal_vars_file = joinpath(build_root, 'variables.global')
5165341Sstever@gmail.com
5178120Sgblack@eecs.umich.eduglobal_vars = Variables(global_vars_file, args=ARGUMENTS)
5185341Sstever@gmail.com
5198120Sgblack@eecs.umich.eduglobal_vars.AddVariables(
5206121Snate@binkert.org    ('CC', 'C compiler', environ.get('CC', main['CC'])),
5216121Snate@binkert.org    ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])),
5229396Sandreas.hansson@arm.com    ('PROTOC', 'protoc tool', environ.get('PROTOC', 'protoc')),
5235397Ssaidi@eecs.umich.edu    ('BATCH', 'Use batch pool for build and tests', False),
5245397Ssaidi@eecs.umich.edu    ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
5257727SAli.Saidi@ARM.com    ('M5_BUILD_CACHE', 'Cache built objects in this directory', False),
5268268Ssteve.reinhardt@amd.com    ('EXTRAS', 'Add extra directories to the compilation', '')
5276168Snate@binkert.org    )
5285341Sstever@gmail.com
5298120Sgblack@eecs.umich.edu# Update main environment with values from ARGUMENTS & global_vars_file
5308120Sgblack@eecs.umich.eduglobal_vars.Update(main)
5318120Sgblack@eecs.umich.eduhelp_texts["global_vars"] += global_vars.GenerateHelpText(main)
5326814Sgblack@eecs.umich.edu
5335863Snate@binkert.org# Save sticky variable settings back to current variables file
5348120Sgblack@eecs.umich.eduglobal_vars.Save(global_vars_file, main)
5355341Sstever@gmail.com
5365863Snate@binkert.org# Parse EXTRAS variable to build list of all directories where we're
5378268Ssteve.reinhardt@amd.com# look for sources etc.  This list is exported as extras_dir_list.
5386121Snate@binkert.orgbase_dir = main.srcdir.abspath
5396121Snate@binkert.orgif main['EXTRAS']:
5408268Ssteve.reinhardt@amd.com    extras_dir_list = makePathListAbsolute(main['EXTRAS'].split(':'))
5415742Snate@binkert.orgelse:
5425742Snate@binkert.org    extras_dir_list = []
5435341Sstever@gmail.com
5445742Snate@binkert.orgExport('base_dir')
5455742Snate@binkert.orgExport('extras_dir_list')
5465341Sstever@gmail.com
5476017Snate@binkert.org# the ext directory should be on the #includes path
5486121Snate@binkert.orgmain.Append(CPPPATH=[Dir('ext')])
5496017Snate@binkert.org
5507816Ssteve.reinhardt@amd.comdef strip_build_path(path, env):
5517756SAli.Saidi@ARM.com    path = str(path)
5527756SAli.Saidi@ARM.com    variant_base = env['BUILDROOT'] + os.path.sep
5537756SAli.Saidi@ARM.com    if path.startswith(variant_base):
5547756SAli.Saidi@ARM.com        path = path[len(variant_base):]
5557756SAli.Saidi@ARM.com    elif path.startswith('build/'):
5567756SAli.Saidi@ARM.com        path = path[6:]
5577756SAli.Saidi@ARM.com    return path
5587756SAli.Saidi@ARM.com
5597816Ssteve.reinhardt@amd.com# Generate a string of the form:
5607816Ssteve.reinhardt@amd.com#   common/path/prefix/src1, src2 -> tgt1, tgt2
5617816Ssteve.reinhardt@amd.com# to print while building.
5627816Ssteve.reinhardt@amd.comclass Transform(object):
5637816Ssteve.reinhardt@amd.com    # all specific color settings should be here and nowhere else
5647816Ssteve.reinhardt@amd.com    tool_color = termcap.Normal
5657816Ssteve.reinhardt@amd.com    pfx_color = termcap.Yellow
5667816Ssteve.reinhardt@amd.com    srcs_color = termcap.Yellow + termcap.Bold
5677816Ssteve.reinhardt@amd.com    arrow_color = termcap.Blue + termcap.Bold
5687816Ssteve.reinhardt@amd.com    tgts_color = termcap.Yellow + termcap.Bold
5697756SAli.Saidi@ARM.com
5707816Ssteve.reinhardt@amd.com    def __init__(self, tool, max_sources=99):
5717816Ssteve.reinhardt@amd.com        self.format = self.tool_color + (" [%8s] " % tool) \
5727816Ssteve.reinhardt@amd.com                      + self.pfx_color + "%s" \
5737816Ssteve.reinhardt@amd.com                      + self.srcs_color + "%s" \
5747816Ssteve.reinhardt@amd.com                      + self.arrow_color + " -> " \
5757816Ssteve.reinhardt@amd.com                      + self.tgts_color + "%s" \
5767816Ssteve.reinhardt@amd.com                      + termcap.Normal
5777816Ssteve.reinhardt@amd.com        self.max_sources = max_sources
5787816Ssteve.reinhardt@amd.com
5797816Ssteve.reinhardt@amd.com    def __call__(self, target, source, env, for_signature=None):
5807816Ssteve.reinhardt@amd.com        # truncate source list according to max_sources param
5817816Ssteve.reinhardt@amd.com        source = source[0:self.max_sources]
5827816Ssteve.reinhardt@amd.com        def strip(f):
5837816Ssteve.reinhardt@amd.com            return strip_build_path(str(f), env)
5847816Ssteve.reinhardt@amd.com        if len(source) > 0:
5857816Ssteve.reinhardt@amd.com            srcs = map(strip, source)
5867816Ssteve.reinhardt@amd.com        else:
5877816Ssteve.reinhardt@amd.com            srcs = ['']
5887816Ssteve.reinhardt@amd.com        tgts = map(strip, target)
5897816Ssteve.reinhardt@amd.com        # surprisingly, os.path.commonprefix is a dumb char-by-char string
5907816Ssteve.reinhardt@amd.com        # operation that has nothing to do with paths.
5917816Ssteve.reinhardt@amd.com        com_pfx = os.path.commonprefix(srcs + tgts)
5927816Ssteve.reinhardt@amd.com        com_pfx_len = len(com_pfx)
5937816Ssteve.reinhardt@amd.com        if com_pfx:
5947816Ssteve.reinhardt@amd.com            # do some cleanup and sanity checking on common prefix
5957816Ssteve.reinhardt@amd.com            if com_pfx[-1] == ".":
5967816Ssteve.reinhardt@amd.com                # prefix matches all but file extension: ok
5977816Ssteve.reinhardt@amd.com                # back up one to change 'foo.cc -> o' to 'foo.cc -> .o'
5987816Ssteve.reinhardt@amd.com                com_pfx = com_pfx[0:-1]
5997816Ssteve.reinhardt@amd.com            elif com_pfx[-1] == "/":
6007816Ssteve.reinhardt@amd.com                # common prefix is directory path: OK
6017816Ssteve.reinhardt@amd.com                pass
6027816Ssteve.reinhardt@amd.com            else:
6037816Ssteve.reinhardt@amd.com                src0_len = len(srcs[0])
6047816Ssteve.reinhardt@amd.com                tgt0_len = len(tgts[0])
6057816Ssteve.reinhardt@amd.com                if src0_len == com_pfx_len:
6067816Ssteve.reinhardt@amd.com                    # source is a substring of target, OK
6077816Ssteve.reinhardt@amd.com                    pass
6087816Ssteve.reinhardt@amd.com                elif tgt0_len == com_pfx_len:
6097816Ssteve.reinhardt@amd.com                    # target is a substring of source, need to back up to
6107816Ssteve.reinhardt@amd.com                    # avoid empty string on RHS of arrow
6117816Ssteve.reinhardt@amd.com                    sep_idx = com_pfx.rfind(".")
6127816Ssteve.reinhardt@amd.com                    if sep_idx != -1:
6137816Ssteve.reinhardt@amd.com                        com_pfx = com_pfx[0:sep_idx]
6147816Ssteve.reinhardt@amd.com                    else:
6157816Ssteve.reinhardt@amd.com                        com_pfx = ''
6167816Ssteve.reinhardt@amd.com                elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".":
6177816Ssteve.reinhardt@amd.com                    # still splitting at file extension: ok
6187816Ssteve.reinhardt@amd.com                    pass
6197816Ssteve.reinhardt@amd.com                else:
6207816Ssteve.reinhardt@amd.com                    # probably a fluke; ignore it
6217816Ssteve.reinhardt@amd.com                    com_pfx = ''
6227816Ssteve.reinhardt@amd.com        # recalculate length in case com_pfx was modified
6237816Ssteve.reinhardt@amd.com        com_pfx_len = len(com_pfx)
6247816Ssteve.reinhardt@amd.com        def fmt(files):
6257816Ssteve.reinhardt@amd.com            f = map(lambda s: s[com_pfx_len:], files)
6267816Ssteve.reinhardt@amd.com            return ', '.join(f)
6277816Ssteve.reinhardt@amd.com        return self.format % (com_pfx, fmt(srcs), fmt(tgts))
6287816Ssteve.reinhardt@amd.com
6297816Ssteve.reinhardt@amd.comExport('Transform')
6307816Ssteve.reinhardt@amd.com
6318947Sandreas.hansson@arm.com# enable the regression script to use the termcap
6328947Sandreas.hansson@arm.commain['TERMCAP'] = termcap
6337756SAli.Saidi@ARM.com
6348120Sgblack@eecs.umich.eduif GetOption('verbose'):
6357756SAli.Saidi@ARM.com    def MakeAction(action, string, *args, **kwargs):
6367756SAli.Saidi@ARM.com        return Action(action, *args, **kwargs)
6377756SAli.Saidi@ARM.comelse:
6387756SAli.Saidi@ARM.com    MakeAction = Action
6397816Ssteve.reinhardt@amd.com    main['CCCOMSTR']        = Transform("CC")
6407816Ssteve.reinhardt@amd.com    main['CXXCOMSTR']       = Transform("CXX")
6417816Ssteve.reinhardt@amd.com    main['ASCOMSTR']        = Transform("AS")
6427816Ssteve.reinhardt@amd.com    main['ARCOMSTR']        = Transform("AR", 0)
6437816Ssteve.reinhardt@amd.com    main['LINKCOMSTR']      = Transform("LINK", 0)
64411979Sgabeblack@google.com    main['SHLINKCOMSTR']    = Transform("SHLINK", 0)
6457816Ssteve.reinhardt@amd.com    main['RANLIBCOMSTR']    = Transform("RANLIB", 0)
6467816Ssteve.reinhardt@amd.com    main['M4COMSTR']        = Transform("M4")
6477816Ssteve.reinhardt@amd.com    main['SHCCCOMSTR']      = Transform("SHCC")
6487816Ssteve.reinhardt@amd.com    main['SHCXXCOMSTR']     = Transform("SHCXX")
6497756SAli.Saidi@ARM.comExport('MakeAction')
6507756SAli.Saidi@ARM.com
6519227Sandreas.hansson@arm.com# Initialize the Link-Time Optimization (LTO) flags
6529227Sandreas.hansson@arm.commain['LTO_CCFLAGS'] = []
6539227Sandreas.hansson@arm.commain['LTO_LDFLAGS'] = []
6549227Sandreas.hansson@arm.com
6559590Sandreas@sandberg.pp.se# According to the readme, tcmalloc works best if the compiler doesn't
6569590Sandreas@sandberg.pp.se# assume that we're using the builtin malloc and friends. These flags
6579590Sandreas@sandberg.pp.se# are compiler-specific, so we need to set them after we detect which
6589590Sandreas@sandberg.pp.se# compiler we're using.
6599590Sandreas@sandberg.pp.semain['TCMALLOC_CCFLAGS'] = []
6609590Sandreas@sandberg.pp.se
6616654Snate@binkert.orgCXX_version = readCommand([main['CXX'],'--version'], exception=False)
6626654Snate@binkert.orgCXX_V = readCommand([main['CXX'],'-V'], exception=False)
6635871Snate@binkert.org
6646121Snate@binkert.orgmain['GCC'] = CXX_version and CXX_version.find('g++') >= 0
6658946Sandreas.hansson@arm.commain['CLANG'] = CXX_version and CXX_version.find('clang') >= 0
6669419Sandreas.hansson@arm.comif main['GCC'] + main['CLANG'] > 1:
6673940Ssaidi@eecs.umich.edu    print 'Error: How can we have two at the same time?'
6683918Ssaidi@eecs.umich.edu    Exit(1)
6693918Ssaidi@eecs.umich.edu
6701858SN/A# Set up default C++ compiler flags
6719556Sandreas.hansson@arm.comif main['GCC'] or main['CLANG']:
6729556Sandreas.hansson@arm.com    # As gcc and clang share many flags, do the common parts here
6739556Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-pipe'])
6749556Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-fno-strict-aliasing'])
67511294Sandreas.hansson@arm.com    # Enable -Wall and -Wextra and then disable the few warnings that
67611294Sandreas.hansson@arm.com    # we consistently violate
67711294Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-Wall', '-Wundef', '-Wextra',
67811294Sandreas.hansson@arm.com                         '-Wno-sign-compare', '-Wno-unused-parameter'])
67910878Sandreas.hansson@arm.com    # We always compile using C++11
68010878Sandreas.hansson@arm.com    main.Append(CXXFLAGS=['-std=c++11'])
68111811Sbaz21@cam.ac.uk    if sys.platform.startswith('freebsd'):
68211811Sbaz21@cam.ac.uk        main.Append(CCFLAGS=['-I/usr/local/include'])
68311811Sbaz21@cam.ac.uk        main.Append(CXXFLAGS=['-I/usr/local/include'])
68411982Sgabeblack@google.com
68511982Sgabeblack@google.com    main['FILTER_PSHLINKFLAGS'] = lambda x: str(x).replace(' -shared', '')
68611982Sgabeblack@google.com    main['PSHLINKFLAGS'] = main.subst('${FILTER_PSHLINKFLAGS(SHLINKFLAGS)}')
68711982Sgabeblack@google.com    main['PLINKFLAGS'] = main.subst('${LINKFLAGS}')
68811992Sgabeblack@google.com    shared_partial_flags = ['-r', '-nostdlib']
68911982Sgabeblack@google.com    main.Append(PSHLINKFLAGS=shared_partial_flags)
69011982Sgabeblack@google.com    main.Append(PLINKFLAGS=shared_partial_flags)
6919556Sandreas.hansson@arm.comelse:
6929556Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal,
6939556Sandreas.hansson@arm.com    print "Don't know what compiler options to use for your compiler."
6949556Sandreas.hansson@arm.com    print termcap.Yellow + '       compiler:' + termcap.Normal, main['CXX']
6959556Sandreas.hansson@arm.com    print termcap.Yellow + '       version:' + termcap.Normal,
6969556Sandreas.hansson@arm.com    if not CXX_version:
6979556Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\
6989556Sandreas.hansson@arm.com               termcap.Normal
6999556Sandreas.hansson@arm.com    else:
7009556Sandreas.hansson@arm.com        print CXX_version.replace('\n', '<nl>')
7019556Sandreas.hansson@arm.com    print "       If you're trying to use a compiler other than GCC"
7029556Sandreas.hansson@arm.com    print "       or clang, there appears to be something wrong with your"
7039556Sandreas.hansson@arm.com    print "       environment."
7049556Sandreas.hansson@arm.com    print "       "
7059556Sandreas.hansson@arm.com    print "       If you are trying to use a compiler other than those listed"
7069556Sandreas.hansson@arm.com    print "       above you will need to ease fix SConstruct and "
7079556Sandreas.hansson@arm.com    print "       src/SConscript to support that compiler."
7089556Sandreas.hansson@arm.com    Exit(1)
7099556Sandreas.hansson@arm.com
7106121Snate@binkert.orgif main['GCC']:
71111500Sandreas.hansson@arm.com    # Check for a supported version of gcc. >= 4.8 is chosen for its
71210238Sandreas.hansson@arm.com    # level of c++11 support. See
71310878Sandreas.hansson@arm.com    # http://gcc.gnu.org/projects/cxx0x.html for details.
7149420Sandreas.hansson@arm.com    gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False)
71511500Sandreas.hansson@arm.com    if compareVersions(gcc_version, "4.8") < 0:
71611500Sandreas.hansson@arm.com        print 'Error: gcc version 4.8 or newer required.'
7179420Sandreas.hansson@arm.com        print '       Installed version:', gcc_version
7189420Sandreas.hansson@arm.com        Exit(1)
7199420Sandreas.hansson@arm.com
7209420Sandreas.hansson@arm.com    main['GCC_VERSION'] = gcc_version
7219420Sandreas.hansson@arm.com
72210264Sandreas.hansson@arm.com    # gcc from version 4.8 and above generates "rep; ret" instructions
72310264Sandreas.hansson@arm.com    # to avoid performance penalties on certain AMD chips. Older
72410264Sandreas.hansson@arm.com    # assemblers detect this as an error, "Error: expecting string
72510264Sandreas.hansson@arm.com    # instruction after `rep'"
72611925Sgabeblack@google.com    as_version_raw = readCommand([main['AS'], '-v', '/dev/null',
72711925Sgabeblack@google.com                                  '-o', '/dev/null'],
72811500Sandreas.hansson@arm.com                                 exception=False).split()
72910264Sandreas.hansson@arm.com
73011500Sandreas.hansson@arm.com    # version strings may contain extra distro-specific
73111500Sandreas.hansson@arm.com    # qualifiers, so play it safe and keep only what comes before
73211500Sandreas.hansson@arm.com    # the first hyphen
73311500Sandreas.hansson@arm.com    as_version = as_version_raw[-1].split('-')[0] if as_version_raw else None
73410866Sandreas.hansson@arm.com
73511500Sandreas.hansson@arm.com    if not as_version or compareVersions(as_version, "2.23") < 0:
73611500Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + \
73711500Sandreas.hansson@arm.com            'Warning: This combination of gcc and binutils have' + \
73811500Sandreas.hansson@arm.com            ' known incompatibilities.\n' + \
73911500Sandreas.hansson@arm.com            '         If you encounter build problems, please update ' + \
74011500Sandreas.hansson@arm.com            'binutils to 2.23.' + \
74111500Sandreas.hansson@arm.com            termcap.Normal
74210264Sandreas.hansson@arm.com
74310457Sandreas.hansson@arm.com    # Make sure we warn if the user has requested to compile with the
74410457Sandreas.hansson@arm.com    # Undefined Benahvior Sanitizer and this version of gcc does not
74510457Sandreas.hansson@arm.com    # support it.
74610457Sandreas.hansson@arm.com    if GetOption('with_ubsan') and \
74710457Sandreas.hansson@arm.com            compareVersions(gcc_version, '4.9') < 0:
74810457Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + \
74910457Sandreas.hansson@arm.com            'Warning: UBSan is only supported using gcc 4.9 and later.' + \
75010457Sandreas.hansson@arm.com            termcap.Normal
75110457Sandreas.hansson@arm.com
75210238Sandreas.hansson@arm.com    # Add the appropriate Link-Time Optimization (LTO) flags
75310238Sandreas.hansson@arm.com    # unless LTO is explicitly turned off. Note that these flags
75410238Sandreas.hansson@arm.com    # are only used by the fast target.
75510238Sandreas.hansson@arm.com    if not GetOption('no_lto'):
75610238Sandreas.hansson@arm.com        # Pass the LTO flag when compiling to produce GIMPLE
75710238Sandreas.hansson@arm.com        # output, we merely create the flags here and only append
75810416Sandreas.hansson@arm.com        # them later
75910238Sandreas.hansson@arm.com        main['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
7609227Sandreas.hansson@arm.com
76110238Sandreas.hansson@arm.com        # Use the same amount of jobs for LTO as we are running
76210416Sandreas.hansson@arm.com        # scons with
76310416Sandreas.hansson@arm.com        main['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
7649227Sandreas.hansson@arm.com
7659590Sandreas@sandberg.pp.se    main.Append(TCMALLOC_CCFLAGS=['-fno-builtin-malloc', '-fno-builtin-calloc',
7669590Sandreas@sandberg.pp.se                                  '-fno-builtin-realloc', '-fno-builtin-free'])
7679590Sandreas@sandberg.pp.se
76811497SMatteo.Andreozzi@arm.com    # add option to check for undeclared overrides
76911497SMatteo.Andreozzi@arm.com    if compareVersions(gcc_version, "5.0") > 0:
77011497SMatteo.Andreozzi@arm.com        main.Append(CCFLAGS=['-Wno-error=suggest-override'])
77111497SMatteo.Andreozzi@arm.com
7728737Skoansin.tan@gmail.comelif main['CLANG']:
77310878Sandreas.hansson@arm.com    # Check for a supported version of clang, >= 3.1 is needed to
77411500Sandreas.hansson@arm.com    # support similar features as gcc 4.8. See
7759420Sandreas.hansson@arm.com    # http://clang.llvm.org/cxx_status.html for details
7768737Skoansin.tan@gmail.com    clang_version_re = re.compile(".* version (\d+\.\d+)")
77710106SMitch.Hayenga@arm.com    clang_version_match = clang_version_re.search(CXX_version)
7788737Skoansin.tan@gmail.com    if (clang_version_match):
7798737Skoansin.tan@gmail.com        clang_version = clang_version_match.groups()[0]
78010878Sandreas.hansson@arm.com        if compareVersions(clang_version, "3.1") < 0:
78110878Sandreas.hansson@arm.com            print 'Error: clang version 3.1 or newer required.'
7828737Skoansin.tan@gmail.com            print '       Installed version:', clang_version
7838737Skoansin.tan@gmail.com            Exit(1)
7848737Skoansin.tan@gmail.com    else:
7858737Skoansin.tan@gmail.com        print 'Error: Unable to determine clang version.'
7868737Skoansin.tan@gmail.com        Exit(1)
7878737Skoansin.tan@gmail.com
78811294Sandreas.hansson@arm.com    # clang has a few additional warnings that we disable, extraneous
7899556Sandreas.hansson@arm.com    # parantheses are allowed due to Ruby's printing of the AST,
7909556Sandreas.hansson@arm.com    # finally self assignments are allowed as the generated CPU code
7919556Sandreas.hansson@arm.com    # is relying on this
79211294Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-Wno-parentheses',
79310278SAndreas.Sandberg@ARM.com                         '-Wno-self-assign',
79410278SAndreas.Sandberg@ARM.com                         # Some versions of libstdc++ (4.8?) seem to
79510278SAndreas.Sandberg@ARM.com                         # use struct hash and class hash
79610278SAndreas.Sandberg@ARM.com                         # interchangeably.
79710278SAndreas.Sandberg@ARM.com                         '-Wno-mismatched-tags',
79810278SAndreas.Sandberg@ARM.com                         ])
7999556Sandreas.hansson@arm.com
8009590Sandreas@sandberg.pp.se    main.Append(TCMALLOC_CCFLAGS=['-fno-builtin'])
8019590Sandreas@sandberg.pp.se
8029420Sandreas.hansson@arm.com    # On Mac OS X/Darwin we need to also use libc++ (part of XCode) as
8039846Sandreas.hansson@arm.com    # opposed to libstdc++, as the later is dated.
8049846Sandreas.hansson@arm.com    if sys.platform == "darwin":
8059846Sandreas.hansson@arm.com        main.Append(CXXFLAGS=['-stdlib=libc++'])
8069846Sandreas.hansson@arm.com        main.Append(LIBS=['c++'])
8078946Sandreas.hansson@arm.com
80811811Sbaz21@cam.ac.uk    # On FreeBSD we need libthr.
80911811Sbaz21@cam.ac.uk    if sys.platform.startswith('freebsd'):
81011811Sbaz21@cam.ac.uk        main.Append(LIBS=['thr'])
81111811Sbaz21@cam.ac.uk
8123918Ssaidi@eecs.umich.eduelse:
8139068SAli.Saidi@ARM.com    print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal,
8149068SAli.Saidi@ARM.com    print "Don't know what compiler options to use for your compiler."
8159068SAli.Saidi@ARM.com    print termcap.Yellow + '       compiler:' + termcap.Normal, main['CXX']
8169068SAli.Saidi@ARM.com    print termcap.Yellow + '       version:' + termcap.Normal,
8179068SAli.Saidi@ARM.com    if not CXX_version:
8189068SAli.Saidi@ARM.com        print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\
8199068SAli.Saidi@ARM.com               termcap.Normal
8209068SAli.Saidi@ARM.com    else:
8219068SAli.Saidi@ARM.com        print CXX_version.replace('\n', '<nl>')
8229419Sandreas.hansson@arm.com    print "       If you're trying to use a compiler other than GCC"
8239068SAli.Saidi@ARM.com    print "       or clang, there appears to be something wrong with your"
8249068SAli.Saidi@ARM.com    print "       environment."
8259068SAli.Saidi@ARM.com    print "       "
8269068SAli.Saidi@ARM.com    print "       If you are trying to use a compiler other than those listed"
8279068SAli.Saidi@ARM.com    print "       above you will need to ease fix SConstruct and "
8289068SAli.Saidi@ARM.com    print "       src/SConscript to support that compiler."
8293918Ssaidi@eecs.umich.edu    Exit(1)
8303918Ssaidi@eecs.umich.edu
8316157Snate@binkert.org# Set up common yacc/bison flags (needed for Ruby)
8326157Snate@binkert.orgmain['YACCFLAGS'] = '-d'
8336157Snate@binkert.orgmain['YACCHXXFILESUFFIX'] = '.hh'
8346157Snate@binkert.org
8355397Ssaidi@eecs.umich.edu# Do this after we save setting back, or else we'll tack on an
8365397Ssaidi@eecs.umich.edu# extra 'qdo' every time we run scons.
8376121Snate@binkert.orgif main['BATCH']:
8386121Snate@binkert.org    main['CC']     = main['BATCH_CMD'] + ' ' + main['CC']
8396121Snate@binkert.org    main['CXX']    = main['BATCH_CMD'] + ' ' + main['CXX']
8406121Snate@binkert.org    main['AS']     = main['BATCH_CMD'] + ' ' + main['AS']
8416121Snate@binkert.org    main['AR']     = main['BATCH_CMD'] + ' ' + main['AR']
8426121Snate@binkert.org    main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB']
8435397Ssaidi@eecs.umich.edu
8441851SN/Aif sys.platform == 'cygwin':
8451851SN/A    # cygwin has some header file issues...
8467739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=["-Wno-uninitialized"])
847955SN/A
8489396Sandreas.hansson@arm.com# Check for the protobuf compiler
8499396Sandreas.hansson@arm.comprotoc_version = readCommand([main['PROTOC'], '--version'],
8509396Sandreas.hansson@arm.com                             exception='').split()
8519396Sandreas.hansson@arm.com
8529396Sandreas.hansson@arm.com# First two words should be "libprotoc x.y.z"
8539396Sandreas.hansson@arm.comif len(protoc_version) < 2 or protoc_version[0] != 'libprotoc':
8549396Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + \
8559396Sandreas.hansson@arm.com        'Warning: Protocol buffer compiler (protoc) not found.\n' + \
8569396Sandreas.hansson@arm.com        '         Please install protobuf-compiler for tracing support.' + \
8579396Sandreas.hansson@arm.com        termcap.Normal
8589396Sandreas.hansson@arm.com    main['PROTOC'] = False
8599396Sandreas.hansson@arm.comelse:
8609396Sandreas.hansson@arm.com    # Based on the availability of the compress stream wrappers,
8619396Sandreas.hansson@arm.com    # require 2.1.0
8629396Sandreas.hansson@arm.com    min_protoc_version = '2.1.0'
8639396Sandreas.hansson@arm.com    if compareVersions(protoc_version[1], min_protoc_version) < 0:
8649477Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + \
8659477Sandreas.hansson@arm.com            'Warning: protoc version', min_protoc_version, \
8669477Sandreas.hansson@arm.com            'or newer required.\n' + \
8679477Sandreas.hansson@arm.com            '         Installed version:', protoc_version[1], \
8689477Sandreas.hansson@arm.com            termcap.Normal
8699477Sandreas.hansson@arm.com        main['PROTOC'] = False
8709477Sandreas.hansson@arm.com    else:
8719477Sandreas.hansson@arm.com        # Attempt to determine the appropriate include path and
8729477Sandreas.hansson@arm.com        # library path using pkg-config, that means we also need to
8739477Sandreas.hansson@arm.com        # check for pkg-config. Note that it is possible to use
8749477Sandreas.hansson@arm.com        # protobuf without the involvement of pkg-config. Later on we
8759477Sandreas.hansson@arm.com        # check go a library config check and at that point the test
8769477Sandreas.hansson@arm.com        # will fail if libprotobuf cannot be found.
8779477Sandreas.hansson@arm.com        if readCommand(['pkg-config', '--version'], exception=''):
8789477Sandreas.hansson@arm.com            try:
8799477Sandreas.hansson@arm.com                # Attempt to establish what linking flags to add for protobuf
8809477Sandreas.hansson@arm.com                # using pkg-config
8819477Sandreas.hansson@arm.com                main.ParseConfig('pkg-config --cflags --libs-only-L protobuf')
8829477Sandreas.hansson@arm.com            except:
8839477Sandreas.hansson@arm.com                print termcap.Yellow + termcap.Bold + \
8849477Sandreas.hansson@arm.com                    'Warning: pkg-config could not get protobuf flags.' + \
8859477Sandreas.hansson@arm.com                    termcap.Normal
8869396Sandreas.hansson@arm.com
8872667Sstever@eecs.umich.edu
88810710Sandreas.hansson@arm.com# Check for 'timeout' from GNU coreutils. If present, regressions will
88910710Sandreas.hansson@arm.com# be run with a time limit. We require version 8.13 since we rely on
89010710Sandreas.hansson@arm.com# support for the '--foreground' option.
89111811Sbaz21@cam.ac.ukif sys.platform.startswith('freebsd'):
89211811Sbaz21@cam.ac.uk    timeout_lines = readCommand(['gtimeout', '--version'],
89311811Sbaz21@cam.ac.uk                                exception='').splitlines()
89411811Sbaz21@cam.ac.ukelse:
89511811Sbaz21@cam.ac.uk    timeout_lines = readCommand(['timeout', '--version'],
89611811Sbaz21@cam.ac.uk                                exception='').splitlines()
89710710Sandreas.hansson@arm.com# Get the first line and tokenize it
89810710Sandreas.hansson@arm.comtimeout_version = timeout_lines[0].split() if timeout_lines else []
89910710Sandreas.hansson@arm.commain['TIMEOUT'] =  timeout_version and \
90010710Sandreas.hansson@arm.com    compareVersions(timeout_version[-1], '8.13') >= 0
90110384SCurtis.Dunham@arm.com
9029986Sandreas@sandberg.pp.se# Add a custom Check function to test for structure members.
9039986Sandreas@sandberg.pp.sedef CheckMember(context, include, decl, member, include_quotes="<>"):
9049986Sandreas@sandberg.pp.se    context.Message("Checking for member %s in %s..." %
9059986Sandreas@sandberg.pp.se                    (member, decl))
9069986Sandreas@sandberg.pp.se    text = """
9079986Sandreas@sandberg.pp.se#include %(header)s
9089986Sandreas@sandberg.pp.seint main(){
9099986Sandreas@sandberg.pp.se  %(decl)s test;
9109986Sandreas@sandberg.pp.se  (void)test.%(member)s;
9119986Sandreas@sandberg.pp.se  return 0;
9129986Sandreas@sandberg.pp.se};
9139986Sandreas@sandberg.pp.se""" % { "header" : include_quotes[0] + include + include_quotes[1],
9149986Sandreas@sandberg.pp.se        "decl" : decl,
9159986Sandreas@sandberg.pp.se        "member" : member,
9169986Sandreas@sandberg.pp.se        }
9179986Sandreas@sandberg.pp.se
9189986Sandreas@sandberg.pp.se    ret = context.TryCompile(text, extension=".cc")
9199986Sandreas@sandberg.pp.se    context.Result(ret)
9209986Sandreas@sandberg.pp.se    return ret
9219986Sandreas@sandberg.pp.se
9222638Sstever@eecs.umich.edu# Platform-specific configuration.  Note again that we assume that all
9232638Sstever@eecs.umich.edu# builds under a given build root run on the same host platform.
9246121Snate@binkert.orgconf = Configure(main,
9253716Sstever@eecs.umich.edu                 conf_dir = joinpath(build_root, '.scons_config'),
9265522Snate@binkert.org                 log_file = joinpath(build_root, 'scons_config.log'),
9279986Sandreas@sandberg.pp.se                 custom_tests = {
9289986Sandreas@sandberg.pp.se        'CheckMember' : CheckMember,
9299986Sandreas@sandberg.pp.se        })
9305522Snate@binkert.org
9315227Ssaidi@eecs.umich.edu# Check if we should compile a 64 bit binary on Mac OS X/Darwin
9325227Ssaidi@eecs.umich.edutry:
9335227Ssaidi@eecs.umich.edu    import platform
9345227Ssaidi@eecs.umich.edu    uname = platform.uname()
9356654Snate@binkert.org    if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0:
9366654Snate@binkert.org        if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
9377769SAli.Saidi@ARM.com            main.Append(CCFLAGS=['-arch', 'x86_64'])
9387769SAli.Saidi@ARM.com            main.Append(CFLAGS=['-arch', 'x86_64'])
9397769SAli.Saidi@ARM.com            main.Append(LINKFLAGS=['-arch', 'x86_64'])
9407769SAli.Saidi@ARM.com            main.Append(ASFLAGS=['-arch', 'x86_64'])
9415227Ssaidi@eecs.umich.eduexcept:
9425227Ssaidi@eecs.umich.edu    pass
9435227Ssaidi@eecs.umich.edu
9445204Sstever@gmail.com# Recent versions of scons substitute a "Null" object for Configure()
9455204Sstever@gmail.com# when configuration isn't necessary, e.g., if the "--help" option is
9465204Sstever@gmail.com# present.  Unfortuantely this Null object always returns false,
9475204Sstever@gmail.com# breaking all our configuration checks.  We replace it with our own
9485204Sstever@gmail.com# more optimistic null object that returns True instead.
9495204Sstever@gmail.comif not conf:
9505204Sstever@gmail.com    def NullCheck(*args, **kwargs):
9515204Sstever@gmail.com        return True
9525204Sstever@gmail.com
9535204Sstever@gmail.com    class NullConf:
9545204Sstever@gmail.com        def __init__(self, env):
9555204Sstever@gmail.com            self.env = env
9565204Sstever@gmail.com        def Finish(self):
9575204Sstever@gmail.com            return self.env
9585204Sstever@gmail.com        def __getattr__(self, mname):
9595204Sstever@gmail.com            return NullCheck
9605204Sstever@gmail.com
9616121Snate@binkert.org    conf = NullConf(main)
9625204Sstever@gmail.com
9637727SAli.Saidi@ARM.com# Cache build files in the supplied directory.
9647727SAli.Saidi@ARM.comif main['M5_BUILD_CACHE']:
9657727SAli.Saidi@ARM.com    print 'Using build cache located at', main['M5_BUILD_CACHE']
9667727SAli.Saidi@ARM.com    CacheDir(main['M5_BUILD_CACHE'])
9677727SAli.Saidi@ARM.com
96811988Sandreas.sandberg@arm.commain['USE_PYTHON'] = not GetOption('without_python')
96911988Sandreas.sandberg@arm.comif main['USE_PYTHON']:
97010453SAndrew.Bardsley@arm.com    # Find Python include and library directories for embedding the
97110453SAndrew.Bardsley@arm.com    # interpreter. We rely on python-config to resolve the appropriate
97210453SAndrew.Bardsley@arm.com    # includes and linker flags. ParseConfig does not seem to understand
97310453SAndrew.Bardsley@arm.com    # the more exotic linker flags such as -Xlinker and -export-dynamic so
97410453SAndrew.Bardsley@arm.com    # we add them explicitly below. If you want to link in an alternate
97510453SAndrew.Bardsley@arm.com    # version of python, see above for instructions on how to invoke
97610453SAndrew.Bardsley@arm.com    # scons with the appropriate PATH set.
97710453SAndrew.Bardsley@arm.com    #
97810453SAndrew.Bardsley@arm.com    # First we check if python2-config exists, else we use python-config
97910453SAndrew.Bardsley@arm.com    python_config = readCommand(['which', 'python2-config'],
98010160Sandreas.hansson@arm.com                                exception='').strip()
98110453SAndrew.Bardsley@arm.com    if not os.path.exists(python_config):
98210453SAndrew.Bardsley@arm.com        python_config = readCommand(['which', 'python-config'],
98310453SAndrew.Bardsley@arm.com                                    exception='').strip()
98410453SAndrew.Bardsley@arm.com    py_includes = readCommand([python_config, '--includes'],
98510453SAndrew.Bardsley@arm.com                              exception='').split()
98610453SAndrew.Bardsley@arm.com    # Strip the -I from the include folders before adding them to the
98710453SAndrew.Bardsley@arm.com    # CPPPATH
98810453SAndrew.Bardsley@arm.com    main.Append(CPPPATH=map(lambda inc: inc[2:], py_includes))
9899812Sandreas.hansson@arm.com
99010453SAndrew.Bardsley@arm.com    # Read the linker flags and split them into libraries and other link
99110453SAndrew.Bardsley@arm.com    # flags. The libraries are added later through the call the CheckLib.
99210453SAndrew.Bardsley@arm.com    py_ld_flags = readCommand([python_config, '--ldflags'],
99310453SAndrew.Bardsley@arm.com        exception='').split()
99410453SAndrew.Bardsley@arm.com    py_libs = []
99510453SAndrew.Bardsley@arm.com    for lib in py_ld_flags:
99610453SAndrew.Bardsley@arm.com         if not lib.startswith('-l'):
99710453SAndrew.Bardsley@arm.com             main.Append(LINKFLAGS=[lib])
99810453SAndrew.Bardsley@arm.com         else:
99910453SAndrew.Bardsley@arm.com             lib = lib[2:]
100010453SAndrew.Bardsley@arm.com             if lib not in py_libs:
100110453SAndrew.Bardsley@arm.com                 py_libs.append(lib)
10027727SAli.Saidi@ARM.com
100310453SAndrew.Bardsley@arm.com    # verify that this stuff works
100410453SAndrew.Bardsley@arm.com    if not conf.CheckHeader('Python.h', '<>'):
100510453SAndrew.Bardsley@arm.com        print "Error: can't find Python.h header in", py_includes
100610453SAndrew.Bardsley@arm.com        print "Install Python headers (package python-dev on Ubuntu and RedHat)"
100710453SAndrew.Bardsley@arm.com        Exit(1)
10083118Sstever@eecs.umich.edu
100910453SAndrew.Bardsley@arm.com    for lib in py_libs:
101010453SAndrew.Bardsley@arm.com        if not conf.CheckLib(lib):
101110453SAndrew.Bardsley@arm.com            print "Error: can't find library %s required by python" % lib
101210453SAndrew.Bardsley@arm.com            Exit(1)
10133118Sstever@eecs.umich.edu
10143483Ssaidi@eecs.umich.edu# On Solaris you need to use libsocket for socket ops
10153494Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
10163494Ssaidi@eecs.umich.edu   if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
10173483Ssaidi@eecs.umich.edu       print "Can't find library with socket calls (e.g. accept())"
10183483Ssaidi@eecs.umich.edu       Exit(1)
10193483Ssaidi@eecs.umich.edu
10203053Sstever@eecs.umich.edu# Check for zlib.  If the check passes, libz will be automatically
10213053Sstever@eecs.umich.edu# added to the LIBS environment variable.
10223918Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
10233053Sstever@eecs.umich.edu    print 'Error: did not find needed zlib compression library '\
10243053Sstever@eecs.umich.edu          'and/or zlib.h header file.'
10253053Sstever@eecs.umich.edu    print '       Please install zlib and try again.'
10263053Sstever@eecs.umich.edu    Exit(1)
10273053Sstever@eecs.umich.edu
10289396Sandreas.hansson@arm.com# If we have the protobuf compiler, also make sure we have the
10299396Sandreas.hansson@arm.com# development libraries. If the check passes, libprotobuf will be
10309396Sandreas.hansson@arm.com# automatically added to the LIBS environment variable. After
10319396Sandreas.hansson@arm.com# this, we can use the HAVE_PROTOBUF flag to determine if we have
10329396Sandreas.hansson@arm.com# got both protoc and libprotobuf available.
10339396Sandreas.hansson@arm.commain['HAVE_PROTOBUF'] = main['PROTOC'] and \
10349396Sandreas.hansson@arm.com    conf.CheckLibWithHeader('protobuf', 'google/protobuf/message.h',
10359396Sandreas.hansson@arm.com                            'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;')
10369396Sandreas.hansson@arm.com
10379477Sandreas.hansson@arm.com# If we have the compiler but not the library, print another warning.
10389396Sandreas.hansson@arm.comif main['PROTOC'] and not main['HAVE_PROTOBUF']:
10399477Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + \
10409477Sandreas.hansson@arm.com        'Warning: did not find protocol buffer library and/or headers.\n' + \
10419477Sandreas.hansson@arm.com    '       Please install libprotobuf-dev for tracing support.' + \
10429477Sandreas.hansson@arm.com    termcap.Normal
10439396Sandreas.hansson@arm.com
10447840Snate@binkert.org# Check for librt.
10457865Sgblack@eecs.umich.eduhave_posix_clock = \
10467865Sgblack@eecs.umich.edu    conf.CheckLibWithHeader(None, 'time.h', 'C',
10477865Sgblack@eecs.umich.edu                            'clock_nanosleep(0,0,NULL,NULL);') or \
10487865Sgblack@eecs.umich.edu    conf.CheckLibWithHeader('rt', 'time.h', 'C',
10497865Sgblack@eecs.umich.edu                            'clock_nanosleep(0,0,NULL,NULL);')
10507840Snate@binkert.org
10519900Sandreas@sandberg.pp.sehave_posix_timers = \
10529900Sandreas@sandberg.pp.se    conf.CheckLibWithHeader([None, 'rt'], [ 'time.h', 'signal.h' ], 'C',
10539900Sandreas@sandberg.pp.se                            'timer_create(CLOCK_MONOTONIC, NULL, NULL);')
10549900Sandreas@sandberg.pp.se
105510456SCurtis.Dunham@arm.comif not GetOption('without_tcmalloc'):
105610456SCurtis.Dunham@arm.com    if conf.CheckLib('tcmalloc'):
105710456SCurtis.Dunham@arm.com        main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS'])
105810456SCurtis.Dunham@arm.com    elif conf.CheckLib('tcmalloc_minimal'):
105910456SCurtis.Dunham@arm.com        main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS'])
106010456SCurtis.Dunham@arm.com    else:
106110456SCurtis.Dunham@arm.com        print termcap.Yellow + termcap.Bold + \
106210456SCurtis.Dunham@arm.com              "You can get a 12% performance improvement by "\
106310456SCurtis.Dunham@arm.com              "installing tcmalloc (libgoogle-perftools-dev package "\
106410456SCurtis.Dunham@arm.com              "on Ubuntu or RedHat)." + termcap.Normal
10659045SAli.Saidi@ARM.com
106611235Sandreas.sandberg@arm.com
106711235Sandreas.sandberg@arm.com# Detect back trace implementations. The last implementation in the
106811235Sandreas.sandberg@arm.com# list will be used by default.
106911235Sandreas.sandberg@arm.combacktrace_impls = [ "none" ]
107011235Sandreas.sandberg@arm.com
107111235Sandreas.sandberg@arm.comif conf.CheckLibWithHeader(None, 'execinfo.h', 'C',
107211235Sandreas.sandberg@arm.com                           'backtrace_symbols_fd((void*)0, 0, 0);'):
107311235Sandreas.sandberg@arm.com    backtrace_impls.append("glibc")
107411811Sbaz21@cam.ac.ukelif conf.CheckLibWithHeader('execinfo', 'execinfo.h', 'C',
107511811Sbaz21@cam.ac.uk                           'backtrace_symbols_fd((void*)0, 0, 0);'):
107611811Sbaz21@cam.ac.uk    # NetBSD and FreeBSD need libexecinfo.
107711811Sbaz21@cam.ac.uk    backtrace_impls.append("glibc")
107811811Sbaz21@cam.ac.uk    main.Append(LIBS=['execinfo'])
107911235Sandreas.sandberg@arm.com
108011235Sandreas.sandberg@arm.comif backtrace_impls[-1] == "none":
108111235Sandreas.sandberg@arm.com    default_backtrace_impl = "none"
108211235Sandreas.sandberg@arm.com    print termcap.Yellow + termcap.Bold + \
108311235Sandreas.sandberg@arm.com        "No suitable back trace implementation found." + \
108411235Sandreas.sandberg@arm.com        termcap.Normal
108511235Sandreas.sandberg@arm.com
10867840Snate@binkert.orgif not have_posix_clock:
10877840Snate@binkert.org    print "Can't find library for POSIX clocks."
10887840Snate@binkert.org
10891858SN/A# Check for <fenv.h> (C99 FP environment control)
10901858SN/Ahave_fenv = conf.CheckHeader('fenv.h', '<>')
10911858SN/Aif not have_fenv:
10921858SN/A    print "Warning: Header file <fenv.h> not found."
10931858SN/A    print "         This host has no IEEE FP rounding mode control."
10941858SN/A
10959903Sandreas.hansson@arm.com# Check if we should enable KVM-based hardware virtualization. The API
10969903Sandreas.hansson@arm.com# we rely on exists since version 2.6.36 of the kernel, but somehow
10979903Sandreas.hansson@arm.com# the KVM_API_VERSION does not reflect the change. We test for one of
10989903Sandreas.hansson@arm.com# the types as a fall back.
109910841Sandreas.sandberg@arm.comhave_kvm = conf.CheckHeader('linux/kvm.h', '<>')
11009651SAndreas.Sandberg@ARM.comif not have_kvm:
11019903Sandreas.hansson@arm.com    print "Info: Compatible header file <linux/kvm.h> not found, " \
11029651SAndreas.Sandberg@ARM.com        "disabling KVM support."
11039651SAndreas.Sandberg@ARM.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),
12345952Ssaidi@eecs.umich.edu    BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False),
12359651SAndreas.Sandberg@ARM.com    BoolVariable('USE_KVM', 'Enable hardware virtualized (KVM) CPU models', have_kvm),
123611308Santhony.gutierrez@amd.com    BoolVariable('BUILD_GPU', 'Build the compute-GPU model', False),
12379219Spower.jg@gmail.com    EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None',
12389219Spower.jg@gmail.com                  all_protocols),
123911235Sandreas.sandberg@arm.com    EnumVariable('BACKTRACE_IMPL', 'Post-mortem dump implementation',
124011235Sandreas.sandberg@arm.com                 backtrace_impls[-1], backtrace_impls)
12411869SN/A    )
12421858SN/A
12435863Snate@binkert.org# These variables get exported to #defines in config/*.hh (see src/SConscript).
124411308Santhony.gutierrez@amd.comexport_vars += ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'TARGET_GPU_ISA',
124511308Santhony.gutierrez@amd.com                'CP_ANNOTATE', 'USE_POSIX_CLOCK', 'USE_KVM', 'PROTOCOL',
124611308Santhony.gutierrez@amd.com                'HAVE_PROTOBUF', 'HAVE_PERF_ATTR_EXCLUDE_HOST']
12471858SN/A
1248955SN/A###################################################
1249955SN/A#
12501869SN/A# Define a SCons builder for configuration flag headers.
12511869SN/A#
12521869SN/A###################################################
12531869SN/A
12541869SN/A# This function generates a config header file that #defines the
12555863Snate@binkert.org# variable symbol to the current variable setting (0 or 1).  The source
12565863Snate@binkert.org# operands are the name of the variable and a Value node containing the
12575863Snate@binkert.org# value of the variable.
12581869SN/Adef build_config_file(target, source, env):
12595863Snate@binkert.org    (variable, value) = [s.get_contents() for s in source]
12601869SN/A    f = file(str(target[0]), 'w')
12615863Snate@binkert.org    print >> f, '#define', variable, value
12621869SN/A    f.close()
12631869SN/A    return None
12641869SN/A
12651869SN/A# Combine the two functions into a scons Action object.
12668483Sgblack@eecs.umich.educonfig_action = MakeAction(build_config_file, Transform("CONFIG H", 2))
12671869SN/A
12681869SN/A# The emitter munges the source & target node lists to reflect what
12691869SN/A# we're really doing.
12701869SN/Adef config_emitter(target, source, env):
12715863Snate@binkert.org    # extract variable name from Builder arg
12725863Snate@binkert.org    variable = str(target[0])
12731869SN/A    # True target is config header file
12745863Snate@binkert.org    target = joinpath('config', variable.lower() + '.hh')
12755863Snate@binkert.org    val = env[variable]
12763356Sbinkertn@umich.edu    if isinstance(val, bool):
12773356Sbinkertn@umich.edu        # Force value to 0/1
12783356Sbinkertn@umich.edu        val = int(val)
12793356Sbinkertn@umich.edu    elif isinstance(val, str):
12803356Sbinkertn@umich.edu        val = '"' + val + '"'
12814781Snate@binkert.org
12825863Snate@binkert.org    # Sources are variable name & value (packaged in SCons Value nodes)
12835863Snate@binkert.org    return ([target], [Value(variable), Value(val)])
12841869SN/A
12851869SN/Aconfig_builder = Builder(emitter = config_emitter, action = config_action)
12861869SN/A
12876121Snate@binkert.orgmain.Append(BUILDERS = { 'ConfigFile' : config_builder })
12881869SN/A
128911982Sgabeblack@google.com###################################################
129011982Sgabeblack@google.com#
129111982Sgabeblack@google.com# Builders for static and shared partially linked object files.
129211982Sgabeblack@google.com#
129311982Sgabeblack@google.com###################################################
129411982Sgabeblack@google.com
129511982Sgabeblack@google.compartial_static_builder = Builder(action=SCons.Defaults.LinkAction,
129611982Sgabeblack@google.com                                 src_suffix='$OBJSUFFIX',
129711982Sgabeblack@google.com                                 src_builder=['StaticObject', 'Object'],
129811982Sgabeblack@google.com                                 LINKFLAGS='$PLINKFLAGS',
129911982Sgabeblack@google.com                                 LIBS='')
130011982Sgabeblack@google.com
130111982Sgabeblack@google.comdef partial_shared_emitter(target, source, env):
130211982Sgabeblack@google.com    for tgt in target:
130311982Sgabeblack@google.com        tgt.attributes.shared = 1
130411982Sgabeblack@google.com    return (target, source)
130511982Sgabeblack@google.compartial_shared_builder = Builder(action=SCons.Defaults.ShLinkAction,
130611982Sgabeblack@google.com                                 emitter=partial_shared_emitter,
130711982Sgabeblack@google.com                                 src_suffix='$SHOBJSUFFIX',
130811982Sgabeblack@google.com                                 src_builder='SharedObject',
130911982Sgabeblack@google.com                                 SHLINKFLAGS='$PSHLINKFLAGS',
131011982Sgabeblack@google.com                                 LIBS='')
131111982Sgabeblack@google.com
131211982Sgabeblack@google.commain.Append(BUILDERS = { 'PartialShared' : partial_shared_builder,
131311982Sgabeblack@google.com                         'PartialStatic' : partial_static_builder })
131411982Sgabeblack@google.com
131511978Sgabeblack@google.com# builds in ext are shared across all configs in the build root.
131611978Sgabeblack@google.comext_dir = abspath(joinpath(str(main.root), 'ext'))
131711978Sgabeblack@google.comfor root, dirs, files in os.walk(ext_dir):
131811978Sgabeblack@google.com    if 'SConscript' in files:
131911978Sgabeblack@google.com        build_dir = os.path.relpath(root, ext_dir)
132011978Sgabeblack@google.com        main.SConscript(joinpath(root, 'SConscript'),
132111978Sgabeblack@google.com                        variant_dir=joinpath(build_root, build_dir))
132210915Sandreas.sandberg@arm.com
132311986Sandreas.sandberg@arm.commain.Prepend(CPPPATH=Dir('ext/pybind11/include/'))
132411986Sandreas.sandberg@arm.com
13251869SN/A###################################################
13261869SN/A#
13273546Sgblack@eecs.umich.edu# This function is used to set up a directory with switching headers
13283546Sgblack@eecs.umich.edu#
13293546Sgblack@eecs.umich.edu###################################################
13303546Sgblack@eecs.umich.edu
13316121Snate@binkert.orgmain['ALL_ISA_LIST'] = all_isa_list
133211308Santhony.gutierrez@amd.commain['ALL_GPU_ISA_LIST'] = all_gpu_isa_list
133310196SCurtis.Dunham@arm.comall_isa_deps = {}
13345863Snate@binkert.orgdef make_switching_dir(dname, switch_headers, env):
13353546Sgblack@eecs.umich.edu    # Generate the header.  target[0] is the full path of the output
13363546Sgblack@eecs.umich.edu    # header to generate.  'source' is a dummy variable, since we get the
13373546Sgblack@eecs.umich.edu    # list of ISAs from env['ALL_ISA_LIST'].
13383546Sgblack@eecs.umich.edu    def gen_switch_hdr(target, source, env):
13394781Snate@binkert.org        fname = str(target[0])
13406658Snate@binkert.org        isa = env['TARGET_ISA'].lower()
134110196SCurtis.Dunham@arm.com        try:
134210196SCurtis.Dunham@arm.com            f = open(fname, 'w')
134310196SCurtis.Dunham@arm.com            print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname))
134410196SCurtis.Dunham@arm.com            f.close()
134510196SCurtis.Dunham@arm.com        except IOError:
134610196SCurtis.Dunham@arm.com            print "Failed to create %s" % fname
134710196SCurtis.Dunham@arm.com            raise
13483546Sgblack@eecs.umich.edu
13493546Sgblack@eecs.umich.edu    # Build SCons Action object. 'varlist' specifies env vars that this
13503546Sgblack@eecs.umich.edu    # action depends on; when env['ALL_ISA_LIST'] changes these actions
13513546Sgblack@eecs.umich.edu    # should get re-executed.
13527756SAli.Saidi@ARM.com    switch_hdr_action = MakeAction(gen_switch_hdr,
13537816Ssteve.reinhardt@amd.com                          Transform("GENERATE"), varlist=['ALL_ISA_LIST'])
13543546Sgblack@eecs.umich.edu
13553546Sgblack@eecs.umich.edu    # Instantiate actions for each header
13563546Sgblack@eecs.umich.edu    for hdr in switch_headers:
13573546Sgblack@eecs.umich.edu        env.Command(hdr, [], switch_hdr_action)
135810196SCurtis.Dunham@arm.com
135910196SCurtis.Dunham@arm.com    isa_target = Dir('.').up().name.lower().replace('_', '-')
136010196SCurtis.Dunham@arm.com    all_isa_deps[isa_target] = None
136110196SCurtis.Dunham@arm.com
13624202Sbinkertn@umich.eduExport('make_switching_dir')
13633546Sgblack@eecs.umich.edu
136411308Santhony.gutierrez@amd.comdef make_gpu_switching_dir(dname, switch_headers, env):
136511308Santhony.gutierrez@amd.com    # Generate the header.  target[0] is the full path of the output
136611308Santhony.gutierrez@amd.com    # header to generate.  'source' is a dummy variable, since we get the
136711308Santhony.gutierrez@amd.com    # list of ISAs from env['ALL_ISA_LIST'].
136811308Santhony.gutierrez@amd.com    def gen_switch_hdr(target, source, env):
136911308Santhony.gutierrez@amd.com        fname = str(target[0])
137011308Santhony.gutierrez@amd.com
137111308Santhony.gutierrez@amd.com        isa = env['TARGET_GPU_ISA'].lower()
137211308Santhony.gutierrez@amd.com
137311308Santhony.gutierrez@amd.com        try:
137411308Santhony.gutierrez@amd.com            f = open(fname, 'w')
137511308Santhony.gutierrez@amd.com            print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname))
137611308Santhony.gutierrez@amd.com            f.close()
137711308Santhony.gutierrez@amd.com        except IOError:
137811308Santhony.gutierrez@amd.com            print "Failed to create %s" % fname
137911308Santhony.gutierrez@amd.com            raise
138011308Santhony.gutierrez@amd.com
138111308Santhony.gutierrez@amd.com    # Build SCons Action object. 'varlist' specifies env vars that this
138211308Santhony.gutierrez@amd.com    # action depends on; when env['ALL_ISA_LIST'] changes these actions
138311308Santhony.gutierrez@amd.com    # should get re-executed.
138411308Santhony.gutierrez@amd.com    switch_hdr_action = MakeAction(gen_switch_hdr,
138511308Santhony.gutierrez@amd.com                          Transform("GENERATE"), varlist=['ALL_ISA_GPU_LIST'])
138611308Santhony.gutierrez@amd.com
138711308Santhony.gutierrez@amd.com    # Instantiate actions for each header
138811308Santhony.gutierrez@amd.com    for hdr in switch_headers:
138911308Santhony.gutierrez@amd.com        env.Command(hdr, [], switch_hdr_action)
139011308Santhony.gutierrez@amd.com
139111308Santhony.gutierrez@amd.comExport('make_gpu_switching_dir')
139211308Santhony.gutierrez@amd.com
139310196SCurtis.Dunham@arm.com# all-isas -> all-deps -> all-environs -> all_targets
139410196SCurtis.Dunham@arm.commain.Alias('#all-isas', [])
139510196SCurtis.Dunham@arm.commain.Alias('#all-deps', '#all-isas')
139610196SCurtis.Dunham@arm.com
139710196SCurtis.Dunham@arm.com# Dummy target to ensure all environments are created before telling
139810196SCurtis.Dunham@arm.com# SCons what to actually make (the command line arguments).  We attach
139910196SCurtis.Dunham@arm.com# them to the dependence graph after the environments are complete.
140010196SCurtis.Dunham@arm.comORIG_BUILD_TARGETS = list(BUILD_TARGETS) # force a copy; gets closure to work.
140110196SCurtis.Dunham@arm.comdef environsComplete(target, source, env):
140210196SCurtis.Dunham@arm.com    for t in ORIG_BUILD_TARGETS:
140310196SCurtis.Dunham@arm.com        main.Depends('#all-targets', t)
140410196SCurtis.Dunham@arm.com
140510196SCurtis.Dunham@arm.com# Each build/* switching_dir attaches its *-environs target to #all-environs.
140610196SCurtis.Dunham@arm.commain.Append(BUILDERS = {'CompleteEnvirons' :
140710196SCurtis.Dunham@arm.com                        Builder(action=MakeAction(environsComplete, None))})
140810196SCurtis.Dunham@arm.commain.CompleteEnvirons('#all-environs', [])
140910196SCurtis.Dunham@arm.com
141010196SCurtis.Dunham@arm.comdef doNothing(**ignored): pass
141110196SCurtis.Dunham@arm.commain.Append(BUILDERS = {'Dummy': Builder(action=MakeAction(doNothing, None))})
141210196SCurtis.Dunham@arm.com
141310196SCurtis.Dunham@arm.com# The final target to which all the original targets ultimately get attached.
141410196SCurtis.Dunham@arm.commain.Dummy('#all-targets', '#all-environs')
141510196SCurtis.Dunham@arm.comBUILD_TARGETS[:] = ['#all-targets']
141610196SCurtis.Dunham@arm.com
14173546Sgblack@eecs.umich.edu###################################################
14183546Sgblack@eecs.umich.edu#
1419955SN/A# Define build environments for selected configurations.
1420955SN/A#
1421955SN/A###################################################
1422955SN/A
142311999Sgabeblack@google.comdef variant_name(path):
142411999Sgabeblack@google.com    return os.path.basename(path).lower().replace('_', '-')
142511999Sgabeblack@google.commain['variant_name'] = variant_name
142611999Sgabeblack@google.commain['VARIANT_NAME'] = '${variant_name(BUILDDIR)}'
142711999Sgabeblack@google.com
14285863Snate@binkert.orgfor variant_path in variant_paths:
142910135SCurtis.Dunham@arm.com    if not GetOption('silent'):
143010135SCurtis.Dunham@arm.com        print "Building in", variant_path
14315343Sstever@gmail.com
14325343Sstever@gmail.com    # Make a copy of the build-root environment to use for this config.
14336121Snate@binkert.org    env = main.Clone()
14345863Snate@binkert.org    env['BUILDDIR'] = variant_path
14354773Snate@binkert.org
14365863Snate@binkert.org    # variant_dir is the tail component of build path, and is used to
14372632Sstever@eecs.umich.edu    # determine the build parameters (e.g., 'ALPHA_SE')
14385863Snate@binkert.org    (build_root, variant_dir) = splitpath(variant_path)
14392023SN/A
14405863Snate@binkert.org    # Set env variables according to the build directory config.
14415863Snate@binkert.org    sticky_vars.files = []
14425863Snate@binkert.org    # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
14435863Snate@binkert.org    # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
14445863Snate@binkert.org    # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
14455863Snate@binkert.org    current_vars_file = joinpath(build_root, 'variables', variant_dir)
14465863Snate@binkert.org    if isfile(current_vars_file):
14475863Snate@binkert.org        sticky_vars.files.append(current_vars_file)
144810135SCurtis.Dunham@arm.com        if not GetOption('silent'):
144910135SCurtis.Dunham@arm.com            print "Using saved variables file %s" % current_vars_file
14502632Sstever@eecs.umich.edu    else:
14515863Snate@binkert.org        # Build dir-specific variables file doesn't exist.
14522023SN/A
14532632Sstever@eecs.umich.edu        # Make sure the directory is there so we can create it later
14545863Snate@binkert.org        opt_dir = dirname(current_vars_file)
14555342Sstever@gmail.com        if not isdir(opt_dir):
14565863Snate@binkert.org            mkdir(opt_dir)
14572632Sstever@eecs.umich.edu
14585863Snate@binkert.org        # Get default build variables from source tree.  Variables are
14595863Snate@binkert.org        # normally determined by name of $VARIANT_DIR, but can be
14608267Ssteve.reinhardt@amd.com        # overridden by '--default=' arg on command line.
14618120Sgblack@eecs.umich.edu        default = GetOption('default')
14628267Ssteve.reinhardt@amd.com        opts_dir = joinpath(main.root.abspath, 'build_opts')
14638267Ssteve.reinhardt@amd.com        if default:
14648267Ssteve.reinhardt@amd.com            default_vars_files = [joinpath(build_root, 'variables', default),
14658267Ssteve.reinhardt@amd.com                                  joinpath(opts_dir, default)]
14668267Ssteve.reinhardt@amd.com        else:
14678267Ssteve.reinhardt@amd.com            default_vars_files = [joinpath(opts_dir, variant_dir)]
14688267Ssteve.reinhardt@amd.com        existing_files = filter(isfile, default_vars_files)
14698267Ssteve.reinhardt@amd.com        if existing_files:
14708267Ssteve.reinhardt@amd.com            default_vars_file = existing_files[0]
14715863Snate@binkert.org            sticky_vars.files.append(default_vars_file)
14725863Snate@binkert.org            print "Variables file %s not found,\n  using defaults in %s" \
14735863Snate@binkert.org                  % (current_vars_file, default_vars_file)
14742632Sstever@eecs.umich.edu        else:
14758267Ssteve.reinhardt@amd.com            print "Error: cannot find variables file %s or " \
14768267Ssteve.reinhardt@amd.com                  "default file(s) %s" \
14778267Ssteve.reinhardt@amd.com                  % (current_vars_file, ' or '.join(default_vars_files))
14782632Sstever@eecs.umich.edu            Exit(1)
14791888SN/A
14805863Snate@binkert.org    # Apply current variable settings to env
14815863Snate@binkert.org    sticky_vars.Update(env)
14821858SN/A
14838120Sgblack@eecs.umich.edu    help_texts["local_vars"] += \
14848120Sgblack@eecs.umich.edu        "Build variables for %s:\n" % variant_dir \
14857756SAli.Saidi@ARM.com                 + sticky_vars.GenerateHelpText(env)
14862598SN/A
14875863Snate@binkert.org    # Process variable settings.
14881858SN/A
14891858SN/A    if not have_fenv and env['USE_FENV']:
14901858SN/A        print "Warning: <fenv.h> not available; " \
14915863Snate@binkert.org              "forcing USE_FENV to False in", variant_dir + "."
14921858SN/A        env['USE_FENV'] = False
14931858SN/A
14941858SN/A    if not env['USE_FENV']:
14955863Snate@binkert.org        print "Warning: No IEEE FP rounding mode control in", variant_dir + "."
14961871SN/A        print "         FP results may deviate slightly from other platforms."
14971858SN/A
14981858SN/A    if env['EFENCE']:
14991858SN/A        env.Append(LIBS=['efence'])
15001858SN/A
15019651SAndreas.Sandberg@ARM.com    if env['USE_KVM']:
15029651SAndreas.Sandberg@ARM.com        if not have_kvm:
15039651SAndreas.Sandberg@ARM.com            print "Warning: Can not enable KVM, host seems to lack KVM support"
15049651SAndreas.Sandberg@ARM.com            env['USE_KVM'] = False
15059651SAndreas.Sandberg@ARM.com        elif not is_isa_kvm_compatible(env['TARGET_ISA']):
15069651SAndreas.Sandberg@ARM.com            print "Info: KVM support disabled due to unsupported host and " \
15079651SAndreas.Sandberg@ARM.com                "target ISA combination"
15089651SAndreas.Sandberg@ARM.com            env['USE_KVM'] = False
15099651SAndreas.Sandberg@ARM.com
151011798Santhony.gutierrez@amd.com    if env['BUILD_GPU']:
151111798Santhony.gutierrez@amd.com        env.Append(CPPDEFINES=['BUILD_GPU'])
151211798Santhony.gutierrez@amd.com
15139986Sandreas@sandberg.pp.se    # Warn about missing optional functionality
15149986Sandreas@sandberg.pp.se    if env['USE_KVM']:
15159986Sandreas@sandberg.pp.se        if not main['HAVE_PERF_ATTR_EXCLUDE_HOST']:
15169986Sandreas@sandberg.pp.se            print "Warning: perf_event headers lack support for the " \
15179986Sandreas@sandberg.pp.se                "exclude_host attribute. KVM instruction counts will " \
15189986Sandreas@sandberg.pp.se                "be inaccurate."
15199986Sandreas@sandberg.pp.se
15205863Snate@binkert.org    # Save sticky variable settings back to current variables file
15215863Snate@binkert.org    sticky_vars.Save(current_vars_file, env)
15221869SN/A
15231965SN/A    if env['USE_SSE2']:
15247739Sgblack@eecs.umich.edu        env.Append(CCFLAGS=['-msse2'])
15251965SN/A
15262761Sstever@eecs.umich.edu    # The src/SConscript file sets up the build rules in 'env' according
15275863Snate@binkert.org    # to the configured variables.  It returns a list of environments,
15281869SN/A    # one for each variant build (debug, opt, etc.)
152910196SCurtis.Dunham@arm.com    SConscript('src/SConscript', variant_dir = variant_path, exports = 'env')
15301869SN/A
153110196SCurtis.Dunham@arm.comdef pairwise(iterable):
153210196SCurtis.Dunham@arm.com    "s -> (s0,s1), (s1,s2), (s2, s3), ..."
153310196SCurtis.Dunham@arm.com    a, b = itertools.tee(iterable)
153410196SCurtis.Dunham@arm.com    b.next()
153510196SCurtis.Dunham@arm.com    return itertools.izip(a, b)
153610196SCurtis.Dunham@arm.com
153710196SCurtis.Dunham@arm.com# Create false dependencies so SCons will parse ISAs, establish
153810196SCurtis.Dunham@arm.com# dependencies, and setup the build Environments serially. Either
153910196SCurtis.Dunham@arm.com# SCons (likely) and/or our SConscripts (possibly) cannot cope with -j
154010196SCurtis.Dunham@arm.com# greater than 1. It appears to be standard race condition stuff; it
154110196SCurtis.Dunham@arm.com# doesn't always fail, but usually, and the behaviors are different.
154210196SCurtis.Dunham@arm.com# Every time I tried to remove this, builds would fail in some
154310196SCurtis.Dunham@arm.com# creative new way. So, don't do that. You'll want to, though, because
154410196SCurtis.Dunham@arm.com# tests/SConscript takes a long time to make its Environments.
154510196SCurtis.Dunham@arm.comfor t1, t2 in pairwise(sorted(all_isa_deps.iterkeys())):
154610196SCurtis.Dunham@arm.com    main.Depends('#%s-deps'     % t2, '#%s-deps'     % t1)
154710196SCurtis.Dunham@arm.com    main.Depends('#%s-environs' % t2, '#%s-environs' % t1)
1548955SN/A
15498120Sgblack@eecs.umich.edu# base help text
15508120Sgblack@eecs.umich.eduHelp('''
15518120Sgblack@eecs.umich.eduUsage: scons [scons options] [build variables] [target(s)]
15528120Sgblack@eecs.umich.edu
15538120Sgblack@eecs.umich.eduExtra scons options:
15548120Sgblack@eecs.umich.edu%(options)s
15558120Sgblack@eecs.umich.edu
15568120Sgblack@eecs.umich.eduGlobal build variables:
15578120Sgblack@eecs.umich.edu%(global_vars)s
15588120Sgblack@eecs.umich.edu
15598120Sgblack@eecs.umich.edu%(local_vars)s
15608120Sgblack@eecs.umich.edu''' % help_texts)
1561