SConstruct revision 11928
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',
21210068Sandreas.hansson@arm.com                 'PYTHONPATH', 'RANLIB', 'SWIG', '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
2449239Sandreas.hansson@arm.com# Check that swig is present
2459239Sandreas.hansson@arm.comif not 'SWIG' in main_dict_keys:
2469239Sandreas.hansson@arm.com    print "swig is not installed (package swig on Ubuntu and RedHat)"
2479239Sandreas.hansson@arm.com    Exit(1)
2489239Sandreas.hansson@arm.com
2496655Snate@binkert.org# add useful python code PYTHONPATH so it can be used by subprocesses
2506655Snate@binkert.org# as well
2516655Snate@binkert.orgmain.AppendENVPath('PYTHONPATH', extra_python_paths)
2526655Snate@binkert.org
2535871Snate@binkert.org########################################################################
2545871Snate@binkert.org#
2555863Snate@binkert.org# Mercurial Stuff.
2565871Snate@binkert.org#
2578878Ssteve.reinhardt@amd.com# If the gem5 directory is a mercurial repository, we should do some
2585871Snate@binkert.org# extra things.
2595871Snate@binkert.org#
2605871Snate@binkert.org########################################################################
2615863Snate@binkert.org
2626121Snate@binkert.orghgdir = main.root.Dir(".hg")
2635863Snate@binkert.org
26411408Sandreas.sandberg@arm.com
26511408Sandreas.sandberg@arm.comstyle_message = """
2668336Ssteve.reinhardt@amd.comYou're missing the gem5 style hook, which automatically checks your code
26711469SCurtis.Dunham@arm.comagainst the gem5 style rules on %s.
26811469SCurtis.Dunham@arm.comThis script will now install the hook in your %s.
2698336Ssteve.reinhardt@amd.comPress enter to continue, or ctrl-c to abort: """
2704678Snate@binkert.org
27111887Sandreas.sandberg@arm.commercurial_style_message = """
27211887Sandreas.sandberg@arm.comYou're missing the gem5 style hook, which automatically checks your code
27311887Sandreas.sandberg@arm.comagainst the gem5 style rules on hg commit and qrefresh commands.
27411887Sandreas.sandberg@arm.comThis script will now install the hook in your .hg/hgrc file.
27511887Sandreas.sandberg@arm.comPress enter to continue, or ctrl-c to abort: """
27611887Sandreas.sandberg@arm.com
27711887Sandreas.sandberg@arm.comgit_style_message = """
27811887Sandreas.sandberg@arm.comYou're missing the gem5 style or commit message hook. These hooks help
27911887Sandreas.sandberg@arm.comto ensure that your code follows gem5's style rules on git commit.
28011887Sandreas.sandberg@arm.comThis script will now install the hook in your .git/hooks/ directory.
28111887Sandreas.sandberg@arm.comPress enter to continue, or ctrl-c to abort: """
28211408Sandreas.sandberg@arm.com
28311401Sandreas.sandberg@arm.commercurial_style_upgrade_message = """
28411401Sandreas.sandberg@arm.comYour Mercurial style hooks are not up-to-date. This script will now
28511401Sandreas.sandberg@arm.comtry to automatically update them. A backup of your hgrc will be saved
28611401Sandreas.sandberg@arm.comin .hg/hgrc.old.
28711401Sandreas.sandberg@arm.comPress enter to continue, or ctrl-c to abort: """
28811401Sandreas.sandberg@arm.com
2898336Ssteve.reinhardt@amd.commercurial_style_hook = """
2908336Ssteve.reinhardt@amd.com# The following lines were automatically added by gem5/SConstruct
2918336Ssteve.reinhardt@amd.com# to provide the gem5 style-checking hooks
2924678Snate@binkert.org[extensions]
29311401Sandreas.sandberg@arm.comhgstyle = %s/util/hgstyle.py
2944678Snate@binkert.org
2954678Snate@binkert.org[hooks]
29611401Sandreas.sandberg@arm.compretxncommit.style = python:hgstyle.check_style
29711401Sandreas.sandberg@arm.compre-qrefresh.style = python:hgstyle.check_style
2988336Ssteve.reinhardt@amd.com# End of SConstruct additions
2994678Snate@binkert.org
3008336Ssteve.reinhardt@amd.com""" % (main.root.abspath)
3018336Ssteve.reinhardt@amd.com
3028336Ssteve.reinhardt@amd.commercurial_lib_not_found = """
3038336Ssteve.reinhardt@amd.comMercurial libraries cannot be found, ignoring style hook.  If
3048336Ssteve.reinhardt@amd.comyou are a gem5 developer, please fix this and run the style
3058336Ssteve.reinhardt@amd.comhook. It is important.
3065871Snate@binkert.org"""
3075871Snate@binkert.org
3088336Ssteve.reinhardt@amd.com# Check for style hook and prompt for installation if it's not there.
30911408Sandreas.sandberg@arm.com# Skip this if --ignore-style was specified, there's no interactive
31011408Sandreas.sandberg@arm.com# terminal to prompt, or no recognized revision control system can be
31111408Sandreas.sandberg@arm.com# found.
31211408Sandreas.sandberg@arm.comignore_style = GetOption('ignore_style') or not sys.stdin.isatty()
31311408Sandreas.sandberg@arm.com
31411408Sandreas.sandberg@arm.com# Try wire up Mercurial to the style hooks
31511408Sandreas.sandberg@arm.comif not ignore_style and hgdir.exists():
3168336Ssteve.reinhardt@amd.com    style_hook = True
31711401Sandreas.sandberg@arm.com    style_hooks = tuple()
31811401Sandreas.sandberg@arm.com    hgrc = hgdir.File('hgrc')
31911401Sandreas.sandberg@arm.com    hgrc_old = hgdir.File('hgrc.old')
3205871Snate@binkert.org    try:
3218336Ssteve.reinhardt@amd.com        from mercurial import ui
3228336Ssteve.reinhardt@amd.com        ui = ui.ui()
32311401Sandreas.sandberg@arm.com        ui.readconfig(hgrc.abspath)
32411401Sandreas.sandberg@arm.com        style_hooks = (ui.config('hooks', 'pretxncommit.style', None),
32511401Sandreas.sandberg@arm.com                       ui.config('hooks', 'pre-qrefresh.style', None))
32611401Sandreas.sandberg@arm.com        style_hook = all(style_hooks)
32711401Sandreas.sandberg@arm.com        style_extension = ui.config('extensions', 'style', None)
3284678Snate@binkert.org    except ImportError:
3295871Snate@binkert.org        print mercurial_lib_not_found
3304678Snate@binkert.org
33111401Sandreas.sandberg@arm.com    if "python:style.check_style" in style_hooks:
33211401Sandreas.sandberg@arm.com        # Try to upgrade the style hooks
33311401Sandreas.sandberg@arm.com        print mercurial_style_upgrade_message
33411401Sandreas.sandberg@arm.com        # continue unless user does ctrl-c/ctrl-d etc.
33511401Sandreas.sandberg@arm.com        try:
33611401Sandreas.sandberg@arm.com            raw_input()
33711401Sandreas.sandberg@arm.com        except:
33811401Sandreas.sandberg@arm.com            print "Input exception, exiting scons.\n"
33911401Sandreas.sandberg@arm.com            sys.exit(1)
34011401Sandreas.sandberg@arm.com        shutil.copyfile(hgrc.abspath, hgrc_old.abspath)
34111401Sandreas.sandberg@arm.com        re_style_hook = re.compile(r"^([^=#]+)\.style\s*=\s*([^#\s]+).*")
34211401Sandreas.sandberg@arm.com        re_style_extension = re.compile("style\s*=\s*([^#\s]+).*")
34311450Sandreas.sandberg@arm.com        old, new = open(hgrc_old.abspath, 'r'), open(hgrc.abspath, 'w')
34411450Sandreas.sandberg@arm.com        for l in old:
34511450Sandreas.sandberg@arm.com            m_hook = re_style_hook.match(l)
34611450Sandreas.sandberg@arm.com            m_ext = re_style_extension.match(l)
34711450Sandreas.sandberg@arm.com            if m_hook:
34811450Sandreas.sandberg@arm.com                hook, check = m_hook.groups()
34911450Sandreas.sandberg@arm.com                if check != "python:style.check_style":
35011450Sandreas.sandberg@arm.com                    print "Warning: %s.style is using a non-default " \
35111450Sandreas.sandberg@arm.com                        "checker: %s" % (hook, check)
35211450Sandreas.sandberg@arm.com                if hook not in ("pretxncommit", "pre-qrefresh"):
35311450Sandreas.sandberg@arm.com                    print "Warning: Updating unknown style hook: %s" % hook
35411401Sandreas.sandberg@arm.com
35511450Sandreas.sandberg@arm.com                l = "%s.style = python:hgstyle.check_style\n" % hook
35611450Sandreas.sandberg@arm.com            elif m_ext and m_ext.group(1) == style_extension:
35711450Sandreas.sandberg@arm.com                l = "hgstyle = %s/util/hgstyle.py\n" % main.root.abspath
35811401Sandreas.sandberg@arm.com
35911450Sandreas.sandberg@arm.com            new.write(l)
36011401Sandreas.sandberg@arm.com    elif not style_hook:
3618336Ssteve.reinhardt@amd.com        print mercurial_style_message,
3628336Ssteve.reinhardt@amd.com        # continue unless user does ctrl-c/ctrl-d etc.
3638336Ssteve.reinhardt@amd.com        try:
3648336Ssteve.reinhardt@amd.com            raw_input()
3658336Ssteve.reinhardt@amd.com        except:
3668336Ssteve.reinhardt@amd.com            print "Input exception, exiting scons.\n"
3678336Ssteve.reinhardt@amd.com            sys.exit(1)
3688336Ssteve.reinhardt@amd.com        hgrc_path = '%s/.hg/hgrc' % main.root.abspath
3698336Ssteve.reinhardt@amd.com        print "Adding style hook to", hgrc_path, "\n"
3708336Ssteve.reinhardt@amd.com        try:
37111401Sandreas.sandberg@arm.com            with open(hgrc_path, 'a') as f:
37211401Sandreas.sandberg@arm.com                f.write(mercurial_style_hook)
3738336Ssteve.reinhardt@amd.com        except:
3748336Ssteve.reinhardt@amd.com            print "Error updating", hgrc_path
3758336Ssteve.reinhardt@amd.com            sys.exit(1)
3765871Snate@binkert.org
37711476Sandreas.sandberg@arm.comdef install_git_style_hooks():
37811476Sandreas.sandberg@arm.com    try:
37911476Sandreas.sandberg@arm.com        gitdir = Dir(readCommand(
38011476Sandreas.sandberg@arm.com            ["git", "rev-parse", "--git-dir"]).strip("\n"))
38111476Sandreas.sandberg@arm.com    except Exception, e:
38211476Sandreas.sandberg@arm.com        print "Warning: Failed to find git repo directory: %s" % e
38311476Sandreas.sandberg@arm.com        return
38411476Sandreas.sandberg@arm.com
38511476Sandreas.sandberg@arm.com    git_hooks = gitdir.Dir("hooks")
38611887Sandreas.sandberg@arm.com    def hook_exists(hook_name):
38711887Sandreas.sandberg@arm.com        hook = git_hooks.File(hook_name)
38811887Sandreas.sandberg@arm.com        return hook.exists()
38911408Sandreas.sandberg@arm.com
39011887Sandreas.sandberg@arm.com    def hook_install(hook_name, script):
39111887Sandreas.sandberg@arm.com        hook = git_hooks.File(hook_name)
39211887Sandreas.sandberg@arm.com        if hook.exists():
39311887Sandreas.sandberg@arm.com            print "Warning: Can't install %s, hook already exists." % hook_name
39411887Sandreas.sandberg@arm.com            return
39511887Sandreas.sandberg@arm.com
39611926Sgabeblack@google.com        if hook.islink():
39711926Sgabeblack@google.com            print "Warning: Removing broken symlink for hook %s." % hook_name
39811926Sgabeblack@google.com            os.unlink(hook.get_abspath())
39911926Sgabeblack@google.com
40011887Sandreas.sandberg@arm.com        if not git_hooks.exists():
40111887Sandreas.sandberg@arm.com            mkdir(git_hooks.get_abspath())
40211887Sandreas.sandberg@arm.com
40311927Sgabeblack@google.com        abs_symlink_hooks = git_hooks.islink() and \
40411927Sgabeblack@google.com            os.path.isabs(os.readlink(git_hooks.get_abspath()))
40511927Sgabeblack@google.com
40611927Sgabeblack@google.com        # Use a relative symlink if the hooks live in the source directory,
40711927Sgabeblack@google.com        # and the hooks directory is not a symlink to an absolute path.
40811927Sgabeblack@google.com        if hook.is_under(main.root) and not abs_symlink_hooks:
40911887Sandreas.sandberg@arm.com            script_path = os.path.relpath(
41011928Sgabeblack@google.com                os.path.realpath(script.get_abspath()),
41111928Sgabeblack@google.com                os.path.realpath(hook.Dir(".").get_abspath()))
41211887Sandreas.sandberg@arm.com        else:
41311887Sandreas.sandberg@arm.com            script_path = script.get_abspath()
41411887Sandreas.sandberg@arm.com
41511887Sandreas.sandberg@arm.com        try:
41611887Sandreas.sandberg@arm.com            os.symlink(script_path, hook.get_abspath())
41711887Sandreas.sandberg@arm.com        except:
41811887Sandreas.sandberg@arm.com            print "Error updating git %s hook" % hook_name
41911887Sandreas.sandberg@arm.com            raise
42011887Sandreas.sandberg@arm.com
42111887Sandreas.sandberg@arm.com    if hook_exists("pre-commit") and hook_exists("commit-msg"):
42211476Sandreas.sandberg@arm.com        return
42311476Sandreas.sandberg@arm.com
42411408Sandreas.sandberg@arm.com    print git_style_message,
42511408Sandreas.sandberg@arm.com    try:
42611408Sandreas.sandberg@arm.com        raw_input()
42711408Sandreas.sandberg@arm.com    except:
42811408Sandreas.sandberg@arm.com        print "Input exception, exiting scons.\n"
42911408Sandreas.sandberg@arm.com        sys.exit(1)
43011408Sandreas.sandberg@arm.com
43111887Sandreas.sandberg@arm.com    git_style_script = File("util/git-pre-commit.py")
43211887Sandreas.sandberg@arm.com    git_msg_script = File("ext/git-commit-msg")
43311476Sandreas.sandberg@arm.com
43411887Sandreas.sandberg@arm.com    hook_install("pre-commit", git_style_script)
43511887Sandreas.sandberg@arm.com    hook_install("commit-msg", git_msg_script)
43611476Sandreas.sandberg@arm.com
43711476Sandreas.sandberg@arm.com# Try to wire up git to the style hooks
43811476Sandreas.sandberg@arm.comif not ignore_style and main.root.Entry(".git").exists():
43911476Sandreas.sandberg@arm.com    install_git_style_hooks()
4406121Snate@binkert.org
441955SN/A###################################################
442955SN/A#
4432632Sstever@eecs.umich.edu# Figure out which configurations to set up based on the path(s) of
4442632Sstever@eecs.umich.edu# the target(s).
445955SN/A#
446955SN/A###################################################
447955SN/A
448955SN/A# Find default configuration & binary.
4498878Ssteve.reinhardt@amd.comDefault(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug'))
450955SN/A
4512632Sstever@eecs.umich.edu# helper function: find last occurrence of element in list
4522632Sstever@eecs.umich.edudef rfind(l, elt, offs = -1):
4532632Sstever@eecs.umich.edu    for i in range(len(l)+offs, 0, -1):
4542632Sstever@eecs.umich.edu        if l[i] == elt:
4552632Sstever@eecs.umich.edu            return i
4562632Sstever@eecs.umich.edu    raise ValueError, "element not found"
4572632Sstever@eecs.umich.edu
4588268Ssteve.reinhardt@amd.com# Take a list of paths (or SCons Nodes) and return a list with all
4598268Ssteve.reinhardt@amd.com# paths made absolute and ~-expanded.  Paths will be interpreted
4608268Ssteve.reinhardt@amd.com# relative to the launch directory unless a different root is provided
4618268Ssteve.reinhardt@amd.comdef makePathListAbsolute(path_list, root=GetLaunchDir()):
4628268Ssteve.reinhardt@amd.com    return [abspath(joinpath(root, expanduser(str(p))))
4638268Ssteve.reinhardt@amd.com            for p in path_list]
4648268Ssteve.reinhardt@amd.com
4652632Sstever@eecs.umich.edu# Each target must have 'build' in the interior of the path; the
4662632Sstever@eecs.umich.edu# directory below this will determine the build parameters.  For
4672632Sstever@eecs.umich.edu# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
4682632Sstever@eecs.umich.edu# recognize that ALPHA_SE specifies the configuration because it
4698268Ssteve.reinhardt@amd.com# follow 'build' in the build path.
4702632Sstever@eecs.umich.edu
4718268Ssteve.reinhardt@amd.com# The funky assignment to "[:]" is needed to replace the list contents
4728268Ssteve.reinhardt@amd.com# in place rather than reassign the symbol to a new list, which
4738268Ssteve.reinhardt@amd.com# doesn't work (obviously!).
4748268Ssteve.reinhardt@amd.comBUILD_TARGETS[:] = makePathListAbsolute(BUILD_TARGETS)
4753718Sstever@eecs.umich.edu
4762634Sstever@eecs.umich.edu# Generate a list of the unique build roots and configs that the
4772634Sstever@eecs.umich.edu# collected targets reference.
4785863Snate@binkert.orgvariant_paths = []
4792638Sstever@eecs.umich.edubuild_root = None
4808268Ssteve.reinhardt@amd.comfor t in BUILD_TARGETS:
4812632Sstever@eecs.umich.edu    path_dirs = t.split('/')
4822632Sstever@eecs.umich.edu    try:
4832632Sstever@eecs.umich.edu        build_top = rfind(path_dirs, 'build', -2)
4842632Sstever@eecs.umich.edu    except:
4852632Sstever@eecs.umich.edu        print "Error: no non-leaf 'build' dir found on target path", t
4861858SN/A        Exit(1)
4873716Sstever@eecs.umich.edu    this_build_root = joinpath('/',*path_dirs[:build_top+1])
4882638Sstever@eecs.umich.edu    if not build_root:
4892638Sstever@eecs.umich.edu        build_root = this_build_root
4902638Sstever@eecs.umich.edu    else:
4912638Sstever@eecs.umich.edu        if this_build_root != build_root:
4922638Sstever@eecs.umich.edu            print "Error: build targets not under same build root\n"\
4932638Sstever@eecs.umich.edu                  "  %s\n  %s" % (build_root, this_build_root)
4942638Sstever@eecs.umich.edu            Exit(1)
4955863Snate@binkert.org    variant_path = joinpath('/',*path_dirs[:build_top+2])
4965863Snate@binkert.org    if variant_path not in variant_paths:
4975863Snate@binkert.org        variant_paths.append(variant_path)
498955SN/A
4995341Sstever@gmail.com# Make sure build_root exists (might not if this is the first build there)
5005341Sstever@gmail.comif not isdir(build_root):
5015863Snate@binkert.org    mkdir(build_root)
5027756SAli.Saidi@ARM.commain['BUILDROOT'] = build_root
5035341Sstever@gmail.com
5046121Snate@binkert.orgExport('main')
5054494Ssaidi@eecs.umich.edu
5066121Snate@binkert.orgmain.SConsignFile(joinpath(build_root, "sconsign"))
5071105SN/A
5082667Sstever@eecs.umich.edu# Default duplicate option is to use hard links, but this messes up
5092667Sstever@eecs.umich.edu# when you use emacs to edit a file in the target dir, as emacs moves
5102667Sstever@eecs.umich.edu# file to file~ then copies to file, breaking the link.  Symbolic
5112667Sstever@eecs.umich.edu# (soft) links work better.
5126121Snate@binkert.orgmain.SetOption('duplicate', 'soft-copy')
5132667Sstever@eecs.umich.edu
5145341Sstever@gmail.com#
5155863Snate@binkert.org# Set up global sticky variables... these are common to an entire build
5165341Sstever@gmail.com# tree (not specific to a particular build like ALPHA_SE)
5175341Sstever@gmail.com#
5185341Sstever@gmail.com
5198120Sgblack@eecs.umich.eduglobal_vars_file = joinpath(build_root, 'variables.global')
5205341Sstever@gmail.com
5218120Sgblack@eecs.umich.eduglobal_vars = Variables(global_vars_file, args=ARGUMENTS)
5225341Sstever@gmail.com
5238120Sgblack@eecs.umich.eduglobal_vars.AddVariables(
5246121Snate@binkert.org    ('CC', 'C compiler', environ.get('CC', main['CC'])),
5256121Snate@binkert.org    ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])),
5268980Ssteve.reinhardt@amd.com    ('SWIG', 'SWIG tool', environ.get('SWIG', main['SWIG'])),
5279396Sandreas.hansson@arm.com    ('PROTOC', 'protoc tool', environ.get('PROTOC', 'protoc')),
5285397Ssaidi@eecs.umich.edu    ('BATCH', 'Use batch pool for build and tests', False),
5295397Ssaidi@eecs.umich.edu    ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
5307727SAli.Saidi@ARM.com    ('M5_BUILD_CACHE', 'Cache built objects in this directory', False),
5318268Ssteve.reinhardt@amd.com    ('EXTRAS', 'Add extra directories to the compilation', '')
5326168Snate@binkert.org    )
5335341Sstever@gmail.com
5348120Sgblack@eecs.umich.edu# Update main environment with values from ARGUMENTS & global_vars_file
5358120Sgblack@eecs.umich.eduglobal_vars.Update(main)
5368120Sgblack@eecs.umich.eduhelp_texts["global_vars"] += global_vars.GenerateHelpText(main)
5376814Sgblack@eecs.umich.edu
5385863Snate@binkert.org# Save sticky variable settings back to current variables file
5398120Sgblack@eecs.umich.eduglobal_vars.Save(global_vars_file, main)
5405341Sstever@gmail.com
5415863Snate@binkert.org# Parse EXTRAS variable to build list of all directories where we're
5428268Ssteve.reinhardt@amd.com# look for sources etc.  This list is exported as extras_dir_list.
5436121Snate@binkert.orgbase_dir = main.srcdir.abspath
5446121Snate@binkert.orgif main['EXTRAS']:
5458268Ssteve.reinhardt@amd.com    extras_dir_list = makePathListAbsolute(main['EXTRAS'].split(':'))
5465742Snate@binkert.orgelse:
5475742Snate@binkert.org    extras_dir_list = []
5485341Sstever@gmail.com
5495742Snate@binkert.orgExport('base_dir')
5505742Snate@binkert.orgExport('extras_dir_list')
5515341Sstever@gmail.com
5526017Snate@binkert.org# the ext directory should be on the #includes path
5536121Snate@binkert.orgmain.Append(CPPPATH=[Dir('ext')])
5546017Snate@binkert.org
5557816Ssteve.reinhardt@amd.comdef strip_build_path(path, env):
5567756SAli.Saidi@ARM.com    path = str(path)
5577756SAli.Saidi@ARM.com    variant_base = env['BUILDROOT'] + os.path.sep
5587756SAli.Saidi@ARM.com    if path.startswith(variant_base):
5597756SAli.Saidi@ARM.com        path = path[len(variant_base):]
5607756SAli.Saidi@ARM.com    elif path.startswith('build/'):
5617756SAli.Saidi@ARM.com        path = path[6:]
5627756SAli.Saidi@ARM.com    return path
5637756SAli.Saidi@ARM.com
5647816Ssteve.reinhardt@amd.com# Generate a string of the form:
5657816Ssteve.reinhardt@amd.com#   common/path/prefix/src1, src2 -> tgt1, tgt2
5667816Ssteve.reinhardt@amd.com# to print while building.
5677816Ssteve.reinhardt@amd.comclass Transform(object):
5687816Ssteve.reinhardt@amd.com    # all specific color settings should be here and nowhere else
5697816Ssteve.reinhardt@amd.com    tool_color = termcap.Normal
5707816Ssteve.reinhardt@amd.com    pfx_color = termcap.Yellow
5717816Ssteve.reinhardt@amd.com    srcs_color = termcap.Yellow + termcap.Bold
5727816Ssteve.reinhardt@amd.com    arrow_color = termcap.Blue + termcap.Bold
5737816Ssteve.reinhardt@amd.com    tgts_color = termcap.Yellow + termcap.Bold
5747756SAli.Saidi@ARM.com
5757816Ssteve.reinhardt@amd.com    def __init__(self, tool, max_sources=99):
5767816Ssteve.reinhardt@amd.com        self.format = self.tool_color + (" [%8s] " % tool) \
5777816Ssteve.reinhardt@amd.com                      + self.pfx_color + "%s" \
5787816Ssteve.reinhardt@amd.com                      + self.srcs_color + "%s" \
5797816Ssteve.reinhardt@amd.com                      + self.arrow_color + " -> " \
5807816Ssteve.reinhardt@amd.com                      + self.tgts_color + "%s" \
5817816Ssteve.reinhardt@amd.com                      + termcap.Normal
5827816Ssteve.reinhardt@amd.com        self.max_sources = max_sources
5837816Ssteve.reinhardt@amd.com
5847816Ssteve.reinhardt@amd.com    def __call__(self, target, source, env, for_signature=None):
5857816Ssteve.reinhardt@amd.com        # truncate source list according to max_sources param
5867816Ssteve.reinhardt@amd.com        source = source[0:self.max_sources]
5877816Ssteve.reinhardt@amd.com        def strip(f):
5887816Ssteve.reinhardt@amd.com            return strip_build_path(str(f), env)
5897816Ssteve.reinhardt@amd.com        if len(source) > 0:
5907816Ssteve.reinhardt@amd.com            srcs = map(strip, source)
5917816Ssteve.reinhardt@amd.com        else:
5927816Ssteve.reinhardt@amd.com            srcs = ['']
5937816Ssteve.reinhardt@amd.com        tgts = map(strip, target)
5947816Ssteve.reinhardt@amd.com        # surprisingly, os.path.commonprefix is a dumb char-by-char string
5957816Ssteve.reinhardt@amd.com        # operation that has nothing to do with paths.
5967816Ssteve.reinhardt@amd.com        com_pfx = os.path.commonprefix(srcs + tgts)
5977816Ssteve.reinhardt@amd.com        com_pfx_len = len(com_pfx)
5987816Ssteve.reinhardt@amd.com        if com_pfx:
5997816Ssteve.reinhardt@amd.com            # do some cleanup and sanity checking on common prefix
6007816Ssteve.reinhardt@amd.com            if com_pfx[-1] == ".":
6017816Ssteve.reinhardt@amd.com                # prefix matches all but file extension: ok
6027816Ssteve.reinhardt@amd.com                # back up one to change 'foo.cc -> o' to 'foo.cc -> .o'
6037816Ssteve.reinhardt@amd.com                com_pfx = com_pfx[0:-1]
6047816Ssteve.reinhardt@amd.com            elif com_pfx[-1] == "/":
6057816Ssteve.reinhardt@amd.com                # common prefix is directory path: OK
6067816Ssteve.reinhardt@amd.com                pass
6077816Ssteve.reinhardt@amd.com            else:
6087816Ssteve.reinhardt@amd.com                src0_len = len(srcs[0])
6097816Ssteve.reinhardt@amd.com                tgt0_len = len(tgts[0])
6107816Ssteve.reinhardt@amd.com                if src0_len == com_pfx_len:
6117816Ssteve.reinhardt@amd.com                    # source is a substring of target, OK
6127816Ssteve.reinhardt@amd.com                    pass
6137816Ssteve.reinhardt@amd.com                elif tgt0_len == com_pfx_len:
6147816Ssteve.reinhardt@amd.com                    # target is a substring of source, need to back up to
6157816Ssteve.reinhardt@amd.com                    # avoid empty string on RHS of arrow
6167816Ssteve.reinhardt@amd.com                    sep_idx = com_pfx.rfind(".")
6177816Ssteve.reinhardt@amd.com                    if sep_idx != -1:
6187816Ssteve.reinhardt@amd.com                        com_pfx = com_pfx[0:sep_idx]
6197816Ssteve.reinhardt@amd.com                    else:
6207816Ssteve.reinhardt@amd.com                        com_pfx = ''
6217816Ssteve.reinhardt@amd.com                elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".":
6227816Ssteve.reinhardt@amd.com                    # still splitting at file extension: ok
6237816Ssteve.reinhardt@amd.com                    pass
6247816Ssteve.reinhardt@amd.com                else:
6257816Ssteve.reinhardt@amd.com                    # probably a fluke; ignore it
6267816Ssteve.reinhardt@amd.com                    com_pfx = ''
6277816Ssteve.reinhardt@amd.com        # recalculate length in case com_pfx was modified
6287816Ssteve.reinhardt@amd.com        com_pfx_len = len(com_pfx)
6297816Ssteve.reinhardt@amd.com        def fmt(files):
6307816Ssteve.reinhardt@amd.com            f = map(lambda s: s[com_pfx_len:], files)
6317816Ssteve.reinhardt@amd.com            return ', '.join(f)
6327816Ssteve.reinhardt@amd.com        return self.format % (com_pfx, fmt(srcs), fmt(tgts))
6337816Ssteve.reinhardt@amd.com
6347816Ssteve.reinhardt@amd.comExport('Transform')
6357816Ssteve.reinhardt@amd.com
6368947Sandreas.hansson@arm.com# enable the regression script to use the termcap
6378947Sandreas.hansson@arm.commain['TERMCAP'] = termcap
6387756SAli.Saidi@ARM.com
6398120Sgblack@eecs.umich.eduif GetOption('verbose'):
6407756SAli.Saidi@ARM.com    def MakeAction(action, string, *args, **kwargs):
6417756SAli.Saidi@ARM.com        return Action(action, *args, **kwargs)
6427756SAli.Saidi@ARM.comelse:
6437756SAli.Saidi@ARM.com    MakeAction = Action
6447816Ssteve.reinhardt@amd.com    main['CCCOMSTR']        = Transform("CC")
6457816Ssteve.reinhardt@amd.com    main['CXXCOMSTR']       = Transform("CXX")
6467816Ssteve.reinhardt@amd.com    main['ASCOMSTR']        = Transform("AS")
6477816Ssteve.reinhardt@amd.com    main['SWIGCOMSTR']      = Transform("SWIG")
6487816Ssteve.reinhardt@amd.com    main['ARCOMSTR']        = Transform("AR", 0)
6497816Ssteve.reinhardt@amd.com    main['LINKCOMSTR']      = Transform("LINK", 0)
6507816Ssteve.reinhardt@amd.com    main['RANLIBCOMSTR']    = Transform("RANLIB", 0)
6517816Ssteve.reinhardt@amd.com    main['M4COMSTR']        = Transform("M4")
6527816Ssteve.reinhardt@amd.com    main['SHCCCOMSTR']      = Transform("SHCC")
6537816Ssteve.reinhardt@amd.com    main['SHCXXCOMSTR']     = Transform("SHCXX")
6547756SAli.Saidi@ARM.comExport('MakeAction')
6557756SAli.Saidi@ARM.com
6569227Sandreas.hansson@arm.com# Initialize the Link-Time Optimization (LTO) flags
6579227Sandreas.hansson@arm.commain['LTO_CCFLAGS'] = []
6589227Sandreas.hansson@arm.commain['LTO_LDFLAGS'] = []
6599227Sandreas.hansson@arm.com
6609590Sandreas@sandberg.pp.se# According to the readme, tcmalloc works best if the compiler doesn't
6619590Sandreas@sandberg.pp.se# assume that we're using the builtin malloc and friends. These flags
6629590Sandreas@sandberg.pp.se# are compiler-specific, so we need to set them after we detect which
6639590Sandreas@sandberg.pp.se# compiler we're using.
6649590Sandreas@sandberg.pp.semain['TCMALLOC_CCFLAGS'] = []
6659590Sandreas@sandberg.pp.se
6666654Snate@binkert.orgCXX_version = readCommand([main['CXX'],'--version'], exception=False)
6676654Snate@binkert.orgCXX_V = readCommand([main['CXX'],'-V'], exception=False)
6685871Snate@binkert.org
6696121Snate@binkert.orgmain['GCC'] = CXX_version and CXX_version.find('g++') >= 0
6708946Sandreas.hansson@arm.commain['CLANG'] = CXX_version and CXX_version.find('clang') >= 0
6719419Sandreas.hansson@arm.comif main['GCC'] + main['CLANG'] > 1:
6723940Ssaidi@eecs.umich.edu    print 'Error: How can we have two at the same time?'
6733918Ssaidi@eecs.umich.edu    Exit(1)
6743918Ssaidi@eecs.umich.edu
6751858SN/A# Set up default C++ compiler flags
6769556Sandreas.hansson@arm.comif main['GCC'] or main['CLANG']:
6779556Sandreas.hansson@arm.com    # As gcc and clang share many flags, do the common parts here
6789556Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-pipe'])
6799556Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-fno-strict-aliasing'])
68011294Sandreas.hansson@arm.com    # Enable -Wall and -Wextra and then disable the few warnings that
68111294Sandreas.hansson@arm.com    # we consistently violate
68211294Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-Wall', '-Wundef', '-Wextra',
68311294Sandreas.hansson@arm.com                         '-Wno-sign-compare', '-Wno-unused-parameter'])
68410878Sandreas.hansson@arm.com    # We always compile using C++11
68510878Sandreas.hansson@arm.com    main.Append(CXXFLAGS=['-std=c++11'])
68611811Sbaz21@cam.ac.uk    if sys.platform.startswith('freebsd'):
68711811Sbaz21@cam.ac.uk        main.Append(CCFLAGS=['-I/usr/local/include'])
68811811Sbaz21@cam.ac.uk        main.Append(CXXFLAGS=['-I/usr/local/include'])
6899556Sandreas.hansson@arm.comelse:
6909556Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal,
6919556Sandreas.hansson@arm.com    print "Don't know what compiler options to use for your compiler."
6929556Sandreas.hansson@arm.com    print termcap.Yellow + '       compiler:' + termcap.Normal, main['CXX']
6939556Sandreas.hansson@arm.com    print termcap.Yellow + '       version:' + termcap.Normal,
6949556Sandreas.hansson@arm.com    if not CXX_version:
6959556Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\
6969556Sandreas.hansson@arm.com               termcap.Normal
6979556Sandreas.hansson@arm.com    else:
6989556Sandreas.hansson@arm.com        print CXX_version.replace('\n', '<nl>')
6999556Sandreas.hansson@arm.com    print "       If you're trying to use a compiler other than GCC"
7009556Sandreas.hansson@arm.com    print "       or clang, there appears to be something wrong with your"
7019556Sandreas.hansson@arm.com    print "       environment."
7029556Sandreas.hansson@arm.com    print "       "
7039556Sandreas.hansson@arm.com    print "       If you are trying to use a compiler other than those listed"
7049556Sandreas.hansson@arm.com    print "       above you will need to ease fix SConstruct and "
7059556Sandreas.hansson@arm.com    print "       src/SConscript to support that compiler."
7069556Sandreas.hansson@arm.com    Exit(1)
7079556Sandreas.hansson@arm.com
7086121Snate@binkert.orgif main['GCC']:
70911500Sandreas.hansson@arm.com    # Check for a supported version of gcc. >= 4.8 is chosen for its
71010238Sandreas.hansson@arm.com    # level of c++11 support. See
71110878Sandreas.hansson@arm.com    # http://gcc.gnu.org/projects/cxx0x.html for details.
7129420Sandreas.hansson@arm.com    gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False)
71311500Sandreas.hansson@arm.com    if compareVersions(gcc_version, "4.8") < 0:
71411500Sandreas.hansson@arm.com        print 'Error: gcc version 4.8 or newer required.'
7159420Sandreas.hansson@arm.com        print '       Installed version:', gcc_version
7169420Sandreas.hansson@arm.com        Exit(1)
7179420Sandreas.hansson@arm.com
7189420Sandreas.hansson@arm.com    main['GCC_VERSION'] = gcc_version
7199420Sandreas.hansson@arm.com
72010264Sandreas.hansson@arm.com    # gcc from version 4.8 and above generates "rep; ret" instructions
72110264Sandreas.hansson@arm.com    # to avoid performance penalties on certain AMD chips. Older
72210264Sandreas.hansson@arm.com    # assemblers detect this as an error, "Error: expecting string
72310264Sandreas.hansson@arm.com    # instruction after `rep'"
72411925Sgabeblack@google.com    as_version_raw = readCommand([main['AS'], '-v', '/dev/null',
72511925Sgabeblack@google.com                                  '-o', '/dev/null'],
72611500Sandreas.hansson@arm.com                                 exception=False).split()
72710264Sandreas.hansson@arm.com
72811500Sandreas.hansson@arm.com    # version strings may contain extra distro-specific
72911500Sandreas.hansson@arm.com    # qualifiers, so play it safe and keep only what comes before
73011500Sandreas.hansson@arm.com    # the first hyphen
73111500Sandreas.hansson@arm.com    as_version = as_version_raw[-1].split('-')[0] if as_version_raw else None
73210866Sandreas.hansson@arm.com
73311500Sandreas.hansson@arm.com    if not as_version or compareVersions(as_version, "2.23") < 0:
73411500Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + \
73511500Sandreas.hansson@arm.com            'Warning: This combination of gcc and binutils have' + \
73611500Sandreas.hansson@arm.com            ' known incompatibilities.\n' + \
73711500Sandreas.hansson@arm.com            '         If you encounter build problems, please update ' + \
73811500Sandreas.hansson@arm.com            'binutils to 2.23.' + \
73911500Sandreas.hansson@arm.com            termcap.Normal
74010264Sandreas.hansson@arm.com
74110457Sandreas.hansson@arm.com    # Make sure we warn if the user has requested to compile with the
74210457Sandreas.hansson@arm.com    # Undefined Benahvior Sanitizer and this version of gcc does not
74310457Sandreas.hansson@arm.com    # support it.
74410457Sandreas.hansson@arm.com    if GetOption('with_ubsan') and \
74510457Sandreas.hansson@arm.com            compareVersions(gcc_version, '4.9') < 0:
74610457Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + \
74710457Sandreas.hansson@arm.com            'Warning: UBSan is only supported using gcc 4.9 and later.' + \
74810457Sandreas.hansson@arm.com            termcap.Normal
74910457Sandreas.hansson@arm.com
75010238Sandreas.hansson@arm.com    # Add the appropriate Link-Time Optimization (LTO) flags
75110238Sandreas.hansson@arm.com    # unless LTO is explicitly turned off. Note that these flags
75210238Sandreas.hansson@arm.com    # are only used by the fast target.
75310238Sandreas.hansson@arm.com    if not GetOption('no_lto'):
75410238Sandreas.hansson@arm.com        # Pass the LTO flag when compiling to produce GIMPLE
75510238Sandreas.hansson@arm.com        # output, we merely create the flags here and only append
75610416Sandreas.hansson@arm.com        # them later
75710238Sandreas.hansson@arm.com        main['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
7589227Sandreas.hansson@arm.com
75910238Sandreas.hansson@arm.com        # Use the same amount of jobs for LTO as we are running
76010416Sandreas.hansson@arm.com        # scons with
76110416Sandreas.hansson@arm.com        main['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
7629227Sandreas.hansson@arm.com
7639590Sandreas@sandberg.pp.se    main.Append(TCMALLOC_CCFLAGS=['-fno-builtin-malloc', '-fno-builtin-calloc',
7649590Sandreas@sandberg.pp.se                                  '-fno-builtin-realloc', '-fno-builtin-free'])
7659590Sandreas@sandberg.pp.se
76611497SMatteo.Andreozzi@arm.com    # add option to check for undeclared overrides
76711497SMatteo.Andreozzi@arm.com    if compareVersions(gcc_version, "5.0") > 0:
76811497SMatteo.Andreozzi@arm.com        main.Append(CCFLAGS=['-Wno-error=suggest-override'])
76911497SMatteo.Andreozzi@arm.com
7708737Skoansin.tan@gmail.comelif main['CLANG']:
77110878Sandreas.hansson@arm.com    # Check for a supported version of clang, >= 3.1 is needed to
77211500Sandreas.hansson@arm.com    # support similar features as gcc 4.8. See
7739420Sandreas.hansson@arm.com    # http://clang.llvm.org/cxx_status.html for details
7748737Skoansin.tan@gmail.com    clang_version_re = re.compile(".* version (\d+\.\d+)")
77510106SMitch.Hayenga@arm.com    clang_version_match = clang_version_re.search(CXX_version)
7768737Skoansin.tan@gmail.com    if (clang_version_match):
7778737Skoansin.tan@gmail.com        clang_version = clang_version_match.groups()[0]
77810878Sandreas.hansson@arm.com        if compareVersions(clang_version, "3.1") < 0:
77910878Sandreas.hansson@arm.com            print 'Error: clang version 3.1 or newer required.'
7808737Skoansin.tan@gmail.com            print '       Installed version:', clang_version
7818737Skoansin.tan@gmail.com            Exit(1)
7828737Skoansin.tan@gmail.com    else:
7838737Skoansin.tan@gmail.com        print 'Error: Unable to determine clang version.'
7848737Skoansin.tan@gmail.com        Exit(1)
7858737Skoansin.tan@gmail.com
78611294Sandreas.hansson@arm.com    # clang has a few additional warnings that we disable, extraneous
7879556Sandreas.hansson@arm.com    # parantheses are allowed due to Ruby's printing of the AST,
7889556Sandreas.hansson@arm.com    # finally self assignments are allowed as the generated CPU code
7899556Sandreas.hansson@arm.com    # is relying on this
79011294Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-Wno-parentheses',
79110278SAndreas.Sandberg@ARM.com                         '-Wno-self-assign',
79210278SAndreas.Sandberg@ARM.com                         # Some versions of libstdc++ (4.8?) seem to
79310278SAndreas.Sandberg@ARM.com                         # use struct hash and class hash
79410278SAndreas.Sandberg@ARM.com                         # interchangeably.
79510278SAndreas.Sandberg@ARM.com                         '-Wno-mismatched-tags',
79610278SAndreas.Sandberg@ARM.com                         ])
7979556Sandreas.hansson@arm.com
7989590Sandreas@sandberg.pp.se    main.Append(TCMALLOC_CCFLAGS=['-fno-builtin'])
7999590Sandreas@sandberg.pp.se
8009420Sandreas.hansson@arm.com    # On Mac OS X/Darwin we need to also use libc++ (part of XCode) as
8019846Sandreas.hansson@arm.com    # opposed to libstdc++, as the later is dated.
8029846Sandreas.hansson@arm.com    if sys.platform == "darwin":
8039846Sandreas.hansson@arm.com        main.Append(CXXFLAGS=['-stdlib=libc++'])
8049846Sandreas.hansson@arm.com        main.Append(LIBS=['c++'])
8058946Sandreas.hansson@arm.com
80611811Sbaz21@cam.ac.uk    # On FreeBSD we need libthr.
80711811Sbaz21@cam.ac.uk    if sys.platform.startswith('freebsd'):
80811811Sbaz21@cam.ac.uk        main.Append(LIBS=['thr'])
80911811Sbaz21@cam.ac.uk
8103918Ssaidi@eecs.umich.eduelse:
8119068SAli.Saidi@ARM.com    print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal,
8129068SAli.Saidi@ARM.com    print "Don't know what compiler options to use for your compiler."
8139068SAli.Saidi@ARM.com    print termcap.Yellow + '       compiler:' + termcap.Normal, main['CXX']
8149068SAli.Saidi@ARM.com    print termcap.Yellow + '       version:' + termcap.Normal,
8159068SAli.Saidi@ARM.com    if not CXX_version:
8169068SAli.Saidi@ARM.com        print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\
8179068SAli.Saidi@ARM.com               termcap.Normal
8189068SAli.Saidi@ARM.com    else:
8199068SAli.Saidi@ARM.com        print CXX_version.replace('\n', '<nl>')
8209419Sandreas.hansson@arm.com    print "       If you're trying to use a compiler other than GCC"
8219068SAli.Saidi@ARM.com    print "       or clang, there appears to be something wrong with your"
8229068SAli.Saidi@ARM.com    print "       environment."
8239068SAli.Saidi@ARM.com    print "       "
8249068SAli.Saidi@ARM.com    print "       If you are trying to use a compiler other than those listed"
8259068SAli.Saidi@ARM.com    print "       above you will need to ease fix SConstruct and "
8269068SAli.Saidi@ARM.com    print "       src/SConscript to support that compiler."
8273918Ssaidi@eecs.umich.edu    Exit(1)
8283918Ssaidi@eecs.umich.edu
8296157Snate@binkert.org# Set up common yacc/bison flags (needed for Ruby)
8306157Snate@binkert.orgmain['YACCFLAGS'] = '-d'
8316157Snate@binkert.orgmain['YACCHXXFILESUFFIX'] = '.hh'
8326157Snate@binkert.org
8335397Ssaidi@eecs.umich.edu# Do this after we save setting back, or else we'll tack on an
8345397Ssaidi@eecs.umich.edu# extra 'qdo' every time we run scons.
8356121Snate@binkert.orgif main['BATCH']:
8366121Snate@binkert.org    main['CC']     = main['BATCH_CMD'] + ' ' + main['CC']
8376121Snate@binkert.org    main['CXX']    = main['BATCH_CMD'] + ' ' + main['CXX']
8386121Snate@binkert.org    main['AS']     = main['BATCH_CMD'] + ' ' + main['AS']
8396121Snate@binkert.org    main['AR']     = main['BATCH_CMD'] + ' ' + main['AR']
8406121Snate@binkert.org    main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB']
8415397Ssaidi@eecs.umich.edu
8421851SN/Aif sys.platform == 'cygwin':
8431851SN/A    # cygwin has some header file issues...
8447739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=["-Wno-uninitialized"])
845955SN/A
8469396Sandreas.hansson@arm.com# Check for the protobuf compiler
8479396Sandreas.hansson@arm.comprotoc_version = readCommand([main['PROTOC'], '--version'],
8489396Sandreas.hansson@arm.com                             exception='').split()
8499396Sandreas.hansson@arm.com
8509396Sandreas.hansson@arm.com# First two words should be "libprotoc x.y.z"
8519396Sandreas.hansson@arm.comif len(protoc_version) < 2 or protoc_version[0] != 'libprotoc':
8529396Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + \
8539396Sandreas.hansson@arm.com        'Warning: Protocol buffer compiler (protoc) not found.\n' + \
8549396Sandreas.hansson@arm.com        '         Please install protobuf-compiler for tracing support.' + \
8559396Sandreas.hansson@arm.com        termcap.Normal
8569396Sandreas.hansson@arm.com    main['PROTOC'] = False
8579396Sandreas.hansson@arm.comelse:
8589396Sandreas.hansson@arm.com    # Based on the availability of the compress stream wrappers,
8599396Sandreas.hansson@arm.com    # require 2.1.0
8609396Sandreas.hansson@arm.com    min_protoc_version = '2.1.0'
8619396Sandreas.hansson@arm.com    if compareVersions(protoc_version[1], min_protoc_version) < 0:
8629477Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + \
8639477Sandreas.hansson@arm.com            'Warning: protoc version', min_protoc_version, \
8649477Sandreas.hansson@arm.com            'or newer required.\n' + \
8659477Sandreas.hansson@arm.com            '         Installed version:', protoc_version[1], \
8669477Sandreas.hansson@arm.com            termcap.Normal
8679477Sandreas.hansson@arm.com        main['PROTOC'] = False
8689477Sandreas.hansson@arm.com    else:
8699477Sandreas.hansson@arm.com        # Attempt to determine the appropriate include path and
8709477Sandreas.hansson@arm.com        # library path using pkg-config, that means we also need to
8719477Sandreas.hansson@arm.com        # check for pkg-config. Note that it is possible to use
8729477Sandreas.hansson@arm.com        # protobuf without the involvement of pkg-config. Later on we
8739477Sandreas.hansson@arm.com        # check go a library config check and at that point the test
8749477Sandreas.hansson@arm.com        # will fail if libprotobuf cannot be found.
8759477Sandreas.hansson@arm.com        if readCommand(['pkg-config', '--version'], exception=''):
8769477Sandreas.hansson@arm.com            try:
8779477Sandreas.hansson@arm.com                # Attempt to establish what linking flags to add for protobuf
8789477Sandreas.hansson@arm.com                # using pkg-config
8799477Sandreas.hansson@arm.com                main.ParseConfig('pkg-config --cflags --libs-only-L protobuf')
8809477Sandreas.hansson@arm.com            except:
8819477Sandreas.hansson@arm.com                print termcap.Yellow + termcap.Bold + \
8829477Sandreas.hansson@arm.com                    'Warning: pkg-config could not get protobuf flags.' + \
8839477Sandreas.hansson@arm.com                    termcap.Normal
8849396Sandreas.hansson@arm.com
8853053Sstever@eecs.umich.edu# Check for SWIG
8866121Snate@binkert.orgif not main.has_key('SWIG'):
8873053Sstever@eecs.umich.edu    print 'Error: SWIG utility not found.'
8883053Sstever@eecs.umich.edu    print '       Please install (see http://www.swig.org) and retry.'
8893053Sstever@eecs.umich.edu    Exit(1)
8903053Sstever@eecs.umich.edu
8913053Sstever@eecs.umich.edu# Check for appropriate SWIG version
8929072Sandreas.hansson@arm.comswig_version = readCommand([main['SWIG'], '-version'], exception='').split()
8933053Sstever@eecs.umich.edu# First 3 words should be "SWIG Version x.y.z"
8944742Sstever@eecs.umich.eduif len(swig_version) < 3 or \
8954742Sstever@eecs.umich.edu        swig_version[0] != 'SWIG' or swig_version[1] != 'Version':
8963053Sstever@eecs.umich.edu    print 'Error determining SWIG version.'
8973053Sstever@eecs.umich.edu    Exit(1)
8983053Sstever@eecs.umich.edu
89910181SCurtis.Dunham@arm.commin_swig_version = '2.0.4'
9006654Snate@binkert.orgif compareVersions(swig_version[2], min_swig_version) < 0:
9013053Sstever@eecs.umich.edu    print 'Error: SWIG version', min_swig_version, 'or newer required.'
9023053Sstever@eecs.umich.edu    print '       Installed version:', swig_version[2]
9033053Sstever@eecs.umich.edu    Exit(1)
9043053Sstever@eecs.umich.edu
90510425Sandreas.hansson@arm.com# Check for known incompatibilities. The standard library shipped with
90610425Sandreas.hansson@arm.com# gcc >= 4.9 does not play well with swig versions prior to 3.0
90710425Sandreas.hansson@arm.comif main['GCC'] and compareVersions(gcc_version, '4.9') >= 0 and \
90810425Sandreas.hansson@arm.com        compareVersions(swig_version[2], '3.0') < 0:
90910425Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + \
91010425Sandreas.hansson@arm.com        'Warning: This combination of gcc and swig have' + \
91110425Sandreas.hansson@arm.com        ' known incompatibilities.\n' + \
91210425Sandreas.hansson@arm.com        '         If you encounter build problems, please update ' + \
91310425Sandreas.hansson@arm.com        'swig to 3.0 or later.' + \
91410425Sandreas.hansson@arm.com        termcap.Normal
91510425Sandreas.hansson@arm.com
9162667Sstever@eecs.umich.edu# Set up SWIG flags & scanner
9174554Sbinkertn@umich.eduswig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
9186121Snate@binkert.orgmain.Append(SWIGFLAGS=swig_flags)
9192667Sstever@eecs.umich.edu
92010710Sandreas.hansson@arm.com# Check for 'timeout' from GNU coreutils. If present, regressions will
92110710Sandreas.hansson@arm.com# be run with a time limit. We require version 8.13 since we rely on
92210710Sandreas.hansson@arm.com# support for the '--foreground' option.
92311811Sbaz21@cam.ac.ukif sys.platform.startswith('freebsd'):
92411811Sbaz21@cam.ac.uk    timeout_lines = readCommand(['gtimeout', '--version'],
92511811Sbaz21@cam.ac.uk                                exception='').splitlines()
92611811Sbaz21@cam.ac.ukelse:
92711811Sbaz21@cam.ac.uk    timeout_lines = readCommand(['timeout', '--version'],
92811811Sbaz21@cam.ac.uk                                exception='').splitlines()
92910710Sandreas.hansson@arm.com# Get the first line and tokenize it
93010710Sandreas.hansson@arm.comtimeout_version = timeout_lines[0].split() if timeout_lines else []
93110710Sandreas.hansson@arm.commain['TIMEOUT'] =  timeout_version and \
93210710Sandreas.hansson@arm.com    compareVersions(timeout_version[-1], '8.13') >= 0
93310384SCurtis.Dunham@arm.com
9344554Sbinkertn@umich.edu# filter out all existing swig scanners, they mess up the dependency
9354554Sbinkertn@umich.edu# stuff for some reason
9364554Sbinkertn@umich.eduscanners = []
9376121Snate@binkert.orgfor scanner in main['SCANNERS']:
9384554Sbinkertn@umich.edu    skeys = scanner.skeys
9394554Sbinkertn@umich.edu    if skeys == '.i':
9404554Sbinkertn@umich.edu        continue
9414781Snate@binkert.org
9424554Sbinkertn@umich.edu    if isinstance(skeys, (list, tuple)) and '.i' in skeys:
9434554Sbinkertn@umich.edu        continue
9442667Sstever@eecs.umich.edu
9454554Sbinkertn@umich.edu    scanners.append(scanner)
9464554Sbinkertn@umich.edu
9474554Sbinkertn@umich.edu# add the new swig scanner that we like better
9484554Sbinkertn@umich.edufrom SCons.Scanner import ClassicCPP as CPPScanner
9492667Sstever@eecs.umich.eduswig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
9504554Sbinkertn@umich.eduscanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re))
9512667Sstever@eecs.umich.edu
9524554Sbinkertn@umich.edu# replace the scanners list that has what we want
9536121Snate@binkert.orgmain['SCANNERS'] = scanners
9542667Sstever@eecs.umich.edu
9559986Sandreas@sandberg.pp.se# Add a custom Check function to test for structure members.
9569986Sandreas@sandberg.pp.sedef CheckMember(context, include, decl, member, include_quotes="<>"):
9579986Sandreas@sandberg.pp.se    context.Message("Checking for member %s in %s..." %
9589986Sandreas@sandberg.pp.se                    (member, decl))
9599986Sandreas@sandberg.pp.se    text = """
9609986Sandreas@sandberg.pp.se#include %(header)s
9619986Sandreas@sandberg.pp.seint main(){
9629986Sandreas@sandberg.pp.se  %(decl)s test;
9639986Sandreas@sandberg.pp.se  (void)test.%(member)s;
9649986Sandreas@sandberg.pp.se  return 0;
9659986Sandreas@sandberg.pp.se};
9669986Sandreas@sandberg.pp.se""" % { "header" : include_quotes[0] + include + include_quotes[1],
9679986Sandreas@sandberg.pp.se        "decl" : decl,
9689986Sandreas@sandberg.pp.se        "member" : member,
9699986Sandreas@sandberg.pp.se        }
9709986Sandreas@sandberg.pp.se
9719986Sandreas@sandberg.pp.se    ret = context.TryCompile(text, extension=".cc")
9729986Sandreas@sandberg.pp.se    context.Result(ret)
9739986Sandreas@sandberg.pp.se    return ret
9749986Sandreas@sandberg.pp.se
9752638Sstever@eecs.umich.edu# Platform-specific configuration.  Note again that we assume that all
9762638Sstever@eecs.umich.edu# builds under a given build root run on the same host platform.
9776121Snate@binkert.orgconf = Configure(main,
9783716Sstever@eecs.umich.edu                 conf_dir = joinpath(build_root, '.scons_config'),
9795522Snate@binkert.org                 log_file = joinpath(build_root, 'scons_config.log'),
9809986Sandreas@sandberg.pp.se                 custom_tests = {
9819986Sandreas@sandberg.pp.se        'CheckMember' : CheckMember,
9829986Sandreas@sandberg.pp.se        })
9835522Snate@binkert.org
9845227Ssaidi@eecs.umich.edu# Check if we should compile a 64 bit binary on Mac OS X/Darwin
9855227Ssaidi@eecs.umich.edutry:
9865227Ssaidi@eecs.umich.edu    import platform
9875227Ssaidi@eecs.umich.edu    uname = platform.uname()
9886654Snate@binkert.org    if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0:
9896654Snate@binkert.org        if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
9907769SAli.Saidi@ARM.com            main.Append(CCFLAGS=['-arch', 'x86_64'])
9917769SAli.Saidi@ARM.com            main.Append(CFLAGS=['-arch', 'x86_64'])
9927769SAli.Saidi@ARM.com            main.Append(LINKFLAGS=['-arch', 'x86_64'])
9937769SAli.Saidi@ARM.com            main.Append(ASFLAGS=['-arch', 'x86_64'])
9945227Ssaidi@eecs.umich.eduexcept:
9955227Ssaidi@eecs.umich.edu    pass
9965227Ssaidi@eecs.umich.edu
9975204Sstever@gmail.com# Recent versions of scons substitute a "Null" object for Configure()
9985204Sstever@gmail.com# when configuration isn't necessary, e.g., if the "--help" option is
9995204Sstever@gmail.com# present.  Unfortuantely this Null object always returns false,
10005204Sstever@gmail.com# breaking all our configuration checks.  We replace it with our own
10015204Sstever@gmail.com# more optimistic null object that returns True instead.
10025204Sstever@gmail.comif not conf:
10035204Sstever@gmail.com    def NullCheck(*args, **kwargs):
10045204Sstever@gmail.com        return True
10055204Sstever@gmail.com
10065204Sstever@gmail.com    class NullConf:
10075204Sstever@gmail.com        def __init__(self, env):
10085204Sstever@gmail.com            self.env = env
10095204Sstever@gmail.com        def Finish(self):
10105204Sstever@gmail.com            return self.env
10115204Sstever@gmail.com        def __getattr__(self, mname):
10125204Sstever@gmail.com            return NullCheck
10135204Sstever@gmail.com
10146121Snate@binkert.org    conf = NullConf(main)
10155204Sstever@gmail.com
10167727SAli.Saidi@ARM.com# Cache build files in the supplied directory.
10177727SAli.Saidi@ARM.comif main['M5_BUILD_CACHE']:
10187727SAli.Saidi@ARM.com    print 'Using build cache located at', main['M5_BUILD_CACHE']
10197727SAli.Saidi@ARM.com    CacheDir(main['M5_BUILD_CACHE'])
10207727SAli.Saidi@ARM.com
102110453SAndrew.Bardsley@arm.comif not GetOption('without_python'):
102210453SAndrew.Bardsley@arm.com    # Find Python include and library directories for embedding the
102310453SAndrew.Bardsley@arm.com    # interpreter. We rely on python-config to resolve the appropriate
102410453SAndrew.Bardsley@arm.com    # includes and linker flags. ParseConfig does not seem to understand
102510453SAndrew.Bardsley@arm.com    # the more exotic linker flags such as -Xlinker and -export-dynamic so
102610453SAndrew.Bardsley@arm.com    # we add them explicitly below. If you want to link in an alternate
102710453SAndrew.Bardsley@arm.com    # version of python, see above for instructions on how to invoke
102810453SAndrew.Bardsley@arm.com    # scons with the appropriate PATH set.
102910453SAndrew.Bardsley@arm.com    #
103010453SAndrew.Bardsley@arm.com    # First we check if python2-config exists, else we use python-config
103110453SAndrew.Bardsley@arm.com    python_config = readCommand(['which', 'python2-config'],
103210160Sandreas.hansson@arm.com                                exception='').strip()
103310453SAndrew.Bardsley@arm.com    if not os.path.exists(python_config):
103410453SAndrew.Bardsley@arm.com        python_config = readCommand(['which', 'python-config'],
103510453SAndrew.Bardsley@arm.com                                    exception='').strip()
103610453SAndrew.Bardsley@arm.com    py_includes = readCommand([python_config, '--includes'],
103710453SAndrew.Bardsley@arm.com                              exception='').split()
103810453SAndrew.Bardsley@arm.com    # Strip the -I from the include folders before adding them to the
103910453SAndrew.Bardsley@arm.com    # CPPPATH
104010453SAndrew.Bardsley@arm.com    main.Append(CPPPATH=map(lambda inc: inc[2:], py_includes))
10419812Sandreas.hansson@arm.com
104210453SAndrew.Bardsley@arm.com    # Read the linker flags and split them into libraries and other link
104310453SAndrew.Bardsley@arm.com    # flags. The libraries are added later through the call the CheckLib.
104410453SAndrew.Bardsley@arm.com    py_ld_flags = readCommand([python_config, '--ldflags'],
104510453SAndrew.Bardsley@arm.com        exception='').split()
104610453SAndrew.Bardsley@arm.com    py_libs = []
104710453SAndrew.Bardsley@arm.com    for lib in py_ld_flags:
104810453SAndrew.Bardsley@arm.com         if not lib.startswith('-l'):
104910453SAndrew.Bardsley@arm.com             main.Append(LINKFLAGS=[lib])
105010453SAndrew.Bardsley@arm.com         else:
105110453SAndrew.Bardsley@arm.com             lib = lib[2:]
105210453SAndrew.Bardsley@arm.com             if lib not in py_libs:
105310453SAndrew.Bardsley@arm.com                 py_libs.append(lib)
10547727SAli.Saidi@ARM.com
105510453SAndrew.Bardsley@arm.com    # verify that this stuff works
105610453SAndrew.Bardsley@arm.com    if not conf.CheckHeader('Python.h', '<>'):
105710453SAndrew.Bardsley@arm.com        print "Error: can't find Python.h header in", py_includes
105810453SAndrew.Bardsley@arm.com        print "Install Python headers (package python-dev on Ubuntu and RedHat)"
105910453SAndrew.Bardsley@arm.com        Exit(1)
10603118Sstever@eecs.umich.edu
106110453SAndrew.Bardsley@arm.com    for lib in py_libs:
106210453SAndrew.Bardsley@arm.com        if not conf.CheckLib(lib):
106310453SAndrew.Bardsley@arm.com            print "Error: can't find library %s required by python" % lib
106410453SAndrew.Bardsley@arm.com            Exit(1)
10653118Sstever@eecs.umich.edu
10663483Ssaidi@eecs.umich.edu# On Solaris you need to use libsocket for socket ops
10673494Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
10683494Ssaidi@eecs.umich.edu   if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
10693483Ssaidi@eecs.umich.edu       print "Can't find library with socket calls (e.g. accept())"
10703483Ssaidi@eecs.umich.edu       Exit(1)
10713483Ssaidi@eecs.umich.edu
10723053Sstever@eecs.umich.edu# Check for zlib.  If the check passes, libz will be automatically
10733053Sstever@eecs.umich.edu# added to the LIBS environment variable.
10743918Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
10753053Sstever@eecs.umich.edu    print 'Error: did not find needed zlib compression library '\
10763053Sstever@eecs.umich.edu          'and/or zlib.h header file.'
10773053Sstever@eecs.umich.edu    print '       Please install zlib and try again.'
10783053Sstever@eecs.umich.edu    Exit(1)
10793053Sstever@eecs.umich.edu
10809396Sandreas.hansson@arm.com# If we have the protobuf compiler, also make sure we have the
10819396Sandreas.hansson@arm.com# development libraries. If the check passes, libprotobuf will be
10829396Sandreas.hansson@arm.com# automatically added to the LIBS environment variable. After
10839396Sandreas.hansson@arm.com# this, we can use the HAVE_PROTOBUF flag to determine if we have
10849396Sandreas.hansson@arm.com# got both protoc and libprotobuf available.
10859396Sandreas.hansson@arm.commain['HAVE_PROTOBUF'] = main['PROTOC'] and \
10869396Sandreas.hansson@arm.com    conf.CheckLibWithHeader('protobuf', 'google/protobuf/message.h',
10879396Sandreas.hansson@arm.com                            'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;')
10889396Sandreas.hansson@arm.com
10899477Sandreas.hansson@arm.com# If we have the compiler but not the library, print another warning.
10909396Sandreas.hansson@arm.comif main['PROTOC'] and not main['HAVE_PROTOBUF']:
10919477Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + \
10929477Sandreas.hansson@arm.com        'Warning: did not find protocol buffer library and/or headers.\n' + \
10939477Sandreas.hansson@arm.com    '       Please install libprotobuf-dev for tracing support.' + \
10949477Sandreas.hansson@arm.com    termcap.Normal
10959396Sandreas.hansson@arm.com
10967840Snate@binkert.org# Check for librt.
10977865Sgblack@eecs.umich.eduhave_posix_clock = \
10987865Sgblack@eecs.umich.edu    conf.CheckLibWithHeader(None, 'time.h', 'C',
10997865Sgblack@eecs.umich.edu                            'clock_nanosleep(0,0,NULL,NULL);') or \
11007865Sgblack@eecs.umich.edu    conf.CheckLibWithHeader('rt', 'time.h', 'C',
11017865Sgblack@eecs.umich.edu                            'clock_nanosleep(0,0,NULL,NULL);')
11027840Snate@binkert.org
11039900Sandreas@sandberg.pp.sehave_posix_timers = \
11049900Sandreas@sandberg.pp.se    conf.CheckLibWithHeader([None, 'rt'], [ 'time.h', 'signal.h' ], 'C',
11059900Sandreas@sandberg.pp.se                            'timer_create(CLOCK_MONOTONIC, NULL, NULL);')
11069900Sandreas@sandberg.pp.se
110710456SCurtis.Dunham@arm.comif not GetOption('without_tcmalloc'):
110810456SCurtis.Dunham@arm.com    if conf.CheckLib('tcmalloc'):
110910456SCurtis.Dunham@arm.com        main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS'])
111010456SCurtis.Dunham@arm.com    elif conf.CheckLib('tcmalloc_minimal'):
111110456SCurtis.Dunham@arm.com        main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS'])
111210456SCurtis.Dunham@arm.com    else:
111310456SCurtis.Dunham@arm.com        print termcap.Yellow + termcap.Bold + \
111410456SCurtis.Dunham@arm.com              "You can get a 12% performance improvement by "\
111510456SCurtis.Dunham@arm.com              "installing tcmalloc (libgoogle-perftools-dev package "\
111610456SCurtis.Dunham@arm.com              "on Ubuntu or RedHat)." + termcap.Normal
11179045SAli.Saidi@ARM.com
111811235Sandreas.sandberg@arm.com
111911235Sandreas.sandberg@arm.com# Detect back trace implementations. The last implementation in the
112011235Sandreas.sandberg@arm.com# list will be used by default.
112111235Sandreas.sandberg@arm.combacktrace_impls = [ "none" ]
112211235Sandreas.sandberg@arm.com
112311235Sandreas.sandberg@arm.comif conf.CheckLibWithHeader(None, 'execinfo.h', 'C',
112411235Sandreas.sandberg@arm.com                           'backtrace_symbols_fd((void*)0, 0, 0);'):
112511235Sandreas.sandberg@arm.com    backtrace_impls.append("glibc")
112611811Sbaz21@cam.ac.ukelif conf.CheckLibWithHeader('execinfo', 'execinfo.h', 'C',
112711811Sbaz21@cam.ac.uk                           'backtrace_symbols_fd((void*)0, 0, 0);'):
112811811Sbaz21@cam.ac.uk    # NetBSD and FreeBSD need libexecinfo.
112911811Sbaz21@cam.ac.uk    backtrace_impls.append("glibc")
113011811Sbaz21@cam.ac.uk    main.Append(LIBS=['execinfo'])
113111235Sandreas.sandberg@arm.com
113211235Sandreas.sandberg@arm.comif backtrace_impls[-1] == "none":
113311235Sandreas.sandberg@arm.com    default_backtrace_impl = "none"
113411235Sandreas.sandberg@arm.com    print termcap.Yellow + termcap.Bold + \
113511235Sandreas.sandberg@arm.com        "No suitable back trace implementation found." + \
113611235Sandreas.sandberg@arm.com        termcap.Normal
113711235Sandreas.sandberg@arm.com
11387840Snate@binkert.orgif not have_posix_clock:
11397840Snate@binkert.org    print "Can't find library for POSIX clocks."
11407840Snate@binkert.org
11411858SN/A# Check for <fenv.h> (C99 FP environment control)
11421858SN/Ahave_fenv = conf.CheckHeader('fenv.h', '<>')
11431858SN/Aif not have_fenv:
11441858SN/A    print "Warning: Header file <fenv.h> not found."
11451858SN/A    print "         This host has no IEEE FP rounding mode control."
11461858SN/A
11479903Sandreas.hansson@arm.com# Check if we should enable KVM-based hardware virtualization. The API
11489903Sandreas.hansson@arm.com# we rely on exists since version 2.6.36 of the kernel, but somehow
11499903Sandreas.hansson@arm.com# the KVM_API_VERSION does not reflect the change. We test for one of
11509903Sandreas.hansson@arm.com# the types as a fall back.
115110841Sandreas.sandberg@arm.comhave_kvm = conf.CheckHeader('linux/kvm.h', '<>')
11529651SAndreas.Sandberg@ARM.comif not have_kvm:
11539903Sandreas.hansson@arm.com    print "Info: Compatible header file <linux/kvm.h> not found, " \
11549651SAndreas.Sandberg@ARM.com        "disabling KVM support."
11559651SAndreas.Sandberg@ARM.com
115610841Sandreas.sandberg@arm.com# x86 needs support for xsave. We test for the structure here since we
115710841Sandreas.sandberg@arm.com# won't be able to run new tests by the time we know which ISA we're
115810841Sandreas.sandberg@arm.com# targeting.
115910841Sandreas.sandberg@arm.comhave_kvm_xsave = conf.CheckTypeSize('struct kvm_xsave',
116010841Sandreas.sandberg@arm.com                                    '#include <linux/kvm.h>') != 0
116110841Sandreas.sandberg@arm.com
11629651SAndreas.Sandberg@ARM.com# Check if the requested target ISA is compatible with the host
11639651SAndreas.Sandberg@ARM.comdef is_isa_kvm_compatible(isa):
11649651SAndreas.Sandberg@ARM.com    try:
11659651SAndreas.Sandberg@ARM.com        import platform
11669651SAndreas.Sandberg@ARM.com        host_isa = platform.machine()
11679651SAndreas.Sandberg@ARM.com    except:
11689651SAndreas.Sandberg@ARM.com        print "Warning: Failed to determine host ISA."
11699651SAndreas.Sandberg@ARM.com        return False
11709651SAndreas.Sandberg@ARM.com
117110841Sandreas.sandberg@arm.com    if not have_posix_timers:
117210841Sandreas.sandberg@arm.com        print "Warning: Can not enable KVM, host seems to lack support " \
117310841Sandreas.sandberg@arm.com            "for POSIX timers"
117410841Sandreas.sandberg@arm.com        return False
117510841Sandreas.sandberg@arm.com
117610841Sandreas.sandberg@arm.com    if isa == "arm":
117710860Sandreas.sandberg@arm.com        return host_isa in ( "armv7l", "aarch64" )
117810841Sandreas.sandberg@arm.com    elif isa == "x86":
117910841Sandreas.sandberg@arm.com        if host_isa != "x86_64":
118010841Sandreas.sandberg@arm.com            return False
118110841Sandreas.sandberg@arm.com
118210841Sandreas.sandberg@arm.com        if not have_kvm_xsave:
118310841Sandreas.sandberg@arm.com            print "KVM on x86 requires xsave support in kernel headers."
118410841Sandreas.sandberg@arm.com            return False
118510841Sandreas.sandberg@arm.com
118610841Sandreas.sandberg@arm.com        return True
118710841Sandreas.sandberg@arm.com    else:
118810841Sandreas.sandberg@arm.com        return False
11899651SAndreas.Sandberg@ARM.com
11909651SAndreas.Sandberg@ARM.com
11919986Sandreas@sandberg.pp.se# Check if the exclude_host attribute is available. We want this to
11929986Sandreas@sandberg.pp.se# get accurate instruction counts in KVM.
11939986Sandreas@sandberg.pp.semain['HAVE_PERF_ATTR_EXCLUDE_HOST'] = conf.CheckMember(
11949986Sandreas@sandberg.pp.se    'linux/perf_event.h', 'struct perf_event_attr', 'exclude_host')
11959986Sandreas@sandberg.pp.se
11969986Sandreas@sandberg.pp.se
11975863Snate@binkert.org######################################################################
11985863Snate@binkert.org#
11995863Snate@binkert.org# Finish the configuration
12005863Snate@binkert.org#
12016121Snate@binkert.orgmain = conf.Finish()
12021858SN/A
12035863Snate@binkert.org######################################################################
12045863Snate@binkert.org#
12055863Snate@binkert.org# Collect all non-global variables
12065863Snate@binkert.org#
12075863Snate@binkert.org
12082139SN/A# Define the universe of supported ISAs
12094202Sbinkertn@umich.eduall_isa_list = [ ]
121011308Santhony.gutierrez@amd.comall_gpu_isa_list = [ ]
12114202Sbinkertn@umich.eduExport('all_isa_list')
121211308Santhony.gutierrez@amd.comExport('all_gpu_isa_list')
12132139SN/A
12146994Snate@binkert.orgclass CpuModel(object):
12156994Snate@binkert.org    '''The CpuModel class encapsulates everything the ISA parser needs to
12166994Snate@binkert.org    know about a particular CPU model.'''
12176994Snate@binkert.org
12186994Snate@binkert.org    # Dict of available CPU model objects.  Accessible as CpuModel.dict.
12196994Snate@binkert.org    dict = {}
12206994Snate@binkert.org
12216994Snate@binkert.org    # Constructor.  Automatically adds models to CpuModel.dict.
122210319SAndreas.Sandberg@ARM.com    def __init__(self, name, default=False):
12236994Snate@binkert.org        self.name = name           # name of model
12246994Snate@binkert.org
12256994Snate@binkert.org        # This cpu is enabled by default
12266994Snate@binkert.org        self.default = default
12276994Snate@binkert.org
12286994Snate@binkert.org        # Add self to dict
12296994Snate@binkert.org        if name in CpuModel.dict:
12306994Snate@binkert.org            raise AttributeError, "CpuModel '%s' already registered" % name
12316994Snate@binkert.org        CpuModel.dict[name] = self
12326994Snate@binkert.org
12336994Snate@binkert.orgExport('CpuModel')
12342155SN/A
12355863Snate@binkert.org# Sticky variables get saved in the variables file so they persist from
12361869SN/A# one invocation to the next (unless overridden, in which case the new
12371869SN/A# value becomes sticky).
12385863Snate@binkert.orgsticky_vars = Variables(args=ARGUMENTS)
12395863Snate@binkert.orgExport('sticky_vars')
12404202Sbinkertn@umich.edu
12416108Snate@binkert.org# Sticky variables that should be exported
12426108Snate@binkert.orgexport_vars = []
12436108Snate@binkert.orgExport('export_vars')
12446108Snate@binkert.org
12459219Spower.jg@gmail.com# For Ruby
12469219Spower.jg@gmail.comall_protocols = []
12479219Spower.jg@gmail.comExport('all_protocols')
12489219Spower.jg@gmail.comprotocol_dirs = []
12499219Spower.jg@gmail.comExport('protocol_dirs')
12509219Spower.jg@gmail.comslicc_includes = []
12519219Spower.jg@gmail.comExport('slicc_includes')
12529219Spower.jg@gmail.com
12534202Sbinkertn@umich.edu# Walk the tree and execute all SConsopts scripts that wil add to the
12545863Snate@binkert.org# above variables
125510135SCurtis.Dunham@arm.comif GetOption('verbose'):
12568474Sgblack@eecs.umich.edu    print "Reading SConsopts"
12575742Snate@binkert.orgfor bdir in [ base_dir ] + extras_dir_list:
12588268Ssteve.reinhardt@amd.com    if not isdir(bdir):
12598268Ssteve.reinhardt@amd.com        print "Error: directory '%s' does not exist" % bdir
12608268Ssteve.reinhardt@amd.com        Exit(1)
12615742Snate@binkert.org    for root, dirs, files in os.walk(bdir):
12625341Sstever@gmail.com        if 'SConsopts' in files:
12638474Sgblack@eecs.umich.edu            if GetOption('verbose'):
12648474Sgblack@eecs.umich.edu                print "Reading", joinpath(root, 'SConsopts')
12655342Sstever@gmail.com            SConscript(joinpath(root, 'SConsopts'))
12664202Sbinkertn@umich.edu
12674202Sbinkertn@umich.eduall_isa_list.sort()
126811308Santhony.gutierrez@amd.comall_gpu_isa_list.sort()
12694202Sbinkertn@umich.edu
12705863Snate@binkert.orgsticky_vars.AddVariables(
12715863Snate@binkert.org    EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list),
127211308Santhony.gutierrez@amd.com    EnumVariable('TARGET_GPU_ISA', 'Target GPU ISA', 'hsail', all_gpu_isa_list),
12736994Snate@binkert.org    ListVariable('CPU_MODELS', 'CPU models',
12746994Snate@binkert.org                 sorted(n for n,m in CpuModel.dict.iteritems() if m.default),
127510319SAndreas.Sandberg@ARM.com                 sorted(CpuModel.dict.keys())),
12765863Snate@binkert.org    BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
12775863Snate@binkert.org                 False),
12785863Snate@binkert.org    BoolVariable('SS_COMPATIBLE_FP',
12795863Snate@binkert.org                 'Make floating-point results compatible with SimpleScalar',
12805863Snate@binkert.org                 False),
12815863Snate@binkert.org    BoolVariable('USE_SSE2',
12825863Snate@binkert.org                 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
12835863Snate@binkert.org                 False),
12847840Snate@binkert.org    BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock),
12855863Snate@binkert.org    BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
12865952Ssaidi@eecs.umich.edu    BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False),
12879651SAndreas.Sandberg@ARM.com    BoolVariable('USE_KVM', 'Enable hardware virtualized (KVM) CPU models', have_kvm),
128811308Santhony.gutierrez@amd.com    BoolVariable('BUILD_GPU', 'Build the compute-GPU model', False),
12899219Spower.jg@gmail.com    EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None',
12909219Spower.jg@gmail.com                  all_protocols),
129111235Sandreas.sandberg@arm.com    EnumVariable('BACKTRACE_IMPL', 'Post-mortem dump implementation',
129211235Sandreas.sandberg@arm.com                 backtrace_impls[-1], backtrace_impls)
12931869SN/A    )
12941858SN/A
12955863Snate@binkert.org# These variables get exported to #defines in config/*.hh (see src/SConscript).
129611308Santhony.gutierrez@amd.comexport_vars += ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'TARGET_GPU_ISA',
129711308Santhony.gutierrez@amd.com                'CP_ANNOTATE', 'USE_POSIX_CLOCK', 'USE_KVM', 'PROTOCOL',
129811308Santhony.gutierrez@amd.com                'HAVE_PROTOBUF', 'HAVE_PERF_ATTR_EXCLUDE_HOST']
12991858SN/A
1300955SN/A###################################################
1301955SN/A#
13021869SN/A# Define a SCons builder for configuration flag headers.
13031869SN/A#
13041869SN/A###################################################
13051869SN/A
13061869SN/A# This function generates a config header file that #defines the
13075863Snate@binkert.org# variable symbol to the current variable setting (0 or 1).  The source
13085863Snate@binkert.org# operands are the name of the variable and a Value node containing the
13095863Snate@binkert.org# value of the variable.
13101869SN/Adef build_config_file(target, source, env):
13115863Snate@binkert.org    (variable, value) = [s.get_contents() for s in source]
13121869SN/A    f = file(str(target[0]), 'w')
13135863Snate@binkert.org    print >> f, '#define', variable, value
13141869SN/A    f.close()
13151869SN/A    return None
13161869SN/A
13171869SN/A# Combine the two functions into a scons Action object.
13188483Sgblack@eecs.umich.educonfig_action = MakeAction(build_config_file, Transform("CONFIG H", 2))
13191869SN/A
13201869SN/A# The emitter munges the source & target node lists to reflect what
13211869SN/A# we're really doing.
13221869SN/Adef config_emitter(target, source, env):
13235863Snate@binkert.org    # extract variable name from Builder arg
13245863Snate@binkert.org    variable = str(target[0])
13251869SN/A    # True target is config header file
13265863Snate@binkert.org    target = joinpath('config', variable.lower() + '.hh')
13275863Snate@binkert.org    val = env[variable]
13283356Sbinkertn@umich.edu    if isinstance(val, bool):
13293356Sbinkertn@umich.edu        # Force value to 0/1
13303356Sbinkertn@umich.edu        val = int(val)
13313356Sbinkertn@umich.edu    elif isinstance(val, str):
13323356Sbinkertn@umich.edu        val = '"' + val + '"'
13334781Snate@binkert.org
13345863Snate@binkert.org    # Sources are variable name & value (packaged in SCons Value nodes)
13355863Snate@binkert.org    return ([target], [Value(variable), Value(val)])
13361869SN/A
13371869SN/Aconfig_builder = Builder(emitter = config_emitter, action = config_action)
13381869SN/A
13396121Snate@binkert.orgmain.Append(BUILDERS = { 'ConfigFile' : config_builder })
13401869SN/A
13412638Sstever@eecs.umich.edu# libelf build is shared across all configs in the build root.
13426121Snate@binkert.orgmain.SConscript('ext/libelf/SConscript',
13436121Snate@binkert.org                variant_dir = joinpath(build_root, 'libelf'))
13442638Sstever@eecs.umich.edu
134511293Sandreas.hansson@arm.com# iostream3 build is shared across all configs in the build root.
134611293Sandreas.hansson@arm.commain.SConscript('ext/iostream3/SConscript',
134711293Sandreas.hansson@arm.com                variant_dir = joinpath(build_root, 'iostream3'))
13485749Scws3k@cs.virginia.edu
13499537Satgutier@umich.edu# libfdt build is shared across all configs in the build root.
13509537Satgutier@umich.edumain.SConscript('ext/libfdt/SConscript',
13519537Satgutier@umich.edu                variant_dir = joinpath(build_root, 'libfdt'))
13529537Satgutier@umich.edu
13539888Sandreas@sandberg.pp.se# fputils build is shared across all configs in the build root.
13549888Sandreas@sandberg.pp.semain.SConscript('ext/fputils/SConscript',
13559888Sandreas@sandberg.pp.se                variant_dir = joinpath(build_root, 'fputils'))
13569888Sandreas@sandberg.pp.se
135710066Sandreas.hansson@arm.com# DRAMSim2 build is shared across all configs in the build root.
135810066Sandreas.hansson@arm.commain.SConscript('ext/dramsim2/SConscript',
135910066Sandreas.hansson@arm.com                variant_dir = joinpath(build_root, 'dramsim2'))
136010066Sandreas.hansson@arm.com
136110428Sandreas.hansson@arm.com# DRAMPower build is shared across all configs in the build root.
136210428Sandreas.hansson@arm.commain.SConscript('ext/drampower/SConscript',
136310428Sandreas.hansson@arm.com                variant_dir = joinpath(build_root, 'drampower'))
136410428Sandreas.hansson@arm.com
136510915Sandreas.sandberg@arm.com# nomali build is shared across all configs in the build root.
136610915Sandreas.sandberg@arm.commain.SConscript('ext/nomali/SConscript',
136710915Sandreas.sandberg@arm.com                variant_dir = joinpath(build_root, 'nomali'))
136810915Sandreas.sandberg@arm.com
13691869SN/A###################################################
13701869SN/A#
13713546Sgblack@eecs.umich.edu# This function is used to set up a directory with switching headers
13723546Sgblack@eecs.umich.edu#
13733546Sgblack@eecs.umich.edu###################################################
13743546Sgblack@eecs.umich.edu
13756121Snate@binkert.orgmain['ALL_ISA_LIST'] = all_isa_list
137611308Santhony.gutierrez@amd.commain['ALL_GPU_ISA_LIST'] = all_gpu_isa_list
137710196SCurtis.Dunham@arm.comall_isa_deps = {}
13785863Snate@binkert.orgdef make_switching_dir(dname, switch_headers, env):
13793546Sgblack@eecs.umich.edu    # Generate the header.  target[0] is the full path of the output
13803546Sgblack@eecs.umich.edu    # header to generate.  'source' is a dummy variable, since we get the
13813546Sgblack@eecs.umich.edu    # list of ISAs from env['ALL_ISA_LIST'].
13823546Sgblack@eecs.umich.edu    def gen_switch_hdr(target, source, env):
13834781Snate@binkert.org        fname = str(target[0])
13846658Snate@binkert.org        isa = env['TARGET_ISA'].lower()
138510196SCurtis.Dunham@arm.com        try:
138610196SCurtis.Dunham@arm.com            f = open(fname, 'w')
138710196SCurtis.Dunham@arm.com            print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname))
138810196SCurtis.Dunham@arm.com            f.close()
138910196SCurtis.Dunham@arm.com        except IOError:
139010196SCurtis.Dunham@arm.com            print "Failed to create %s" % fname
139110196SCurtis.Dunham@arm.com            raise
13923546Sgblack@eecs.umich.edu
13933546Sgblack@eecs.umich.edu    # Build SCons Action object. 'varlist' specifies env vars that this
13943546Sgblack@eecs.umich.edu    # action depends on; when env['ALL_ISA_LIST'] changes these actions
13953546Sgblack@eecs.umich.edu    # should get re-executed.
13967756SAli.Saidi@ARM.com    switch_hdr_action = MakeAction(gen_switch_hdr,
13977816Ssteve.reinhardt@amd.com                          Transform("GENERATE"), varlist=['ALL_ISA_LIST'])
13983546Sgblack@eecs.umich.edu
13993546Sgblack@eecs.umich.edu    # Instantiate actions for each header
14003546Sgblack@eecs.umich.edu    for hdr in switch_headers:
14013546Sgblack@eecs.umich.edu        env.Command(hdr, [], switch_hdr_action)
140210196SCurtis.Dunham@arm.com
140310196SCurtis.Dunham@arm.com    isa_target = Dir('.').up().name.lower().replace('_', '-')
140410196SCurtis.Dunham@arm.com    env['PHONY_BASE'] = '#'+isa_target
140510196SCurtis.Dunham@arm.com    all_isa_deps[isa_target] = None
140610196SCurtis.Dunham@arm.com
14074202Sbinkertn@umich.eduExport('make_switching_dir')
14083546Sgblack@eecs.umich.edu
140911308Santhony.gutierrez@amd.comdef make_gpu_switching_dir(dname, switch_headers, env):
141011308Santhony.gutierrez@amd.com    # Generate the header.  target[0] is the full path of the output
141111308Santhony.gutierrez@amd.com    # header to generate.  'source' is a dummy variable, since we get the
141211308Santhony.gutierrez@amd.com    # list of ISAs from env['ALL_ISA_LIST'].
141311308Santhony.gutierrez@amd.com    def gen_switch_hdr(target, source, env):
141411308Santhony.gutierrez@amd.com        fname = str(target[0])
141511308Santhony.gutierrez@amd.com
141611308Santhony.gutierrez@amd.com        isa = env['TARGET_GPU_ISA'].lower()
141711308Santhony.gutierrez@amd.com
141811308Santhony.gutierrez@amd.com        try:
141911308Santhony.gutierrez@amd.com            f = open(fname, 'w')
142011308Santhony.gutierrez@amd.com            print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname))
142111308Santhony.gutierrez@amd.com            f.close()
142211308Santhony.gutierrez@amd.com        except IOError:
142311308Santhony.gutierrez@amd.com            print "Failed to create %s" % fname
142411308Santhony.gutierrez@amd.com            raise
142511308Santhony.gutierrez@amd.com
142611308Santhony.gutierrez@amd.com    # Build SCons Action object. 'varlist' specifies env vars that this
142711308Santhony.gutierrez@amd.com    # action depends on; when env['ALL_ISA_LIST'] changes these actions
142811308Santhony.gutierrez@amd.com    # should get re-executed.
142911308Santhony.gutierrez@amd.com    switch_hdr_action = MakeAction(gen_switch_hdr,
143011308Santhony.gutierrez@amd.com                          Transform("GENERATE"), varlist=['ALL_ISA_GPU_LIST'])
143111308Santhony.gutierrez@amd.com
143211308Santhony.gutierrez@amd.com    # Instantiate actions for each header
143311308Santhony.gutierrez@amd.com    for hdr in switch_headers:
143411308Santhony.gutierrez@amd.com        env.Command(hdr, [], switch_hdr_action)
143511308Santhony.gutierrez@amd.com
143611308Santhony.gutierrez@amd.comExport('make_gpu_switching_dir')
143711308Santhony.gutierrez@amd.com
143810196SCurtis.Dunham@arm.com# all-isas -> all-deps -> all-environs -> all_targets
143910196SCurtis.Dunham@arm.commain.Alias('#all-isas', [])
144010196SCurtis.Dunham@arm.commain.Alias('#all-deps', '#all-isas')
144110196SCurtis.Dunham@arm.com
144210196SCurtis.Dunham@arm.com# Dummy target to ensure all environments are created before telling
144310196SCurtis.Dunham@arm.com# SCons what to actually make (the command line arguments).  We attach
144410196SCurtis.Dunham@arm.com# them to the dependence graph after the environments are complete.
144510196SCurtis.Dunham@arm.comORIG_BUILD_TARGETS = list(BUILD_TARGETS) # force a copy; gets closure to work.
144610196SCurtis.Dunham@arm.comdef environsComplete(target, source, env):
144710196SCurtis.Dunham@arm.com    for t in ORIG_BUILD_TARGETS:
144810196SCurtis.Dunham@arm.com        main.Depends('#all-targets', t)
144910196SCurtis.Dunham@arm.com
145010196SCurtis.Dunham@arm.com# Each build/* switching_dir attaches its *-environs target to #all-environs.
145110196SCurtis.Dunham@arm.commain.Append(BUILDERS = {'CompleteEnvirons' :
145210196SCurtis.Dunham@arm.com                        Builder(action=MakeAction(environsComplete, None))})
145310196SCurtis.Dunham@arm.commain.CompleteEnvirons('#all-environs', [])
145410196SCurtis.Dunham@arm.com
145510196SCurtis.Dunham@arm.comdef doNothing(**ignored): pass
145610196SCurtis.Dunham@arm.commain.Append(BUILDERS = {'Dummy': Builder(action=MakeAction(doNothing, None))})
145710196SCurtis.Dunham@arm.com
145810196SCurtis.Dunham@arm.com# The final target to which all the original targets ultimately get attached.
145910196SCurtis.Dunham@arm.commain.Dummy('#all-targets', '#all-environs')
146010196SCurtis.Dunham@arm.comBUILD_TARGETS[:] = ['#all-targets']
146110196SCurtis.Dunham@arm.com
14623546Sgblack@eecs.umich.edu###################################################
14633546Sgblack@eecs.umich.edu#
1464955SN/A# Define build environments for selected configurations.
1465955SN/A#
1466955SN/A###################################################
1467955SN/A
14685863Snate@binkert.orgfor variant_path in variant_paths:
146910135SCurtis.Dunham@arm.com    if not GetOption('silent'):
147010135SCurtis.Dunham@arm.com        print "Building in", variant_path
14715343Sstever@gmail.com
14725343Sstever@gmail.com    # Make a copy of the build-root environment to use for this config.
14736121Snate@binkert.org    env = main.Clone()
14745863Snate@binkert.org    env['BUILDDIR'] = variant_path
14754773Snate@binkert.org
14765863Snate@binkert.org    # variant_dir is the tail component of build path, and is used to
14772632Sstever@eecs.umich.edu    # determine the build parameters (e.g., 'ALPHA_SE')
14785863Snate@binkert.org    (build_root, variant_dir) = splitpath(variant_path)
14792023SN/A
14805863Snate@binkert.org    # Set env variables according to the build directory config.
14815863Snate@binkert.org    sticky_vars.files = []
14825863Snate@binkert.org    # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
14835863Snate@binkert.org    # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
14845863Snate@binkert.org    # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
14855863Snate@binkert.org    current_vars_file = joinpath(build_root, 'variables', variant_dir)
14865863Snate@binkert.org    if isfile(current_vars_file):
14875863Snate@binkert.org        sticky_vars.files.append(current_vars_file)
148810135SCurtis.Dunham@arm.com        if not GetOption('silent'):
148910135SCurtis.Dunham@arm.com            print "Using saved variables file %s" % current_vars_file
14902632Sstever@eecs.umich.edu    else:
14915863Snate@binkert.org        # Build dir-specific variables file doesn't exist.
14922023SN/A
14932632Sstever@eecs.umich.edu        # Make sure the directory is there so we can create it later
14945863Snate@binkert.org        opt_dir = dirname(current_vars_file)
14955342Sstever@gmail.com        if not isdir(opt_dir):
14965863Snate@binkert.org            mkdir(opt_dir)
14972632Sstever@eecs.umich.edu
14985863Snate@binkert.org        # Get default build variables from source tree.  Variables are
14995863Snate@binkert.org        # normally determined by name of $VARIANT_DIR, but can be
15008267Ssteve.reinhardt@amd.com        # overridden by '--default=' arg on command line.
15018120Sgblack@eecs.umich.edu        default = GetOption('default')
15028267Ssteve.reinhardt@amd.com        opts_dir = joinpath(main.root.abspath, 'build_opts')
15038267Ssteve.reinhardt@amd.com        if default:
15048267Ssteve.reinhardt@amd.com            default_vars_files = [joinpath(build_root, 'variables', default),
15058267Ssteve.reinhardt@amd.com                                  joinpath(opts_dir, default)]
15068267Ssteve.reinhardt@amd.com        else:
15078267Ssteve.reinhardt@amd.com            default_vars_files = [joinpath(opts_dir, variant_dir)]
15088267Ssteve.reinhardt@amd.com        existing_files = filter(isfile, default_vars_files)
15098267Ssteve.reinhardt@amd.com        if existing_files:
15108267Ssteve.reinhardt@amd.com            default_vars_file = existing_files[0]
15115863Snate@binkert.org            sticky_vars.files.append(default_vars_file)
15125863Snate@binkert.org            print "Variables file %s not found,\n  using defaults in %s" \
15135863Snate@binkert.org                  % (current_vars_file, default_vars_file)
15142632Sstever@eecs.umich.edu        else:
15158267Ssteve.reinhardt@amd.com            print "Error: cannot find variables file %s or " \
15168267Ssteve.reinhardt@amd.com                  "default file(s) %s" \
15178267Ssteve.reinhardt@amd.com                  % (current_vars_file, ' or '.join(default_vars_files))
15182632Sstever@eecs.umich.edu            Exit(1)
15191888SN/A
15205863Snate@binkert.org    # Apply current variable settings to env
15215863Snate@binkert.org    sticky_vars.Update(env)
15221858SN/A
15238120Sgblack@eecs.umich.edu    help_texts["local_vars"] += \
15248120Sgblack@eecs.umich.edu        "Build variables for %s:\n" % variant_dir \
15257756SAli.Saidi@ARM.com                 + sticky_vars.GenerateHelpText(env)
15262598SN/A
15275863Snate@binkert.org    # Process variable settings.
15281858SN/A
15291858SN/A    if not have_fenv and env['USE_FENV']:
15301858SN/A        print "Warning: <fenv.h> not available; " \
15315863Snate@binkert.org              "forcing USE_FENV to False in", variant_dir + "."
15321858SN/A        env['USE_FENV'] = False
15331858SN/A
15341858SN/A    if not env['USE_FENV']:
15355863Snate@binkert.org        print "Warning: No IEEE FP rounding mode control in", variant_dir + "."
15361871SN/A        print "         FP results may deviate slightly from other platforms."
15371858SN/A
15381858SN/A    if env['EFENCE']:
15391858SN/A        env.Append(LIBS=['efence'])
15401858SN/A
15419651SAndreas.Sandberg@ARM.com    if env['USE_KVM']:
15429651SAndreas.Sandberg@ARM.com        if not have_kvm:
15439651SAndreas.Sandberg@ARM.com            print "Warning: Can not enable KVM, host seems to lack KVM support"
15449651SAndreas.Sandberg@ARM.com            env['USE_KVM'] = False
15459651SAndreas.Sandberg@ARM.com        elif not is_isa_kvm_compatible(env['TARGET_ISA']):
15469651SAndreas.Sandberg@ARM.com            print "Info: KVM support disabled due to unsupported host and " \
15479651SAndreas.Sandberg@ARM.com                "target ISA combination"
15489651SAndreas.Sandberg@ARM.com            env['USE_KVM'] = False
15499651SAndreas.Sandberg@ARM.com
155011798Santhony.gutierrez@amd.com    if env['BUILD_GPU']:
155111798Santhony.gutierrez@amd.com        env.Append(CPPDEFINES=['BUILD_GPU'])
155211798Santhony.gutierrez@amd.com
15539986Sandreas@sandberg.pp.se    # Warn about missing optional functionality
15549986Sandreas@sandberg.pp.se    if env['USE_KVM']:
15559986Sandreas@sandberg.pp.se        if not main['HAVE_PERF_ATTR_EXCLUDE_HOST']:
15569986Sandreas@sandberg.pp.se            print "Warning: perf_event headers lack support for the " \
15579986Sandreas@sandberg.pp.se                "exclude_host attribute. KVM instruction counts will " \
15589986Sandreas@sandberg.pp.se                "be inaccurate."
15599986Sandreas@sandberg.pp.se
15605863Snate@binkert.org    # Save sticky variable settings back to current variables file
15615863Snate@binkert.org    sticky_vars.Save(current_vars_file, env)
15621869SN/A
15631965SN/A    if env['USE_SSE2']:
15647739Sgblack@eecs.umich.edu        env.Append(CCFLAGS=['-msse2'])
15651965SN/A
15662761Sstever@eecs.umich.edu    # The src/SConscript file sets up the build rules in 'env' according
15675863Snate@binkert.org    # to the configured variables.  It returns a list of environments,
15681869SN/A    # one for each variant build (debug, opt, etc.)
156910196SCurtis.Dunham@arm.com    SConscript('src/SConscript', variant_dir = variant_path, exports = 'env')
15701869SN/A
157110196SCurtis.Dunham@arm.comdef pairwise(iterable):
157210196SCurtis.Dunham@arm.com    "s -> (s0,s1), (s1,s2), (s2, s3), ..."
157310196SCurtis.Dunham@arm.com    a, b = itertools.tee(iterable)
157410196SCurtis.Dunham@arm.com    b.next()
157510196SCurtis.Dunham@arm.com    return itertools.izip(a, b)
157610196SCurtis.Dunham@arm.com
157710196SCurtis.Dunham@arm.com# Create false dependencies so SCons will parse ISAs, establish
157810196SCurtis.Dunham@arm.com# dependencies, and setup the build Environments serially. Either
157910196SCurtis.Dunham@arm.com# SCons (likely) and/or our SConscripts (possibly) cannot cope with -j
158010196SCurtis.Dunham@arm.com# greater than 1. It appears to be standard race condition stuff; it
158110196SCurtis.Dunham@arm.com# doesn't always fail, but usually, and the behaviors are different.
158210196SCurtis.Dunham@arm.com# Every time I tried to remove this, builds would fail in some
158310196SCurtis.Dunham@arm.com# creative new way. So, don't do that. You'll want to, though, because
158410196SCurtis.Dunham@arm.com# tests/SConscript takes a long time to make its Environments.
158510196SCurtis.Dunham@arm.comfor t1, t2 in pairwise(sorted(all_isa_deps.iterkeys())):
158610196SCurtis.Dunham@arm.com    main.Depends('#%s-deps'     % t2, '#%s-deps'     % t1)
158710196SCurtis.Dunham@arm.com    main.Depends('#%s-environs' % t2, '#%s-environs' % t1)
1588955SN/A
15898120Sgblack@eecs.umich.edu# base help text
15908120Sgblack@eecs.umich.eduHelp('''
15918120Sgblack@eecs.umich.eduUsage: scons [scons options] [build variables] [target(s)]
15928120Sgblack@eecs.umich.edu
15938120Sgblack@eecs.umich.eduExtra scons options:
15948120Sgblack@eecs.umich.edu%(options)s
15958120Sgblack@eecs.umich.edu
15968120Sgblack@eecs.umich.eduGlobal build variables:
15978120Sgblack@eecs.umich.edu%(global_vars)s
15988120Sgblack@eecs.umich.edu
15998120Sgblack@eecs.umich.edu%(local_vars)s
16008120Sgblack@eecs.umich.edu''' % help_texts)
1601