SConstruct revision 11408
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")
26311408Sandreas.sandberg@arm.comgitdir = main.root.Dir(".git")
2645863Snate@binkert.org
26511408Sandreas.sandberg@arm.com
26611408Sandreas.sandberg@arm.comstyle_message = """
2678336Ssteve.reinhardt@amd.comYou're missing the gem5 style hook, which automatically checks your code
2688336Ssteve.reinhardt@amd.comagainst the gem5 style rules on hg commit and qrefresh commands.  This
26911408Sandreas.sandberg@arm.comscript will now install the hook in your %s.
2708336Ssteve.reinhardt@amd.comPress enter to continue, or ctrl-c to abort: """
2714678Snate@binkert.org
27211408Sandreas.sandberg@arm.commercurial_style_message = style_message % ".hg/hgrc file"
27311408Sandreas.sandberg@arm.comgit_style_message = style_message % ".git/hooks/ directory"
27411408Sandreas.sandberg@arm.com
27511401Sandreas.sandberg@arm.commercurial_style_upgrade_message = """
27611401Sandreas.sandberg@arm.comYour Mercurial style hooks are not up-to-date. This script will now
27711401Sandreas.sandberg@arm.comtry to automatically update them. A backup of your hgrc will be saved
27811401Sandreas.sandberg@arm.comin .hg/hgrc.old.
27911401Sandreas.sandberg@arm.comPress enter to continue, or ctrl-c to abort: """
28011401Sandreas.sandberg@arm.com
2818336Ssteve.reinhardt@amd.commercurial_style_hook = """
2828336Ssteve.reinhardt@amd.com# The following lines were automatically added by gem5/SConstruct
2838336Ssteve.reinhardt@amd.com# to provide the gem5 style-checking hooks
2844678Snate@binkert.org[extensions]
28511401Sandreas.sandberg@arm.comhgstyle = %s/util/hgstyle.py
2864678Snate@binkert.org
2874678Snate@binkert.org[hooks]
28811401Sandreas.sandberg@arm.compretxncommit.style = python:hgstyle.check_style
28911401Sandreas.sandberg@arm.compre-qrefresh.style = python:hgstyle.check_style
2908336Ssteve.reinhardt@amd.com# End of SConstruct additions
2914678Snate@binkert.org
2928336Ssteve.reinhardt@amd.com""" % (main.root.abspath)
2938336Ssteve.reinhardt@amd.com
2948336Ssteve.reinhardt@amd.commercurial_lib_not_found = """
2958336Ssteve.reinhardt@amd.comMercurial libraries cannot be found, ignoring style hook.  If
2968336Ssteve.reinhardt@amd.comyou are a gem5 developer, please fix this and run the style
2978336Ssteve.reinhardt@amd.comhook. It is important.
2985871Snate@binkert.org"""
2995871Snate@binkert.org
3008336Ssteve.reinhardt@amd.com# Check for style hook and prompt for installation if it's not there.
30111408Sandreas.sandberg@arm.com# Skip this if --ignore-style was specified, there's no interactive
30211408Sandreas.sandberg@arm.com# terminal to prompt, or no recognized revision control system can be
30311408Sandreas.sandberg@arm.com# found.
30411408Sandreas.sandberg@arm.comignore_style = GetOption('ignore_style') or not sys.stdin.isatty()
30511408Sandreas.sandberg@arm.com
30611408Sandreas.sandberg@arm.com# Try wire up Mercurial to the style hooks
30711408Sandreas.sandberg@arm.comif not ignore_style and hgdir.exists():
3088336Ssteve.reinhardt@amd.com    style_hook = True
30911401Sandreas.sandberg@arm.com    style_hooks = tuple()
31011401Sandreas.sandberg@arm.com    hgrc = hgdir.File('hgrc')
31111401Sandreas.sandberg@arm.com    hgrc_old = hgdir.File('hgrc.old')
3125871Snate@binkert.org    try:
3138336Ssteve.reinhardt@amd.com        from mercurial import ui
3148336Ssteve.reinhardt@amd.com        ui = ui.ui()
31511401Sandreas.sandberg@arm.com        ui.readconfig(hgrc.abspath)
31611401Sandreas.sandberg@arm.com        style_hooks = (ui.config('hooks', 'pretxncommit.style', None),
31711401Sandreas.sandberg@arm.com                       ui.config('hooks', 'pre-qrefresh.style', None))
31811401Sandreas.sandberg@arm.com        style_hook = all(style_hooks)
31911401Sandreas.sandberg@arm.com        style_extension = ui.config('extensions', 'style', None)
3204678Snate@binkert.org    except ImportError:
3215871Snate@binkert.org        print mercurial_lib_not_found
3224678Snate@binkert.org
32311401Sandreas.sandberg@arm.com    if "python:style.check_style" in style_hooks:
32411401Sandreas.sandberg@arm.com        # Try to upgrade the style hooks
32511401Sandreas.sandberg@arm.com        print mercurial_style_upgrade_message
32611401Sandreas.sandberg@arm.com        # continue unless user does ctrl-c/ctrl-d etc.
32711401Sandreas.sandberg@arm.com        try:
32811401Sandreas.sandberg@arm.com            raw_input()
32911401Sandreas.sandberg@arm.com        except:
33011401Sandreas.sandberg@arm.com            print "Input exception, exiting scons.\n"
33111401Sandreas.sandberg@arm.com            sys.exit(1)
33211401Sandreas.sandberg@arm.com        shutil.copyfile(hgrc.abspath, hgrc_old.abspath)
33311401Sandreas.sandberg@arm.com        re_style_hook = re.compile(r"^([^=#]+)\.style\s*=\s*([^#\s]+).*")
33411401Sandreas.sandberg@arm.com        re_style_extension = re.compile("style\s*=\s*([^#\s]+).*")
33511401Sandreas.sandberg@arm.com        with open(hgrc_old.abspath, 'r') as old, \
33611401Sandreas.sandberg@arm.com             open(hgrc.abspath, 'w') as new:
33711401Sandreas.sandberg@arm.com
33811401Sandreas.sandberg@arm.com            for l in old:
33911401Sandreas.sandberg@arm.com                m_hook = re_style_hook.match(l)
34011401Sandreas.sandberg@arm.com                m_ext = re_style_extension.match(l)
34111401Sandreas.sandberg@arm.com                if m_hook:
34211401Sandreas.sandberg@arm.com                    hook, check = m_hook.groups()
34311401Sandreas.sandberg@arm.com                    if check != "python:style.check_style":
34411401Sandreas.sandberg@arm.com                        print "Warning: %s.style is using a non-default " \
34511401Sandreas.sandberg@arm.com                            "checker: %s" % (hook, check)
34611401Sandreas.sandberg@arm.com                    if hook not in ("pretxncommit", "pre-qrefresh"):
34711401Sandreas.sandberg@arm.com                        print "Warning: Updating unknown style hook: %s" % hook
34811401Sandreas.sandberg@arm.com
34911401Sandreas.sandberg@arm.com                    l = "%s.style = python:hgstyle.check_style\n" % hook
35011401Sandreas.sandberg@arm.com                elif m_ext and m_ext.group(1) == style_extension:
35111401Sandreas.sandberg@arm.com                    l = "hgstyle = %s/util/hgstyle.py\n" % main.root.abspath
35211401Sandreas.sandberg@arm.com
35311401Sandreas.sandberg@arm.com                new.write(l)
35411401Sandreas.sandberg@arm.com    elif not style_hook:
3558336Ssteve.reinhardt@amd.com        print mercurial_style_message,
3568336Ssteve.reinhardt@amd.com        # continue unless user does ctrl-c/ctrl-d etc.
3578336Ssteve.reinhardt@amd.com        try:
3588336Ssteve.reinhardt@amd.com            raw_input()
3598336Ssteve.reinhardt@amd.com        except:
3608336Ssteve.reinhardt@amd.com            print "Input exception, exiting scons.\n"
3618336Ssteve.reinhardt@amd.com            sys.exit(1)
3628336Ssteve.reinhardt@amd.com        hgrc_path = '%s/.hg/hgrc' % main.root.abspath
3638336Ssteve.reinhardt@amd.com        print "Adding style hook to", hgrc_path, "\n"
3648336Ssteve.reinhardt@amd.com        try:
36511401Sandreas.sandberg@arm.com            with open(hgrc_path, 'a') as f:
36611401Sandreas.sandberg@arm.com                f.write(mercurial_style_hook)
3678336Ssteve.reinhardt@amd.com        except:
3688336Ssteve.reinhardt@amd.com            print "Error updating", hgrc_path
3698336Ssteve.reinhardt@amd.com            sys.exit(1)
3705871Snate@binkert.org
37111408Sandreas.sandberg@arm.com# Try to wire up git to the style hooks
37211408Sandreas.sandberg@arm.comgit_pre_commit_hook = gitdir.File("hooks/pre-commit")
37311408Sandreas.sandberg@arm.comif not ignore_style and gitdir.exists() and not git_pre_commit_hook.exists():
37411408Sandreas.sandberg@arm.com    git_style_script = File("util/git-pre-commit.py")
37511408Sandreas.sandberg@arm.com
37611408Sandreas.sandberg@arm.com    print git_style_message,
37711408Sandreas.sandberg@arm.com    try:
37811408Sandreas.sandberg@arm.com        raw_input()
37911408Sandreas.sandberg@arm.com    except:
38011408Sandreas.sandberg@arm.com        print "Input exception, exiting scons.\n"
38111408Sandreas.sandberg@arm.com        sys.exit(1)
38211408Sandreas.sandberg@arm.com
38311408Sandreas.sandberg@arm.com    try:
38411408Sandreas.sandberg@arm.com        rel_style_script = os.path.relpath(
38511408Sandreas.sandberg@arm.com            git_style_script.get_abspath(),
38611408Sandreas.sandberg@arm.com            git_pre_commit_hook.Dir(".").get_abspath())
38711408Sandreas.sandberg@arm.com        os.symlink(rel_style_script, git_pre_commit_hook.get_abspath())
38811408Sandreas.sandberg@arm.com    except:
38911408Sandreas.sandberg@arm.com        print "Error updating git pre-commit hook"
39011408Sandreas.sandberg@arm.com        raise
39111408Sandreas.sandberg@arm.com        sys.exit(1)
3926121Snate@binkert.org
393955SN/A###################################################
394955SN/A#
3952632Sstever@eecs.umich.edu# Figure out which configurations to set up based on the path(s) of
3962632Sstever@eecs.umich.edu# the target(s).
397955SN/A#
398955SN/A###################################################
399955SN/A
400955SN/A# Find default configuration & binary.
4018878Ssteve.reinhardt@amd.comDefault(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug'))
402955SN/A
4032632Sstever@eecs.umich.edu# helper function: find last occurrence of element in list
4042632Sstever@eecs.umich.edudef rfind(l, elt, offs = -1):
4052632Sstever@eecs.umich.edu    for i in range(len(l)+offs, 0, -1):
4062632Sstever@eecs.umich.edu        if l[i] == elt:
4072632Sstever@eecs.umich.edu            return i
4082632Sstever@eecs.umich.edu    raise ValueError, "element not found"
4092632Sstever@eecs.umich.edu
4108268Ssteve.reinhardt@amd.com# Take a list of paths (or SCons Nodes) and return a list with all
4118268Ssteve.reinhardt@amd.com# paths made absolute and ~-expanded.  Paths will be interpreted
4128268Ssteve.reinhardt@amd.com# relative to the launch directory unless a different root is provided
4138268Ssteve.reinhardt@amd.comdef makePathListAbsolute(path_list, root=GetLaunchDir()):
4148268Ssteve.reinhardt@amd.com    return [abspath(joinpath(root, expanduser(str(p))))
4158268Ssteve.reinhardt@amd.com            for p in path_list]
4168268Ssteve.reinhardt@amd.com
4172632Sstever@eecs.umich.edu# Each target must have 'build' in the interior of the path; the
4182632Sstever@eecs.umich.edu# directory below this will determine the build parameters.  For
4192632Sstever@eecs.umich.edu# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
4202632Sstever@eecs.umich.edu# recognize that ALPHA_SE specifies the configuration because it
4218268Ssteve.reinhardt@amd.com# follow 'build' in the build path.
4222632Sstever@eecs.umich.edu
4238268Ssteve.reinhardt@amd.com# The funky assignment to "[:]" is needed to replace the list contents
4248268Ssteve.reinhardt@amd.com# in place rather than reassign the symbol to a new list, which
4258268Ssteve.reinhardt@amd.com# doesn't work (obviously!).
4268268Ssteve.reinhardt@amd.comBUILD_TARGETS[:] = makePathListAbsolute(BUILD_TARGETS)
4273718Sstever@eecs.umich.edu
4282634Sstever@eecs.umich.edu# Generate a list of the unique build roots and configs that the
4292634Sstever@eecs.umich.edu# collected targets reference.
4305863Snate@binkert.orgvariant_paths = []
4312638Sstever@eecs.umich.edubuild_root = None
4328268Ssteve.reinhardt@amd.comfor t in BUILD_TARGETS:
4332632Sstever@eecs.umich.edu    path_dirs = t.split('/')
4342632Sstever@eecs.umich.edu    try:
4352632Sstever@eecs.umich.edu        build_top = rfind(path_dirs, 'build', -2)
4362632Sstever@eecs.umich.edu    except:
4372632Sstever@eecs.umich.edu        print "Error: no non-leaf 'build' dir found on target path", t
4381858SN/A        Exit(1)
4393716Sstever@eecs.umich.edu    this_build_root = joinpath('/',*path_dirs[:build_top+1])
4402638Sstever@eecs.umich.edu    if not build_root:
4412638Sstever@eecs.umich.edu        build_root = this_build_root
4422638Sstever@eecs.umich.edu    else:
4432638Sstever@eecs.umich.edu        if this_build_root != build_root:
4442638Sstever@eecs.umich.edu            print "Error: build targets not under same build root\n"\
4452638Sstever@eecs.umich.edu                  "  %s\n  %s" % (build_root, this_build_root)
4462638Sstever@eecs.umich.edu            Exit(1)
4475863Snate@binkert.org    variant_path = joinpath('/',*path_dirs[:build_top+2])
4485863Snate@binkert.org    if variant_path not in variant_paths:
4495863Snate@binkert.org        variant_paths.append(variant_path)
450955SN/A
4515341Sstever@gmail.com# Make sure build_root exists (might not if this is the first build there)
4525341Sstever@gmail.comif not isdir(build_root):
4535863Snate@binkert.org    mkdir(build_root)
4547756SAli.Saidi@ARM.commain['BUILDROOT'] = build_root
4555341Sstever@gmail.com
4566121Snate@binkert.orgExport('main')
4574494Ssaidi@eecs.umich.edu
4586121Snate@binkert.orgmain.SConsignFile(joinpath(build_root, "sconsign"))
4591105SN/A
4602667Sstever@eecs.umich.edu# Default duplicate option is to use hard links, but this messes up
4612667Sstever@eecs.umich.edu# when you use emacs to edit a file in the target dir, as emacs moves
4622667Sstever@eecs.umich.edu# file to file~ then copies to file, breaking the link.  Symbolic
4632667Sstever@eecs.umich.edu# (soft) links work better.
4646121Snate@binkert.orgmain.SetOption('duplicate', 'soft-copy')
4652667Sstever@eecs.umich.edu
4665341Sstever@gmail.com#
4675863Snate@binkert.org# Set up global sticky variables... these are common to an entire build
4685341Sstever@gmail.com# tree (not specific to a particular build like ALPHA_SE)
4695341Sstever@gmail.com#
4705341Sstever@gmail.com
4718120Sgblack@eecs.umich.eduglobal_vars_file = joinpath(build_root, 'variables.global')
4725341Sstever@gmail.com
4738120Sgblack@eecs.umich.eduglobal_vars = Variables(global_vars_file, args=ARGUMENTS)
4745341Sstever@gmail.com
4758120Sgblack@eecs.umich.eduglobal_vars.AddVariables(
4766121Snate@binkert.org    ('CC', 'C compiler', environ.get('CC', main['CC'])),
4776121Snate@binkert.org    ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])),
4788980Ssteve.reinhardt@amd.com    ('SWIG', 'SWIG tool', environ.get('SWIG', main['SWIG'])),
4799396Sandreas.hansson@arm.com    ('PROTOC', 'protoc tool', environ.get('PROTOC', 'protoc')),
4805397Ssaidi@eecs.umich.edu    ('BATCH', 'Use batch pool for build and tests', False),
4815397Ssaidi@eecs.umich.edu    ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
4827727SAli.Saidi@ARM.com    ('M5_BUILD_CACHE', 'Cache built objects in this directory', False),
4838268Ssteve.reinhardt@amd.com    ('EXTRAS', 'Add extra directories to the compilation', '')
4846168Snate@binkert.org    )
4855341Sstever@gmail.com
4868120Sgblack@eecs.umich.edu# Update main environment with values from ARGUMENTS & global_vars_file
4878120Sgblack@eecs.umich.eduglobal_vars.Update(main)
4888120Sgblack@eecs.umich.eduhelp_texts["global_vars"] += global_vars.GenerateHelpText(main)
4896814Sgblack@eecs.umich.edu
4905863Snate@binkert.org# Save sticky variable settings back to current variables file
4918120Sgblack@eecs.umich.eduglobal_vars.Save(global_vars_file, main)
4925341Sstever@gmail.com
4935863Snate@binkert.org# Parse EXTRAS variable to build list of all directories where we're
4948268Ssteve.reinhardt@amd.com# look for sources etc.  This list is exported as extras_dir_list.
4956121Snate@binkert.orgbase_dir = main.srcdir.abspath
4966121Snate@binkert.orgif main['EXTRAS']:
4978268Ssteve.reinhardt@amd.com    extras_dir_list = makePathListAbsolute(main['EXTRAS'].split(':'))
4985742Snate@binkert.orgelse:
4995742Snate@binkert.org    extras_dir_list = []
5005341Sstever@gmail.com
5015742Snate@binkert.orgExport('base_dir')
5025742Snate@binkert.orgExport('extras_dir_list')
5035341Sstever@gmail.com
5046017Snate@binkert.org# the ext directory should be on the #includes path
5056121Snate@binkert.orgmain.Append(CPPPATH=[Dir('ext')])
5066017Snate@binkert.org
5077816Ssteve.reinhardt@amd.comdef strip_build_path(path, env):
5087756SAli.Saidi@ARM.com    path = str(path)
5097756SAli.Saidi@ARM.com    variant_base = env['BUILDROOT'] + os.path.sep
5107756SAli.Saidi@ARM.com    if path.startswith(variant_base):
5117756SAli.Saidi@ARM.com        path = path[len(variant_base):]
5127756SAli.Saidi@ARM.com    elif path.startswith('build/'):
5137756SAli.Saidi@ARM.com        path = path[6:]
5147756SAli.Saidi@ARM.com    return path
5157756SAli.Saidi@ARM.com
5167816Ssteve.reinhardt@amd.com# Generate a string of the form:
5177816Ssteve.reinhardt@amd.com#   common/path/prefix/src1, src2 -> tgt1, tgt2
5187816Ssteve.reinhardt@amd.com# to print while building.
5197816Ssteve.reinhardt@amd.comclass Transform(object):
5207816Ssteve.reinhardt@amd.com    # all specific color settings should be here and nowhere else
5217816Ssteve.reinhardt@amd.com    tool_color = termcap.Normal
5227816Ssteve.reinhardt@amd.com    pfx_color = termcap.Yellow
5237816Ssteve.reinhardt@amd.com    srcs_color = termcap.Yellow + termcap.Bold
5247816Ssteve.reinhardt@amd.com    arrow_color = termcap.Blue + termcap.Bold
5257816Ssteve.reinhardt@amd.com    tgts_color = termcap.Yellow + termcap.Bold
5267756SAli.Saidi@ARM.com
5277816Ssteve.reinhardt@amd.com    def __init__(self, tool, max_sources=99):
5287816Ssteve.reinhardt@amd.com        self.format = self.tool_color + (" [%8s] " % tool) \
5297816Ssteve.reinhardt@amd.com                      + self.pfx_color + "%s" \
5307816Ssteve.reinhardt@amd.com                      + self.srcs_color + "%s" \
5317816Ssteve.reinhardt@amd.com                      + self.arrow_color + " -> " \
5327816Ssteve.reinhardt@amd.com                      + self.tgts_color + "%s" \
5337816Ssteve.reinhardt@amd.com                      + termcap.Normal
5347816Ssteve.reinhardt@amd.com        self.max_sources = max_sources
5357816Ssteve.reinhardt@amd.com
5367816Ssteve.reinhardt@amd.com    def __call__(self, target, source, env, for_signature=None):
5377816Ssteve.reinhardt@amd.com        # truncate source list according to max_sources param
5387816Ssteve.reinhardt@amd.com        source = source[0:self.max_sources]
5397816Ssteve.reinhardt@amd.com        def strip(f):
5407816Ssteve.reinhardt@amd.com            return strip_build_path(str(f), env)
5417816Ssteve.reinhardt@amd.com        if len(source) > 0:
5427816Ssteve.reinhardt@amd.com            srcs = map(strip, source)
5437816Ssteve.reinhardt@amd.com        else:
5447816Ssteve.reinhardt@amd.com            srcs = ['']
5457816Ssteve.reinhardt@amd.com        tgts = map(strip, target)
5467816Ssteve.reinhardt@amd.com        # surprisingly, os.path.commonprefix is a dumb char-by-char string
5477816Ssteve.reinhardt@amd.com        # operation that has nothing to do with paths.
5487816Ssteve.reinhardt@amd.com        com_pfx = os.path.commonprefix(srcs + tgts)
5497816Ssteve.reinhardt@amd.com        com_pfx_len = len(com_pfx)
5507816Ssteve.reinhardt@amd.com        if com_pfx:
5517816Ssteve.reinhardt@amd.com            # do some cleanup and sanity checking on common prefix
5527816Ssteve.reinhardt@amd.com            if com_pfx[-1] == ".":
5537816Ssteve.reinhardt@amd.com                # prefix matches all but file extension: ok
5547816Ssteve.reinhardt@amd.com                # back up one to change 'foo.cc -> o' to 'foo.cc -> .o'
5557816Ssteve.reinhardt@amd.com                com_pfx = com_pfx[0:-1]
5567816Ssteve.reinhardt@amd.com            elif com_pfx[-1] == "/":
5577816Ssteve.reinhardt@amd.com                # common prefix is directory path: OK
5587816Ssteve.reinhardt@amd.com                pass
5597816Ssteve.reinhardt@amd.com            else:
5607816Ssteve.reinhardt@amd.com                src0_len = len(srcs[0])
5617816Ssteve.reinhardt@amd.com                tgt0_len = len(tgts[0])
5627816Ssteve.reinhardt@amd.com                if src0_len == com_pfx_len:
5637816Ssteve.reinhardt@amd.com                    # source is a substring of target, OK
5647816Ssteve.reinhardt@amd.com                    pass
5657816Ssteve.reinhardt@amd.com                elif tgt0_len == com_pfx_len:
5667816Ssteve.reinhardt@amd.com                    # target is a substring of source, need to back up to
5677816Ssteve.reinhardt@amd.com                    # avoid empty string on RHS of arrow
5687816Ssteve.reinhardt@amd.com                    sep_idx = com_pfx.rfind(".")
5697816Ssteve.reinhardt@amd.com                    if sep_idx != -1:
5707816Ssteve.reinhardt@amd.com                        com_pfx = com_pfx[0:sep_idx]
5717816Ssteve.reinhardt@amd.com                    else:
5727816Ssteve.reinhardt@amd.com                        com_pfx = ''
5737816Ssteve.reinhardt@amd.com                elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".":
5747816Ssteve.reinhardt@amd.com                    # still splitting at file extension: ok
5757816Ssteve.reinhardt@amd.com                    pass
5767816Ssteve.reinhardt@amd.com                else:
5777816Ssteve.reinhardt@amd.com                    # probably a fluke; ignore it
5787816Ssteve.reinhardt@amd.com                    com_pfx = ''
5797816Ssteve.reinhardt@amd.com        # recalculate length in case com_pfx was modified
5807816Ssteve.reinhardt@amd.com        com_pfx_len = len(com_pfx)
5817816Ssteve.reinhardt@amd.com        def fmt(files):
5827816Ssteve.reinhardt@amd.com            f = map(lambda s: s[com_pfx_len:], files)
5837816Ssteve.reinhardt@amd.com            return ', '.join(f)
5847816Ssteve.reinhardt@amd.com        return self.format % (com_pfx, fmt(srcs), fmt(tgts))
5857816Ssteve.reinhardt@amd.com
5867816Ssteve.reinhardt@amd.comExport('Transform')
5877816Ssteve.reinhardt@amd.com
5888947Sandreas.hansson@arm.com# enable the regression script to use the termcap
5898947Sandreas.hansson@arm.commain['TERMCAP'] = termcap
5907756SAli.Saidi@ARM.com
5918120Sgblack@eecs.umich.eduif GetOption('verbose'):
5927756SAli.Saidi@ARM.com    def MakeAction(action, string, *args, **kwargs):
5937756SAli.Saidi@ARM.com        return Action(action, *args, **kwargs)
5947756SAli.Saidi@ARM.comelse:
5957756SAli.Saidi@ARM.com    MakeAction = Action
5967816Ssteve.reinhardt@amd.com    main['CCCOMSTR']        = Transform("CC")
5977816Ssteve.reinhardt@amd.com    main['CXXCOMSTR']       = Transform("CXX")
5987816Ssteve.reinhardt@amd.com    main['ASCOMSTR']        = Transform("AS")
5997816Ssteve.reinhardt@amd.com    main['SWIGCOMSTR']      = Transform("SWIG")
6007816Ssteve.reinhardt@amd.com    main['ARCOMSTR']        = Transform("AR", 0)
6017816Ssteve.reinhardt@amd.com    main['LINKCOMSTR']      = Transform("LINK", 0)
6027816Ssteve.reinhardt@amd.com    main['RANLIBCOMSTR']    = Transform("RANLIB", 0)
6037816Ssteve.reinhardt@amd.com    main['M4COMSTR']        = Transform("M4")
6047816Ssteve.reinhardt@amd.com    main['SHCCCOMSTR']      = Transform("SHCC")
6057816Ssteve.reinhardt@amd.com    main['SHCXXCOMSTR']     = Transform("SHCXX")
6067756SAli.Saidi@ARM.comExport('MakeAction')
6077756SAli.Saidi@ARM.com
6089227Sandreas.hansson@arm.com# Initialize the Link-Time Optimization (LTO) flags
6099227Sandreas.hansson@arm.commain['LTO_CCFLAGS'] = []
6109227Sandreas.hansson@arm.commain['LTO_LDFLAGS'] = []
6119227Sandreas.hansson@arm.com
6129590Sandreas@sandberg.pp.se# According to the readme, tcmalloc works best if the compiler doesn't
6139590Sandreas@sandberg.pp.se# assume that we're using the builtin malloc and friends. These flags
6149590Sandreas@sandberg.pp.se# are compiler-specific, so we need to set them after we detect which
6159590Sandreas@sandberg.pp.se# compiler we're using.
6169590Sandreas@sandberg.pp.semain['TCMALLOC_CCFLAGS'] = []
6179590Sandreas@sandberg.pp.se
6186654Snate@binkert.orgCXX_version = readCommand([main['CXX'],'--version'], exception=False)
6196654Snate@binkert.orgCXX_V = readCommand([main['CXX'],'-V'], exception=False)
6205871Snate@binkert.org
6216121Snate@binkert.orgmain['GCC'] = CXX_version and CXX_version.find('g++') >= 0
6228946Sandreas.hansson@arm.commain['CLANG'] = CXX_version and CXX_version.find('clang') >= 0
6239419Sandreas.hansson@arm.comif main['GCC'] + main['CLANG'] > 1:
6243940Ssaidi@eecs.umich.edu    print 'Error: How can we have two at the same time?'
6253918Ssaidi@eecs.umich.edu    Exit(1)
6263918Ssaidi@eecs.umich.edu
6271858SN/A# Set up default C++ compiler flags
6289556Sandreas.hansson@arm.comif main['GCC'] or main['CLANG']:
6299556Sandreas.hansson@arm.com    # As gcc and clang share many flags, do the common parts here
6309556Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-pipe'])
6319556Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-fno-strict-aliasing'])
63211294Sandreas.hansson@arm.com    # Enable -Wall and -Wextra and then disable the few warnings that
63311294Sandreas.hansson@arm.com    # we consistently violate
63411294Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-Wall', '-Wundef', '-Wextra',
63511294Sandreas.hansson@arm.com                         '-Wno-sign-compare', '-Wno-unused-parameter'])
63610878Sandreas.hansson@arm.com    # We always compile using C++11
63710878Sandreas.hansson@arm.com    main.Append(CXXFLAGS=['-std=c++11'])
6389556Sandreas.hansson@arm.comelse:
6399556Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal,
6409556Sandreas.hansson@arm.com    print "Don't know what compiler options to use for your compiler."
6419556Sandreas.hansson@arm.com    print termcap.Yellow + '       compiler:' + termcap.Normal, main['CXX']
6429556Sandreas.hansson@arm.com    print termcap.Yellow + '       version:' + termcap.Normal,
6439556Sandreas.hansson@arm.com    if not CXX_version:
6449556Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\
6459556Sandreas.hansson@arm.com               termcap.Normal
6469556Sandreas.hansson@arm.com    else:
6479556Sandreas.hansson@arm.com        print CXX_version.replace('\n', '<nl>')
6489556Sandreas.hansson@arm.com    print "       If you're trying to use a compiler other than GCC"
6499556Sandreas.hansson@arm.com    print "       or clang, there appears to be something wrong with your"
6509556Sandreas.hansson@arm.com    print "       environment."
6519556Sandreas.hansson@arm.com    print "       "
6529556Sandreas.hansson@arm.com    print "       If you are trying to use a compiler other than those listed"
6539556Sandreas.hansson@arm.com    print "       above you will need to ease fix SConstruct and "
6549556Sandreas.hansson@arm.com    print "       src/SConscript to support that compiler."
6559556Sandreas.hansson@arm.com    Exit(1)
6569556Sandreas.hansson@arm.com
6576121Snate@binkert.orgif main['GCC']:
65810878Sandreas.hansson@arm.com    # Check for a supported version of gcc. >= 4.7 is chosen for its
65910238Sandreas.hansson@arm.com    # level of c++11 support. See
66010878Sandreas.hansson@arm.com    # http://gcc.gnu.org/projects/cxx0x.html for details.
6619420Sandreas.hansson@arm.com    gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False)
66210878Sandreas.hansson@arm.com    if compareVersions(gcc_version, "4.7") < 0:
66310878Sandreas.hansson@arm.com        print 'Error: gcc version 4.7 or newer required.'
6649420Sandreas.hansson@arm.com        print '       Installed version:', gcc_version
6659420Sandreas.hansson@arm.com        Exit(1)
6669420Sandreas.hansson@arm.com
6679420Sandreas.hansson@arm.com    main['GCC_VERSION'] = gcc_version
6689420Sandreas.hansson@arm.com
66910264Sandreas.hansson@arm.com    # gcc from version 4.8 and above generates "rep; ret" instructions
67010264Sandreas.hansson@arm.com    # to avoid performance penalties on certain AMD chips. Older
67110264Sandreas.hansson@arm.com    # assemblers detect this as an error, "Error: expecting string
67210264Sandreas.hansson@arm.com    # instruction after `rep'"
67310264Sandreas.hansson@arm.com    if compareVersions(gcc_version, "4.8") > 0:
67410866Sandreas.hansson@arm.com        as_version_raw = readCommand([main['AS'], '-v', '/dev/null'],
67510866Sandreas.hansson@arm.com                                     exception=False).split()
67610264Sandreas.hansson@arm.com
67710866Sandreas.hansson@arm.com        # version strings may contain extra distro-specific
67810866Sandreas.hansson@arm.com        # qualifiers, so play it safe and keep only what comes before
67910866Sandreas.hansson@arm.com        # the first hyphen
68010866Sandreas.hansson@arm.com        as_version = as_version_raw[-1].split('-')[0] if as_version_raw \
68110866Sandreas.hansson@arm.com            else None
68210866Sandreas.hansson@arm.com
68310866Sandreas.hansson@arm.com        if not as_version or compareVersions(as_version, "2.23") < 0:
68410264Sandreas.hansson@arm.com            print termcap.Yellow + termcap.Bold + \
68510264Sandreas.hansson@arm.com                'Warning: This combination of gcc and binutils have' + \
68610264Sandreas.hansson@arm.com                ' known incompatibilities.\n' + \
68710264Sandreas.hansson@arm.com                '         If you encounter build problems, please update ' + \
68810264Sandreas.hansson@arm.com                'binutils to 2.23.' + \
68910264Sandreas.hansson@arm.com                termcap.Normal
69010264Sandreas.hansson@arm.com
69110457Sandreas.hansson@arm.com    # Make sure we warn if the user has requested to compile with the
69210457Sandreas.hansson@arm.com    # Undefined Benahvior Sanitizer and this version of gcc does not
69310457Sandreas.hansson@arm.com    # support it.
69410457Sandreas.hansson@arm.com    if GetOption('with_ubsan') and \
69510457Sandreas.hansson@arm.com            compareVersions(gcc_version, '4.9') < 0:
69610457Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + \
69710457Sandreas.hansson@arm.com            'Warning: UBSan is only supported using gcc 4.9 and later.' + \
69810457Sandreas.hansson@arm.com            termcap.Normal
69910457Sandreas.hansson@arm.com
70010238Sandreas.hansson@arm.com    # Add the appropriate Link-Time Optimization (LTO) flags
70110238Sandreas.hansson@arm.com    # unless LTO is explicitly turned off. Note that these flags
70210238Sandreas.hansson@arm.com    # are only used by the fast target.
70310238Sandreas.hansson@arm.com    if not GetOption('no_lto'):
70410238Sandreas.hansson@arm.com        # Pass the LTO flag when compiling to produce GIMPLE
70510238Sandreas.hansson@arm.com        # output, we merely create the flags here and only append
70610416Sandreas.hansson@arm.com        # them later
70710238Sandreas.hansson@arm.com        main['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
7089227Sandreas.hansson@arm.com
70910238Sandreas.hansson@arm.com        # Use the same amount of jobs for LTO as we are running
71010416Sandreas.hansson@arm.com        # scons with
71110416Sandreas.hansson@arm.com        main['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
7129227Sandreas.hansson@arm.com
7139590Sandreas@sandberg.pp.se    main.Append(TCMALLOC_CCFLAGS=['-fno-builtin-malloc', '-fno-builtin-calloc',
7149590Sandreas@sandberg.pp.se                                  '-fno-builtin-realloc', '-fno-builtin-free'])
7159590Sandreas@sandberg.pp.se
7168737Skoansin.tan@gmail.comelif main['CLANG']:
71710878Sandreas.hansson@arm.com    # Check for a supported version of clang, >= 3.1 is needed to
71810878Sandreas.hansson@arm.com    # support similar features as gcc 4.7. See
7199420Sandreas.hansson@arm.com    # http://clang.llvm.org/cxx_status.html for details
7208737Skoansin.tan@gmail.com    clang_version_re = re.compile(".* version (\d+\.\d+)")
72110106SMitch.Hayenga@arm.com    clang_version_match = clang_version_re.search(CXX_version)
7228737Skoansin.tan@gmail.com    if (clang_version_match):
7238737Skoansin.tan@gmail.com        clang_version = clang_version_match.groups()[0]
72410878Sandreas.hansson@arm.com        if compareVersions(clang_version, "3.1") < 0:
72510878Sandreas.hansson@arm.com            print 'Error: clang version 3.1 or newer required.'
7268737Skoansin.tan@gmail.com            print '       Installed version:', clang_version
7278737Skoansin.tan@gmail.com            Exit(1)
7288737Skoansin.tan@gmail.com    else:
7298737Skoansin.tan@gmail.com        print 'Error: Unable to determine clang version.'
7308737Skoansin.tan@gmail.com        Exit(1)
7318737Skoansin.tan@gmail.com
73211294Sandreas.hansson@arm.com    # clang has a few additional warnings that we disable, extraneous
7339556Sandreas.hansson@arm.com    # parantheses are allowed due to Ruby's printing of the AST,
7349556Sandreas.hansson@arm.com    # finally self assignments are allowed as the generated CPU code
7359556Sandreas.hansson@arm.com    # is relying on this
73611294Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-Wno-parentheses',
73710278SAndreas.Sandberg@ARM.com                         '-Wno-self-assign',
73810278SAndreas.Sandberg@ARM.com                         # Some versions of libstdc++ (4.8?) seem to
73910278SAndreas.Sandberg@ARM.com                         # use struct hash and class hash
74010278SAndreas.Sandberg@ARM.com                         # interchangeably.
74110278SAndreas.Sandberg@ARM.com                         '-Wno-mismatched-tags',
74210278SAndreas.Sandberg@ARM.com                         ])
7439556Sandreas.hansson@arm.com
7449590Sandreas@sandberg.pp.se    main.Append(TCMALLOC_CCFLAGS=['-fno-builtin'])
7459590Sandreas@sandberg.pp.se
7469420Sandreas.hansson@arm.com    # On Mac OS X/Darwin we need to also use libc++ (part of XCode) as
7479846Sandreas.hansson@arm.com    # opposed to libstdc++, as the later is dated.
7489846Sandreas.hansson@arm.com    if sys.platform == "darwin":
7499846Sandreas.hansson@arm.com        main.Append(CXXFLAGS=['-stdlib=libc++'])
7509846Sandreas.hansson@arm.com        main.Append(LIBS=['c++'])
7518946Sandreas.hansson@arm.com
7523918Ssaidi@eecs.umich.eduelse:
7539068SAli.Saidi@ARM.com    print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal,
7549068SAli.Saidi@ARM.com    print "Don't know what compiler options to use for your compiler."
7559068SAli.Saidi@ARM.com    print termcap.Yellow + '       compiler:' + termcap.Normal, main['CXX']
7569068SAli.Saidi@ARM.com    print termcap.Yellow + '       version:' + termcap.Normal,
7579068SAli.Saidi@ARM.com    if not CXX_version:
7589068SAli.Saidi@ARM.com        print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\
7599068SAli.Saidi@ARM.com               termcap.Normal
7609068SAli.Saidi@ARM.com    else:
7619068SAli.Saidi@ARM.com        print CXX_version.replace('\n', '<nl>')
7629419Sandreas.hansson@arm.com    print "       If you're trying to use a compiler other than GCC"
7639068SAli.Saidi@ARM.com    print "       or clang, there appears to be something wrong with your"
7649068SAli.Saidi@ARM.com    print "       environment."
7659068SAli.Saidi@ARM.com    print "       "
7669068SAli.Saidi@ARM.com    print "       If you are trying to use a compiler other than those listed"
7679068SAli.Saidi@ARM.com    print "       above you will need to ease fix SConstruct and "
7689068SAli.Saidi@ARM.com    print "       src/SConscript to support that compiler."
7693918Ssaidi@eecs.umich.edu    Exit(1)
7703918Ssaidi@eecs.umich.edu
7716157Snate@binkert.org# Set up common yacc/bison flags (needed for Ruby)
7726157Snate@binkert.orgmain['YACCFLAGS'] = '-d'
7736157Snate@binkert.orgmain['YACCHXXFILESUFFIX'] = '.hh'
7746157Snate@binkert.org
7755397Ssaidi@eecs.umich.edu# Do this after we save setting back, or else we'll tack on an
7765397Ssaidi@eecs.umich.edu# extra 'qdo' every time we run scons.
7776121Snate@binkert.orgif main['BATCH']:
7786121Snate@binkert.org    main['CC']     = main['BATCH_CMD'] + ' ' + main['CC']
7796121Snate@binkert.org    main['CXX']    = main['BATCH_CMD'] + ' ' + main['CXX']
7806121Snate@binkert.org    main['AS']     = main['BATCH_CMD'] + ' ' + main['AS']
7816121Snate@binkert.org    main['AR']     = main['BATCH_CMD'] + ' ' + main['AR']
7826121Snate@binkert.org    main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB']
7835397Ssaidi@eecs.umich.edu
7841851SN/Aif sys.platform == 'cygwin':
7851851SN/A    # cygwin has some header file issues...
7867739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=["-Wno-uninitialized"])
787955SN/A
7889396Sandreas.hansson@arm.com# Check for the protobuf compiler
7899396Sandreas.hansson@arm.comprotoc_version = readCommand([main['PROTOC'], '--version'],
7909396Sandreas.hansson@arm.com                             exception='').split()
7919396Sandreas.hansson@arm.com
7929396Sandreas.hansson@arm.com# First two words should be "libprotoc x.y.z"
7939396Sandreas.hansson@arm.comif len(protoc_version) < 2 or protoc_version[0] != 'libprotoc':
7949396Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + \
7959396Sandreas.hansson@arm.com        'Warning: Protocol buffer compiler (protoc) not found.\n' + \
7969396Sandreas.hansson@arm.com        '         Please install protobuf-compiler for tracing support.' + \
7979396Sandreas.hansson@arm.com        termcap.Normal
7989396Sandreas.hansson@arm.com    main['PROTOC'] = False
7999396Sandreas.hansson@arm.comelse:
8009396Sandreas.hansson@arm.com    # Based on the availability of the compress stream wrappers,
8019396Sandreas.hansson@arm.com    # require 2.1.0
8029396Sandreas.hansson@arm.com    min_protoc_version = '2.1.0'
8039396Sandreas.hansson@arm.com    if compareVersions(protoc_version[1], min_protoc_version) < 0:
8049477Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + \
8059477Sandreas.hansson@arm.com            'Warning: protoc version', min_protoc_version, \
8069477Sandreas.hansson@arm.com            'or newer required.\n' + \
8079477Sandreas.hansson@arm.com            '         Installed version:', protoc_version[1], \
8089477Sandreas.hansson@arm.com            termcap.Normal
8099477Sandreas.hansson@arm.com        main['PROTOC'] = False
8109477Sandreas.hansson@arm.com    else:
8119477Sandreas.hansson@arm.com        # Attempt to determine the appropriate include path and
8129477Sandreas.hansson@arm.com        # library path using pkg-config, that means we also need to
8139477Sandreas.hansson@arm.com        # check for pkg-config. Note that it is possible to use
8149477Sandreas.hansson@arm.com        # protobuf without the involvement of pkg-config. Later on we
8159477Sandreas.hansson@arm.com        # check go a library config check and at that point the test
8169477Sandreas.hansson@arm.com        # will fail if libprotobuf cannot be found.
8179477Sandreas.hansson@arm.com        if readCommand(['pkg-config', '--version'], exception=''):
8189477Sandreas.hansson@arm.com            try:
8199477Sandreas.hansson@arm.com                # Attempt to establish what linking flags to add for protobuf
8209477Sandreas.hansson@arm.com                # using pkg-config
8219477Sandreas.hansson@arm.com                main.ParseConfig('pkg-config --cflags --libs-only-L protobuf')
8229477Sandreas.hansson@arm.com            except:
8239477Sandreas.hansson@arm.com                print termcap.Yellow + termcap.Bold + \
8249477Sandreas.hansson@arm.com                    'Warning: pkg-config could not get protobuf flags.' + \
8259477Sandreas.hansson@arm.com                    termcap.Normal
8269396Sandreas.hansson@arm.com
8273053Sstever@eecs.umich.edu# Check for SWIG
8286121Snate@binkert.orgif not main.has_key('SWIG'):
8293053Sstever@eecs.umich.edu    print 'Error: SWIG utility not found.'
8303053Sstever@eecs.umich.edu    print '       Please install (see http://www.swig.org) and retry.'
8313053Sstever@eecs.umich.edu    Exit(1)
8323053Sstever@eecs.umich.edu
8333053Sstever@eecs.umich.edu# Check for appropriate SWIG version
8349072Sandreas.hansson@arm.comswig_version = readCommand([main['SWIG'], '-version'], exception='').split()
8353053Sstever@eecs.umich.edu# First 3 words should be "SWIG Version x.y.z"
8364742Sstever@eecs.umich.eduif len(swig_version) < 3 or \
8374742Sstever@eecs.umich.edu        swig_version[0] != 'SWIG' or swig_version[1] != 'Version':
8383053Sstever@eecs.umich.edu    print 'Error determining SWIG version.'
8393053Sstever@eecs.umich.edu    Exit(1)
8403053Sstever@eecs.umich.edu
84110181SCurtis.Dunham@arm.commin_swig_version = '2.0.4'
8426654Snate@binkert.orgif compareVersions(swig_version[2], min_swig_version) < 0:
8433053Sstever@eecs.umich.edu    print 'Error: SWIG version', min_swig_version, 'or newer required.'
8443053Sstever@eecs.umich.edu    print '       Installed version:', swig_version[2]
8453053Sstever@eecs.umich.edu    Exit(1)
8463053Sstever@eecs.umich.edu
84710425Sandreas.hansson@arm.com# Check for known incompatibilities. The standard library shipped with
84810425Sandreas.hansson@arm.com# gcc >= 4.9 does not play well with swig versions prior to 3.0
84910425Sandreas.hansson@arm.comif main['GCC'] and compareVersions(gcc_version, '4.9') >= 0 and \
85010425Sandreas.hansson@arm.com        compareVersions(swig_version[2], '3.0') < 0:
85110425Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + \
85210425Sandreas.hansson@arm.com        'Warning: This combination of gcc and swig have' + \
85310425Sandreas.hansson@arm.com        ' known incompatibilities.\n' + \
85410425Sandreas.hansson@arm.com        '         If you encounter build problems, please update ' + \
85510425Sandreas.hansson@arm.com        'swig to 3.0 or later.' + \
85610425Sandreas.hansson@arm.com        termcap.Normal
85710425Sandreas.hansson@arm.com
8582667Sstever@eecs.umich.edu# Set up SWIG flags & scanner
8594554Sbinkertn@umich.eduswig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
8606121Snate@binkert.orgmain.Append(SWIGFLAGS=swig_flags)
8612667Sstever@eecs.umich.edu
86210710Sandreas.hansson@arm.com# Check for 'timeout' from GNU coreutils. If present, regressions will
86310710Sandreas.hansson@arm.com# be run with a time limit. We require version 8.13 since we rely on
86410710Sandreas.hansson@arm.com# support for the '--foreground' option.
86510710Sandreas.hansson@arm.comtimeout_lines = readCommand(['timeout', '--version'],
86610710Sandreas.hansson@arm.com                            exception='').splitlines()
86710710Sandreas.hansson@arm.com# Get the first line and tokenize it
86810710Sandreas.hansson@arm.comtimeout_version = timeout_lines[0].split() if timeout_lines else []
86910710Sandreas.hansson@arm.commain['TIMEOUT'] =  timeout_version and \
87010710Sandreas.hansson@arm.com    compareVersions(timeout_version[-1], '8.13') >= 0
87110384SCurtis.Dunham@arm.com
8724554Sbinkertn@umich.edu# filter out all existing swig scanners, they mess up the dependency
8734554Sbinkertn@umich.edu# stuff for some reason
8744554Sbinkertn@umich.eduscanners = []
8756121Snate@binkert.orgfor scanner in main['SCANNERS']:
8764554Sbinkertn@umich.edu    skeys = scanner.skeys
8774554Sbinkertn@umich.edu    if skeys == '.i':
8784554Sbinkertn@umich.edu        continue
8794781Snate@binkert.org
8804554Sbinkertn@umich.edu    if isinstance(skeys, (list, tuple)) and '.i' in skeys:
8814554Sbinkertn@umich.edu        continue
8822667Sstever@eecs.umich.edu
8834554Sbinkertn@umich.edu    scanners.append(scanner)
8844554Sbinkertn@umich.edu
8854554Sbinkertn@umich.edu# add the new swig scanner that we like better
8864554Sbinkertn@umich.edufrom SCons.Scanner import ClassicCPP as CPPScanner
8872667Sstever@eecs.umich.eduswig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
8884554Sbinkertn@umich.eduscanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re))
8892667Sstever@eecs.umich.edu
8904554Sbinkertn@umich.edu# replace the scanners list that has what we want
8916121Snate@binkert.orgmain['SCANNERS'] = scanners
8922667Sstever@eecs.umich.edu
8939986Sandreas@sandberg.pp.se# Add a custom Check function to test for structure members.
8949986Sandreas@sandberg.pp.sedef CheckMember(context, include, decl, member, include_quotes="<>"):
8959986Sandreas@sandberg.pp.se    context.Message("Checking for member %s in %s..." %
8969986Sandreas@sandberg.pp.se                    (member, decl))
8979986Sandreas@sandberg.pp.se    text = """
8989986Sandreas@sandberg.pp.se#include %(header)s
8999986Sandreas@sandberg.pp.seint main(){
9009986Sandreas@sandberg.pp.se  %(decl)s test;
9019986Sandreas@sandberg.pp.se  (void)test.%(member)s;
9029986Sandreas@sandberg.pp.se  return 0;
9039986Sandreas@sandberg.pp.se};
9049986Sandreas@sandberg.pp.se""" % { "header" : include_quotes[0] + include + include_quotes[1],
9059986Sandreas@sandberg.pp.se        "decl" : decl,
9069986Sandreas@sandberg.pp.se        "member" : member,
9079986Sandreas@sandberg.pp.se        }
9089986Sandreas@sandberg.pp.se
9099986Sandreas@sandberg.pp.se    ret = context.TryCompile(text, extension=".cc")
9109986Sandreas@sandberg.pp.se    context.Result(ret)
9119986Sandreas@sandberg.pp.se    return ret
9129986Sandreas@sandberg.pp.se
9132638Sstever@eecs.umich.edu# Platform-specific configuration.  Note again that we assume that all
9142638Sstever@eecs.umich.edu# builds under a given build root run on the same host platform.
9156121Snate@binkert.orgconf = Configure(main,
9163716Sstever@eecs.umich.edu                 conf_dir = joinpath(build_root, '.scons_config'),
9175522Snate@binkert.org                 log_file = joinpath(build_root, 'scons_config.log'),
9189986Sandreas@sandberg.pp.se                 custom_tests = {
9199986Sandreas@sandberg.pp.se        'CheckMember' : CheckMember,
9209986Sandreas@sandberg.pp.se        })
9215522Snate@binkert.org
9225227Ssaidi@eecs.umich.edu# Check if we should compile a 64 bit binary on Mac OS X/Darwin
9235227Ssaidi@eecs.umich.edutry:
9245227Ssaidi@eecs.umich.edu    import platform
9255227Ssaidi@eecs.umich.edu    uname = platform.uname()
9266654Snate@binkert.org    if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0:
9276654Snate@binkert.org        if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
9287769SAli.Saidi@ARM.com            main.Append(CCFLAGS=['-arch', 'x86_64'])
9297769SAli.Saidi@ARM.com            main.Append(CFLAGS=['-arch', 'x86_64'])
9307769SAli.Saidi@ARM.com            main.Append(LINKFLAGS=['-arch', 'x86_64'])
9317769SAli.Saidi@ARM.com            main.Append(ASFLAGS=['-arch', 'x86_64'])
9325227Ssaidi@eecs.umich.eduexcept:
9335227Ssaidi@eecs.umich.edu    pass
9345227Ssaidi@eecs.umich.edu
9355204Sstever@gmail.com# Recent versions of scons substitute a "Null" object for Configure()
9365204Sstever@gmail.com# when configuration isn't necessary, e.g., if the "--help" option is
9375204Sstever@gmail.com# present.  Unfortuantely this Null object always returns false,
9385204Sstever@gmail.com# breaking all our configuration checks.  We replace it with our own
9395204Sstever@gmail.com# more optimistic null object that returns True instead.
9405204Sstever@gmail.comif not conf:
9415204Sstever@gmail.com    def NullCheck(*args, **kwargs):
9425204Sstever@gmail.com        return True
9435204Sstever@gmail.com
9445204Sstever@gmail.com    class NullConf:
9455204Sstever@gmail.com        def __init__(self, env):
9465204Sstever@gmail.com            self.env = env
9475204Sstever@gmail.com        def Finish(self):
9485204Sstever@gmail.com            return self.env
9495204Sstever@gmail.com        def __getattr__(self, mname):
9505204Sstever@gmail.com            return NullCheck
9515204Sstever@gmail.com
9526121Snate@binkert.org    conf = NullConf(main)
9535204Sstever@gmail.com
9547727SAli.Saidi@ARM.com# Cache build files in the supplied directory.
9557727SAli.Saidi@ARM.comif main['M5_BUILD_CACHE']:
9567727SAli.Saidi@ARM.com    print 'Using build cache located at', main['M5_BUILD_CACHE']
9577727SAli.Saidi@ARM.com    CacheDir(main['M5_BUILD_CACHE'])
9587727SAli.Saidi@ARM.com
95910453SAndrew.Bardsley@arm.comif not GetOption('without_python'):
96010453SAndrew.Bardsley@arm.com    # Find Python include and library directories for embedding the
96110453SAndrew.Bardsley@arm.com    # interpreter. We rely on python-config to resolve the appropriate
96210453SAndrew.Bardsley@arm.com    # includes and linker flags. ParseConfig does not seem to understand
96310453SAndrew.Bardsley@arm.com    # the more exotic linker flags such as -Xlinker and -export-dynamic so
96410453SAndrew.Bardsley@arm.com    # we add them explicitly below. If you want to link in an alternate
96510453SAndrew.Bardsley@arm.com    # version of python, see above for instructions on how to invoke
96610453SAndrew.Bardsley@arm.com    # scons with the appropriate PATH set.
96710453SAndrew.Bardsley@arm.com    #
96810453SAndrew.Bardsley@arm.com    # First we check if python2-config exists, else we use python-config
96910453SAndrew.Bardsley@arm.com    python_config = readCommand(['which', 'python2-config'],
97010160Sandreas.hansson@arm.com                                exception='').strip()
97110453SAndrew.Bardsley@arm.com    if not os.path.exists(python_config):
97210453SAndrew.Bardsley@arm.com        python_config = readCommand(['which', 'python-config'],
97310453SAndrew.Bardsley@arm.com                                    exception='').strip()
97410453SAndrew.Bardsley@arm.com    py_includes = readCommand([python_config, '--includes'],
97510453SAndrew.Bardsley@arm.com                              exception='').split()
97610453SAndrew.Bardsley@arm.com    # Strip the -I from the include folders before adding them to the
97710453SAndrew.Bardsley@arm.com    # CPPPATH
97810453SAndrew.Bardsley@arm.com    main.Append(CPPPATH=map(lambda inc: inc[2:], py_includes))
9799812Sandreas.hansson@arm.com
98010453SAndrew.Bardsley@arm.com    # Read the linker flags and split them into libraries and other link
98110453SAndrew.Bardsley@arm.com    # flags. The libraries are added later through the call the CheckLib.
98210453SAndrew.Bardsley@arm.com    py_ld_flags = readCommand([python_config, '--ldflags'],
98310453SAndrew.Bardsley@arm.com        exception='').split()
98410453SAndrew.Bardsley@arm.com    py_libs = []
98510453SAndrew.Bardsley@arm.com    for lib in py_ld_flags:
98610453SAndrew.Bardsley@arm.com         if not lib.startswith('-l'):
98710453SAndrew.Bardsley@arm.com             main.Append(LINKFLAGS=[lib])
98810453SAndrew.Bardsley@arm.com         else:
98910453SAndrew.Bardsley@arm.com             lib = lib[2:]
99010453SAndrew.Bardsley@arm.com             if lib not in py_libs:
99110453SAndrew.Bardsley@arm.com                 py_libs.append(lib)
9927727SAli.Saidi@ARM.com
99310453SAndrew.Bardsley@arm.com    # verify that this stuff works
99410453SAndrew.Bardsley@arm.com    if not conf.CheckHeader('Python.h', '<>'):
99510453SAndrew.Bardsley@arm.com        print "Error: can't find Python.h header in", py_includes
99610453SAndrew.Bardsley@arm.com        print "Install Python headers (package python-dev on Ubuntu and RedHat)"
99710453SAndrew.Bardsley@arm.com        Exit(1)
9983118Sstever@eecs.umich.edu
99910453SAndrew.Bardsley@arm.com    for lib in py_libs:
100010453SAndrew.Bardsley@arm.com        if not conf.CheckLib(lib):
100110453SAndrew.Bardsley@arm.com            print "Error: can't find library %s required by python" % lib
100210453SAndrew.Bardsley@arm.com            Exit(1)
10033118Sstever@eecs.umich.edu
10043483Ssaidi@eecs.umich.edu# On Solaris you need to use libsocket for socket ops
10053494Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
10063494Ssaidi@eecs.umich.edu   if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
10073483Ssaidi@eecs.umich.edu       print "Can't find library with socket calls (e.g. accept())"
10083483Ssaidi@eecs.umich.edu       Exit(1)
10093483Ssaidi@eecs.umich.edu
10103053Sstever@eecs.umich.edu# Check for zlib.  If the check passes, libz will be automatically
10113053Sstever@eecs.umich.edu# added to the LIBS environment variable.
10123918Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
10133053Sstever@eecs.umich.edu    print 'Error: did not find needed zlib compression library '\
10143053Sstever@eecs.umich.edu          'and/or zlib.h header file.'
10153053Sstever@eecs.umich.edu    print '       Please install zlib and try again.'
10163053Sstever@eecs.umich.edu    Exit(1)
10173053Sstever@eecs.umich.edu
10189396Sandreas.hansson@arm.com# If we have the protobuf compiler, also make sure we have the
10199396Sandreas.hansson@arm.com# development libraries. If the check passes, libprotobuf will be
10209396Sandreas.hansson@arm.com# automatically added to the LIBS environment variable. After
10219396Sandreas.hansson@arm.com# this, we can use the HAVE_PROTOBUF flag to determine if we have
10229396Sandreas.hansson@arm.com# got both protoc and libprotobuf available.
10239396Sandreas.hansson@arm.commain['HAVE_PROTOBUF'] = main['PROTOC'] and \
10249396Sandreas.hansson@arm.com    conf.CheckLibWithHeader('protobuf', 'google/protobuf/message.h',
10259396Sandreas.hansson@arm.com                            'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;')
10269396Sandreas.hansson@arm.com
10279477Sandreas.hansson@arm.com# If we have the compiler but not the library, print another warning.
10289396Sandreas.hansson@arm.comif main['PROTOC'] and not main['HAVE_PROTOBUF']:
10299477Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + \
10309477Sandreas.hansson@arm.com        'Warning: did not find protocol buffer library and/or headers.\n' + \
10319477Sandreas.hansson@arm.com    '       Please install libprotobuf-dev for tracing support.' + \
10329477Sandreas.hansson@arm.com    termcap.Normal
10339396Sandreas.hansson@arm.com
10347840Snate@binkert.org# Check for librt.
10357865Sgblack@eecs.umich.eduhave_posix_clock = \
10367865Sgblack@eecs.umich.edu    conf.CheckLibWithHeader(None, 'time.h', 'C',
10377865Sgblack@eecs.umich.edu                            'clock_nanosleep(0,0,NULL,NULL);') or \
10387865Sgblack@eecs.umich.edu    conf.CheckLibWithHeader('rt', 'time.h', 'C',
10397865Sgblack@eecs.umich.edu                            'clock_nanosleep(0,0,NULL,NULL);')
10407840Snate@binkert.org
10419900Sandreas@sandberg.pp.sehave_posix_timers = \
10429900Sandreas@sandberg.pp.se    conf.CheckLibWithHeader([None, 'rt'], [ 'time.h', 'signal.h' ], 'C',
10439900Sandreas@sandberg.pp.se                            'timer_create(CLOCK_MONOTONIC, NULL, NULL);')
10449900Sandreas@sandberg.pp.se
104510456SCurtis.Dunham@arm.comif not GetOption('without_tcmalloc'):
104610456SCurtis.Dunham@arm.com    if conf.CheckLib('tcmalloc'):
104710456SCurtis.Dunham@arm.com        main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS'])
104810456SCurtis.Dunham@arm.com    elif conf.CheckLib('tcmalloc_minimal'):
104910456SCurtis.Dunham@arm.com        main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS'])
105010456SCurtis.Dunham@arm.com    else:
105110456SCurtis.Dunham@arm.com        print termcap.Yellow + termcap.Bold + \
105210456SCurtis.Dunham@arm.com              "You can get a 12% performance improvement by "\
105310456SCurtis.Dunham@arm.com              "installing tcmalloc (libgoogle-perftools-dev package "\
105410456SCurtis.Dunham@arm.com              "on Ubuntu or RedHat)." + termcap.Normal
10559045SAli.Saidi@ARM.com
105611235Sandreas.sandberg@arm.com
105711235Sandreas.sandberg@arm.com# Detect back trace implementations. The last implementation in the
105811235Sandreas.sandberg@arm.com# list will be used by default.
105911235Sandreas.sandberg@arm.combacktrace_impls = [ "none" ]
106011235Sandreas.sandberg@arm.com
106111235Sandreas.sandberg@arm.comif conf.CheckLibWithHeader(None, 'execinfo.h', 'C',
106211235Sandreas.sandberg@arm.com                           'backtrace_symbols_fd((void*)0, 0, 0);'):
106311235Sandreas.sandberg@arm.com    backtrace_impls.append("glibc")
106411235Sandreas.sandberg@arm.com
106511235Sandreas.sandberg@arm.comif backtrace_impls[-1] == "none":
106611235Sandreas.sandberg@arm.com    default_backtrace_impl = "none"
106711235Sandreas.sandberg@arm.com    print termcap.Yellow + termcap.Bold + \
106811235Sandreas.sandberg@arm.com        "No suitable back trace implementation found." + \
106911235Sandreas.sandberg@arm.com        termcap.Normal
107011235Sandreas.sandberg@arm.com
10717840Snate@binkert.orgif not have_posix_clock:
10727840Snate@binkert.org    print "Can't find library for POSIX clocks."
10737840Snate@binkert.org
10741858SN/A# Check for <fenv.h> (C99 FP environment control)
10751858SN/Ahave_fenv = conf.CheckHeader('fenv.h', '<>')
10761858SN/Aif not have_fenv:
10771858SN/A    print "Warning: Header file <fenv.h> not found."
10781858SN/A    print "         This host has no IEEE FP rounding mode control."
10791858SN/A
10809903Sandreas.hansson@arm.com# Check if we should enable KVM-based hardware virtualization. The API
10819903Sandreas.hansson@arm.com# we rely on exists since version 2.6.36 of the kernel, but somehow
10829903Sandreas.hansson@arm.com# the KVM_API_VERSION does not reflect the change. We test for one of
10839903Sandreas.hansson@arm.com# the types as a fall back.
108410841Sandreas.sandberg@arm.comhave_kvm = conf.CheckHeader('linux/kvm.h', '<>')
10859651SAndreas.Sandberg@ARM.comif not have_kvm:
10869903Sandreas.hansson@arm.com    print "Info: Compatible header file <linux/kvm.h> not found, " \
10879651SAndreas.Sandberg@ARM.com        "disabling KVM support."
10889651SAndreas.Sandberg@ARM.com
108910841Sandreas.sandberg@arm.com# x86 needs support for xsave. We test for the structure here since we
109010841Sandreas.sandberg@arm.com# won't be able to run new tests by the time we know which ISA we're
109110841Sandreas.sandberg@arm.com# targeting.
109210841Sandreas.sandberg@arm.comhave_kvm_xsave = conf.CheckTypeSize('struct kvm_xsave',
109310841Sandreas.sandberg@arm.com                                    '#include <linux/kvm.h>') != 0
109410841Sandreas.sandberg@arm.com
10959651SAndreas.Sandberg@ARM.com# Check if the requested target ISA is compatible with the host
10969651SAndreas.Sandberg@ARM.comdef is_isa_kvm_compatible(isa):
10979651SAndreas.Sandberg@ARM.com    try:
10989651SAndreas.Sandberg@ARM.com        import platform
10999651SAndreas.Sandberg@ARM.com        host_isa = platform.machine()
11009651SAndreas.Sandberg@ARM.com    except:
11019651SAndreas.Sandberg@ARM.com        print "Warning: Failed to determine host ISA."
11029651SAndreas.Sandberg@ARM.com        return False
11039651SAndreas.Sandberg@ARM.com
110410841Sandreas.sandberg@arm.com    if not have_posix_timers:
110510841Sandreas.sandberg@arm.com        print "Warning: Can not enable KVM, host seems to lack support " \
110610841Sandreas.sandberg@arm.com            "for POSIX timers"
110710841Sandreas.sandberg@arm.com        return False
110810841Sandreas.sandberg@arm.com
110910841Sandreas.sandberg@arm.com    if isa == "arm":
111010860Sandreas.sandberg@arm.com        return host_isa in ( "armv7l", "aarch64" )
111110841Sandreas.sandberg@arm.com    elif isa == "x86":
111210841Sandreas.sandberg@arm.com        if host_isa != "x86_64":
111310841Sandreas.sandberg@arm.com            return False
111410841Sandreas.sandberg@arm.com
111510841Sandreas.sandberg@arm.com        if not have_kvm_xsave:
111610841Sandreas.sandberg@arm.com            print "KVM on x86 requires xsave support in kernel headers."
111710841Sandreas.sandberg@arm.com            return False
111810841Sandreas.sandberg@arm.com
111910841Sandreas.sandberg@arm.com        return True
112010841Sandreas.sandberg@arm.com    else:
112110841Sandreas.sandberg@arm.com        return False
11229651SAndreas.Sandberg@ARM.com
11239651SAndreas.Sandberg@ARM.com
11249986Sandreas@sandberg.pp.se# Check if the exclude_host attribute is available. We want this to
11259986Sandreas@sandberg.pp.se# get accurate instruction counts in KVM.
11269986Sandreas@sandberg.pp.semain['HAVE_PERF_ATTR_EXCLUDE_HOST'] = conf.CheckMember(
11279986Sandreas@sandberg.pp.se    'linux/perf_event.h', 'struct perf_event_attr', 'exclude_host')
11289986Sandreas@sandberg.pp.se
11299986Sandreas@sandberg.pp.se
11305863Snate@binkert.org######################################################################
11315863Snate@binkert.org#
11325863Snate@binkert.org# Finish the configuration
11335863Snate@binkert.org#
11346121Snate@binkert.orgmain = conf.Finish()
11351858SN/A
11365863Snate@binkert.org######################################################################
11375863Snate@binkert.org#
11385863Snate@binkert.org# Collect all non-global variables
11395863Snate@binkert.org#
11405863Snate@binkert.org
11412139SN/A# Define the universe of supported ISAs
11424202Sbinkertn@umich.eduall_isa_list = [ ]
114311308Santhony.gutierrez@amd.comall_gpu_isa_list = [ ]
11444202Sbinkertn@umich.eduExport('all_isa_list')
114511308Santhony.gutierrez@amd.comExport('all_gpu_isa_list')
11462139SN/A
11476994Snate@binkert.orgclass CpuModel(object):
11486994Snate@binkert.org    '''The CpuModel class encapsulates everything the ISA parser needs to
11496994Snate@binkert.org    know about a particular CPU model.'''
11506994Snate@binkert.org
11516994Snate@binkert.org    # Dict of available CPU model objects.  Accessible as CpuModel.dict.
11526994Snate@binkert.org    dict = {}
11536994Snate@binkert.org
11546994Snate@binkert.org    # Constructor.  Automatically adds models to CpuModel.dict.
115510319SAndreas.Sandberg@ARM.com    def __init__(self, name, default=False):
11566994Snate@binkert.org        self.name = name           # name of model
11576994Snate@binkert.org
11586994Snate@binkert.org        # This cpu is enabled by default
11596994Snate@binkert.org        self.default = default
11606994Snate@binkert.org
11616994Snate@binkert.org        # Add self to dict
11626994Snate@binkert.org        if name in CpuModel.dict:
11636994Snate@binkert.org            raise AttributeError, "CpuModel '%s' already registered" % name
11646994Snate@binkert.org        CpuModel.dict[name] = self
11656994Snate@binkert.org
11666994Snate@binkert.orgExport('CpuModel')
11672155SN/A
11685863Snate@binkert.org# Sticky variables get saved in the variables file so they persist from
11691869SN/A# one invocation to the next (unless overridden, in which case the new
11701869SN/A# value becomes sticky).
11715863Snate@binkert.orgsticky_vars = Variables(args=ARGUMENTS)
11725863Snate@binkert.orgExport('sticky_vars')
11734202Sbinkertn@umich.edu
11746108Snate@binkert.org# Sticky variables that should be exported
11756108Snate@binkert.orgexport_vars = []
11766108Snate@binkert.orgExport('export_vars')
11776108Snate@binkert.org
11789219Spower.jg@gmail.com# For Ruby
11799219Spower.jg@gmail.comall_protocols = []
11809219Spower.jg@gmail.comExport('all_protocols')
11819219Spower.jg@gmail.comprotocol_dirs = []
11829219Spower.jg@gmail.comExport('protocol_dirs')
11839219Spower.jg@gmail.comslicc_includes = []
11849219Spower.jg@gmail.comExport('slicc_includes')
11859219Spower.jg@gmail.com
11864202Sbinkertn@umich.edu# Walk the tree and execute all SConsopts scripts that wil add to the
11875863Snate@binkert.org# above variables
118810135SCurtis.Dunham@arm.comif GetOption('verbose'):
11898474Sgblack@eecs.umich.edu    print "Reading SConsopts"
11905742Snate@binkert.orgfor bdir in [ base_dir ] + extras_dir_list:
11918268Ssteve.reinhardt@amd.com    if not isdir(bdir):
11928268Ssteve.reinhardt@amd.com        print "Error: directory '%s' does not exist" % bdir
11938268Ssteve.reinhardt@amd.com        Exit(1)
11945742Snate@binkert.org    for root, dirs, files in os.walk(bdir):
11955341Sstever@gmail.com        if 'SConsopts' in files:
11968474Sgblack@eecs.umich.edu            if GetOption('verbose'):
11978474Sgblack@eecs.umich.edu                print "Reading", joinpath(root, 'SConsopts')
11985342Sstever@gmail.com            SConscript(joinpath(root, 'SConsopts'))
11994202Sbinkertn@umich.edu
12004202Sbinkertn@umich.eduall_isa_list.sort()
120111308Santhony.gutierrez@amd.comall_gpu_isa_list.sort()
12024202Sbinkertn@umich.edu
12035863Snate@binkert.orgsticky_vars.AddVariables(
12045863Snate@binkert.org    EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list),
120511308Santhony.gutierrez@amd.com    EnumVariable('TARGET_GPU_ISA', 'Target GPU ISA', 'hsail', all_gpu_isa_list),
12066994Snate@binkert.org    ListVariable('CPU_MODELS', 'CPU models',
12076994Snate@binkert.org                 sorted(n for n,m in CpuModel.dict.iteritems() if m.default),
120810319SAndreas.Sandberg@ARM.com                 sorted(CpuModel.dict.keys())),
12095863Snate@binkert.org    BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
12105863Snate@binkert.org                 False),
12115863Snate@binkert.org    BoolVariable('SS_COMPATIBLE_FP',
12125863Snate@binkert.org                 'Make floating-point results compatible with SimpleScalar',
12135863Snate@binkert.org                 False),
12145863Snate@binkert.org    BoolVariable('USE_SSE2',
12155863Snate@binkert.org                 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
12165863Snate@binkert.org                 False),
12177840Snate@binkert.org    BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock),
12185863Snate@binkert.org    BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
12195952Ssaidi@eecs.umich.edu    BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False),
12209651SAndreas.Sandberg@ARM.com    BoolVariable('USE_KVM', 'Enable hardware virtualized (KVM) CPU models', have_kvm),
122111308Santhony.gutierrez@amd.com    BoolVariable('BUILD_GPU', 'Build the compute-GPU model', False),
12229219Spower.jg@gmail.com    EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None',
12239219Spower.jg@gmail.com                  all_protocols),
122411235Sandreas.sandberg@arm.com    EnumVariable('BACKTRACE_IMPL', 'Post-mortem dump implementation',
122511235Sandreas.sandberg@arm.com                 backtrace_impls[-1], backtrace_impls)
12261869SN/A    )
12271858SN/A
12285863Snate@binkert.org# These variables get exported to #defines in config/*.hh (see src/SConscript).
122911308Santhony.gutierrez@amd.comexport_vars += ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'TARGET_GPU_ISA',
123011308Santhony.gutierrez@amd.com                'CP_ANNOTATE', 'USE_POSIX_CLOCK', 'USE_KVM', 'PROTOCOL',
123111308Santhony.gutierrez@amd.com                'HAVE_PROTOBUF', 'HAVE_PERF_ATTR_EXCLUDE_HOST']
12321858SN/A
1233955SN/A###################################################
1234955SN/A#
12351869SN/A# Define a SCons builder for configuration flag headers.
12361869SN/A#
12371869SN/A###################################################
12381869SN/A
12391869SN/A# This function generates a config header file that #defines the
12405863Snate@binkert.org# variable symbol to the current variable setting (0 or 1).  The source
12415863Snate@binkert.org# operands are the name of the variable and a Value node containing the
12425863Snate@binkert.org# value of the variable.
12431869SN/Adef build_config_file(target, source, env):
12445863Snate@binkert.org    (variable, value) = [s.get_contents() for s in source]
12451869SN/A    f = file(str(target[0]), 'w')
12465863Snate@binkert.org    print >> f, '#define', variable, value
12471869SN/A    f.close()
12481869SN/A    return None
12491869SN/A
12501869SN/A# Combine the two functions into a scons Action object.
12518483Sgblack@eecs.umich.educonfig_action = MakeAction(build_config_file, Transform("CONFIG H", 2))
12521869SN/A
12531869SN/A# The emitter munges the source & target node lists to reflect what
12541869SN/A# we're really doing.
12551869SN/Adef config_emitter(target, source, env):
12565863Snate@binkert.org    # extract variable name from Builder arg
12575863Snate@binkert.org    variable = str(target[0])
12581869SN/A    # True target is config header file
12595863Snate@binkert.org    target = joinpath('config', variable.lower() + '.hh')
12605863Snate@binkert.org    val = env[variable]
12613356Sbinkertn@umich.edu    if isinstance(val, bool):
12623356Sbinkertn@umich.edu        # Force value to 0/1
12633356Sbinkertn@umich.edu        val = int(val)
12643356Sbinkertn@umich.edu    elif isinstance(val, str):
12653356Sbinkertn@umich.edu        val = '"' + val + '"'
12664781Snate@binkert.org
12675863Snate@binkert.org    # Sources are variable name & value (packaged in SCons Value nodes)
12685863Snate@binkert.org    return ([target], [Value(variable), Value(val)])
12691869SN/A
12701869SN/Aconfig_builder = Builder(emitter = config_emitter, action = config_action)
12711869SN/A
12726121Snate@binkert.orgmain.Append(BUILDERS = { 'ConfigFile' : config_builder })
12731869SN/A
12742638Sstever@eecs.umich.edu# libelf build is shared across all configs in the build root.
12756121Snate@binkert.orgmain.SConscript('ext/libelf/SConscript',
12766121Snate@binkert.org                variant_dir = joinpath(build_root, 'libelf'))
12772638Sstever@eecs.umich.edu
127811293Sandreas.hansson@arm.com# iostream3 build is shared across all configs in the build root.
127911293Sandreas.hansson@arm.commain.SConscript('ext/iostream3/SConscript',
128011293Sandreas.hansson@arm.com                variant_dir = joinpath(build_root, 'iostream3'))
12815749Scws3k@cs.virginia.edu
12829537Satgutier@umich.edu# libfdt build is shared across all configs in the build root.
12839537Satgutier@umich.edumain.SConscript('ext/libfdt/SConscript',
12849537Satgutier@umich.edu                variant_dir = joinpath(build_root, 'libfdt'))
12859537Satgutier@umich.edu
12869888Sandreas@sandberg.pp.se# fputils build is shared across all configs in the build root.
12879888Sandreas@sandberg.pp.semain.SConscript('ext/fputils/SConscript',
12889888Sandreas@sandberg.pp.se                variant_dir = joinpath(build_root, 'fputils'))
12899888Sandreas@sandberg.pp.se
129010066Sandreas.hansson@arm.com# DRAMSim2 build is shared across all configs in the build root.
129110066Sandreas.hansson@arm.commain.SConscript('ext/dramsim2/SConscript',
129210066Sandreas.hansson@arm.com                variant_dir = joinpath(build_root, 'dramsim2'))
129310066Sandreas.hansson@arm.com
129410428Sandreas.hansson@arm.com# DRAMPower build is shared across all configs in the build root.
129510428Sandreas.hansson@arm.commain.SConscript('ext/drampower/SConscript',
129610428Sandreas.hansson@arm.com                variant_dir = joinpath(build_root, 'drampower'))
129710428Sandreas.hansson@arm.com
129810915Sandreas.sandberg@arm.com# nomali build is shared across all configs in the build root.
129910915Sandreas.sandberg@arm.commain.SConscript('ext/nomali/SConscript',
130010915Sandreas.sandberg@arm.com                variant_dir = joinpath(build_root, 'nomali'))
130110915Sandreas.sandberg@arm.com
13021869SN/A###################################################
13031869SN/A#
13043546Sgblack@eecs.umich.edu# This function is used to set up a directory with switching headers
13053546Sgblack@eecs.umich.edu#
13063546Sgblack@eecs.umich.edu###################################################
13073546Sgblack@eecs.umich.edu
13086121Snate@binkert.orgmain['ALL_ISA_LIST'] = all_isa_list
130911308Santhony.gutierrez@amd.commain['ALL_GPU_ISA_LIST'] = all_gpu_isa_list
131010196SCurtis.Dunham@arm.comall_isa_deps = {}
13115863Snate@binkert.orgdef make_switching_dir(dname, switch_headers, env):
13123546Sgblack@eecs.umich.edu    # Generate the header.  target[0] is the full path of the output
13133546Sgblack@eecs.umich.edu    # header to generate.  'source' is a dummy variable, since we get the
13143546Sgblack@eecs.umich.edu    # list of ISAs from env['ALL_ISA_LIST'].
13153546Sgblack@eecs.umich.edu    def gen_switch_hdr(target, source, env):
13164781Snate@binkert.org        fname = str(target[0])
13176658Snate@binkert.org        isa = env['TARGET_ISA'].lower()
131810196SCurtis.Dunham@arm.com        try:
131910196SCurtis.Dunham@arm.com            f = open(fname, 'w')
132010196SCurtis.Dunham@arm.com            print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname))
132110196SCurtis.Dunham@arm.com            f.close()
132210196SCurtis.Dunham@arm.com        except IOError:
132310196SCurtis.Dunham@arm.com            print "Failed to create %s" % fname
132410196SCurtis.Dunham@arm.com            raise
13253546Sgblack@eecs.umich.edu
13263546Sgblack@eecs.umich.edu    # Build SCons Action object. 'varlist' specifies env vars that this
13273546Sgblack@eecs.umich.edu    # action depends on; when env['ALL_ISA_LIST'] changes these actions
13283546Sgblack@eecs.umich.edu    # should get re-executed.
13297756SAli.Saidi@ARM.com    switch_hdr_action = MakeAction(gen_switch_hdr,
13307816Ssteve.reinhardt@amd.com                          Transform("GENERATE"), varlist=['ALL_ISA_LIST'])
13313546Sgblack@eecs.umich.edu
13323546Sgblack@eecs.umich.edu    # Instantiate actions for each header
13333546Sgblack@eecs.umich.edu    for hdr in switch_headers:
13343546Sgblack@eecs.umich.edu        env.Command(hdr, [], switch_hdr_action)
133510196SCurtis.Dunham@arm.com
133610196SCurtis.Dunham@arm.com    isa_target = Dir('.').up().name.lower().replace('_', '-')
133710196SCurtis.Dunham@arm.com    env['PHONY_BASE'] = '#'+isa_target
133810196SCurtis.Dunham@arm.com    all_isa_deps[isa_target] = None
133910196SCurtis.Dunham@arm.com
13404202Sbinkertn@umich.eduExport('make_switching_dir')
13413546Sgblack@eecs.umich.edu
134211308Santhony.gutierrez@amd.comdef make_gpu_switching_dir(dname, switch_headers, env):
134311308Santhony.gutierrez@amd.com    # Generate the header.  target[0] is the full path of the output
134411308Santhony.gutierrez@amd.com    # header to generate.  'source' is a dummy variable, since we get the
134511308Santhony.gutierrez@amd.com    # list of ISAs from env['ALL_ISA_LIST'].
134611308Santhony.gutierrez@amd.com    def gen_switch_hdr(target, source, env):
134711308Santhony.gutierrez@amd.com        fname = str(target[0])
134811308Santhony.gutierrez@amd.com
134911308Santhony.gutierrez@amd.com        isa = env['TARGET_GPU_ISA'].lower()
135011308Santhony.gutierrez@amd.com
135111308Santhony.gutierrez@amd.com        try:
135211308Santhony.gutierrez@amd.com            f = open(fname, 'w')
135311308Santhony.gutierrez@amd.com            print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname))
135411308Santhony.gutierrez@amd.com            f.close()
135511308Santhony.gutierrez@amd.com        except IOError:
135611308Santhony.gutierrez@amd.com            print "Failed to create %s" % fname
135711308Santhony.gutierrez@amd.com            raise
135811308Santhony.gutierrez@amd.com
135911308Santhony.gutierrez@amd.com    # Build SCons Action object. 'varlist' specifies env vars that this
136011308Santhony.gutierrez@amd.com    # action depends on; when env['ALL_ISA_LIST'] changes these actions
136111308Santhony.gutierrez@amd.com    # should get re-executed.
136211308Santhony.gutierrez@amd.com    switch_hdr_action = MakeAction(gen_switch_hdr,
136311308Santhony.gutierrez@amd.com                          Transform("GENERATE"), varlist=['ALL_ISA_GPU_LIST'])
136411308Santhony.gutierrez@amd.com
136511308Santhony.gutierrez@amd.com    # Instantiate actions for each header
136611308Santhony.gutierrez@amd.com    for hdr in switch_headers:
136711308Santhony.gutierrez@amd.com        env.Command(hdr, [], switch_hdr_action)
136811308Santhony.gutierrez@amd.com
136911308Santhony.gutierrez@amd.comExport('make_gpu_switching_dir')
137011308Santhony.gutierrez@amd.com
137110196SCurtis.Dunham@arm.com# all-isas -> all-deps -> all-environs -> all_targets
137210196SCurtis.Dunham@arm.commain.Alias('#all-isas', [])
137310196SCurtis.Dunham@arm.commain.Alias('#all-deps', '#all-isas')
137410196SCurtis.Dunham@arm.com
137510196SCurtis.Dunham@arm.com# Dummy target to ensure all environments are created before telling
137610196SCurtis.Dunham@arm.com# SCons what to actually make (the command line arguments).  We attach
137710196SCurtis.Dunham@arm.com# them to the dependence graph after the environments are complete.
137810196SCurtis.Dunham@arm.comORIG_BUILD_TARGETS = list(BUILD_TARGETS) # force a copy; gets closure to work.
137910196SCurtis.Dunham@arm.comdef environsComplete(target, source, env):
138010196SCurtis.Dunham@arm.com    for t in ORIG_BUILD_TARGETS:
138110196SCurtis.Dunham@arm.com        main.Depends('#all-targets', t)
138210196SCurtis.Dunham@arm.com
138310196SCurtis.Dunham@arm.com# Each build/* switching_dir attaches its *-environs target to #all-environs.
138410196SCurtis.Dunham@arm.commain.Append(BUILDERS = {'CompleteEnvirons' :
138510196SCurtis.Dunham@arm.com                        Builder(action=MakeAction(environsComplete, None))})
138610196SCurtis.Dunham@arm.commain.CompleteEnvirons('#all-environs', [])
138710196SCurtis.Dunham@arm.com
138810196SCurtis.Dunham@arm.comdef doNothing(**ignored): pass
138910196SCurtis.Dunham@arm.commain.Append(BUILDERS = {'Dummy': Builder(action=MakeAction(doNothing, None))})
139010196SCurtis.Dunham@arm.com
139110196SCurtis.Dunham@arm.com# The final target to which all the original targets ultimately get attached.
139210196SCurtis.Dunham@arm.commain.Dummy('#all-targets', '#all-environs')
139310196SCurtis.Dunham@arm.comBUILD_TARGETS[:] = ['#all-targets']
139410196SCurtis.Dunham@arm.com
13953546Sgblack@eecs.umich.edu###################################################
13963546Sgblack@eecs.umich.edu#
1397955SN/A# Define build environments for selected configurations.
1398955SN/A#
1399955SN/A###################################################
1400955SN/A
14015863Snate@binkert.orgfor variant_path in variant_paths:
140210135SCurtis.Dunham@arm.com    if not GetOption('silent'):
140310135SCurtis.Dunham@arm.com        print "Building in", variant_path
14045343Sstever@gmail.com
14055343Sstever@gmail.com    # Make a copy of the build-root environment to use for this config.
14066121Snate@binkert.org    env = main.Clone()
14075863Snate@binkert.org    env['BUILDDIR'] = variant_path
14084773Snate@binkert.org
14095863Snate@binkert.org    # variant_dir is the tail component of build path, and is used to
14102632Sstever@eecs.umich.edu    # determine the build parameters (e.g., 'ALPHA_SE')
14115863Snate@binkert.org    (build_root, variant_dir) = splitpath(variant_path)
14122023SN/A
14135863Snate@binkert.org    # Set env variables according to the build directory config.
14145863Snate@binkert.org    sticky_vars.files = []
14155863Snate@binkert.org    # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
14165863Snate@binkert.org    # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
14175863Snate@binkert.org    # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
14185863Snate@binkert.org    current_vars_file = joinpath(build_root, 'variables', variant_dir)
14195863Snate@binkert.org    if isfile(current_vars_file):
14205863Snate@binkert.org        sticky_vars.files.append(current_vars_file)
142110135SCurtis.Dunham@arm.com        if not GetOption('silent'):
142210135SCurtis.Dunham@arm.com            print "Using saved variables file %s" % current_vars_file
14232632Sstever@eecs.umich.edu    else:
14245863Snate@binkert.org        # Build dir-specific variables file doesn't exist.
14252023SN/A
14262632Sstever@eecs.umich.edu        # Make sure the directory is there so we can create it later
14275863Snate@binkert.org        opt_dir = dirname(current_vars_file)
14285342Sstever@gmail.com        if not isdir(opt_dir):
14295863Snate@binkert.org            mkdir(opt_dir)
14302632Sstever@eecs.umich.edu
14315863Snate@binkert.org        # Get default build variables from source tree.  Variables are
14325863Snate@binkert.org        # normally determined by name of $VARIANT_DIR, but can be
14338267Ssteve.reinhardt@amd.com        # overridden by '--default=' arg on command line.
14348120Sgblack@eecs.umich.edu        default = GetOption('default')
14358267Ssteve.reinhardt@amd.com        opts_dir = joinpath(main.root.abspath, 'build_opts')
14368267Ssteve.reinhardt@amd.com        if default:
14378267Ssteve.reinhardt@amd.com            default_vars_files = [joinpath(build_root, 'variables', default),
14388267Ssteve.reinhardt@amd.com                                  joinpath(opts_dir, default)]
14398267Ssteve.reinhardt@amd.com        else:
14408267Ssteve.reinhardt@amd.com            default_vars_files = [joinpath(opts_dir, variant_dir)]
14418267Ssteve.reinhardt@amd.com        existing_files = filter(isfile, default_vars_files)
14428267Ssteve.reinhardt@amd.com        if existing_files:
14438267Ssteve.reinhardt@amd.com            default_vars_file = existing_files[0]
14445863Snate@binkert.org            sticky_vars.files.append(default_vars_file)
14455863Snate@binkert.org            print "Variables file %s not found,\n  using defaults in %s" \
14465863Snate@binkert.org                  % (current_vars_file, default_vars_file)
14472632Sstever@eecs.umich.edu        else:
14488267Ssteve.reinhardt@amd.com            print "Error: cannot find variables file %s or " \
14498267Ssteve.reinhardt@amd.com                  "default file(s) %s" \
14508267Ssteve.reinhardt@amd.com                  % (current_vars_file, ' or '.join(default_vars_files))
14512632Sstever@eecs.umich.edu            Exit(1)
14521888SN/A
14535863Snate@binkert.org    # Apply current variable settings to env
14545863Snate@binkert.org    sticky_vars.Update(env)
14551858SN/A
14568120Sgblack@eecs.umich.edu    help_texts["local_vars"] += \
14578120Sgblack@eecs.umich.edu        "Build variables for %s:\n" % variant_dir \
14587756SAli.Saidi@ARM.com                 + sticky_vars.GenerateHelpText(env)
14592598SN/A
14605863Snate@binkert.org    # Process variable settings.
14611858SN/A
14621858SN/A    if not have_fenv and env['USE_FENV']:
14631858SN/A        print "Warning: <fenv.h> not available; " \
14645863Snate@binkert.org              "forcing USE_FENV to False in", variant_dir + "."
14651858SN/A        env['USE_FENV'] = False
14661858SN/A
14671858SN/A    if not env['USE_FENV']:
14685863Snate@binkert.org        print "Warning: No IEEE FP rounding mode control in", variant_dir + "."
14691871SN/A        print "         FP results may deviate slightly from other platforms."
14701858SN/A
14711858SN/A    if env['EFENCE']:
14721858SN/A        env.Append(LIBS=['efence'])
14731858SN/A
14749651SAndreas.Sandberg@ARM.com    if env['USE_KVM']:
14759651SAndreas.Sandberg@ARM.com        if not have_kvm:
14769651SAndreas.Sandberg@ARM.com            print "Warning: Can not enable KVM, host seems to lack KVM support"
14779651SAndreas.Sandberg@ARM.com            env['USE_KVM'] = False
14789651SAndreas.Sandberg@ARM.com        elif not is_isa_kvm_compatible(env['TARGET_ISA']):
14799651SAndreas.Sandberg@ARM.com            print "Info: KVM support disabled due to unsupported host and " \
14809651SAndreas.Sandberg@ARM.com                "target ISA combination"
14819651SAndreas.Sandberg@ARM.com            env['USE_KVM'] = False
14829651SAndreas.Sandberg@ARM.com
14839986Sandreas@sandberg.pp.se    # Warn about missing optional functionality
14849986Sandreas@sandberg.pp.se    if env['USE_KVM']:
14859986Sandreas@sandberg.pp.se        if not main['HAVE_PERF_ATTR_EXCLUDE_HOST']:
14869986Sandreas@sandberg.pp.se            print "Warning: perf_event headers lack support for the " \
14879986Sandreas@sandberg.pp.se                "exclude_host attribute. KVM instruction counts will " \
14889986Sandreas@sandberg.pp.se                "be inaccurate."
14899986Sandreas@sandberg.pp.se
14905863Snate@binkert.org    # Save sticky variable settings back to current variables file
14915863Snate@binkert.org    sticky_vars.Save(current_vars_file, env)
14921869SN/A
14931965SN/A    if env['USE_SSE2']:
14947739Sgblack@eecs.umich.edu        env.Append(CCFLAGS=['-msse2'])
14951965SN/A
14962761Sstever@eecs.umich.edu    # The src/SConscript file sets up the build rules in 'env' according
14975863Snate@binkert.org    # to the configured variables.  It returns a list of environments,
14981869SN/A    # one for each variant build (debug, opt, etc.)
149910196SCurtis.Dunham@arm.com    SConscript('src/SConscript', variant_dir = variant_path, exports = 'env')
15001869SN/A
150110196SCurtis.Dunham@arm.comdef pairwise(iterable):
150210196SCurtis.Dunham@arm.com    "s -> (s0,s1), (s1,s2), (s2, s3), ..."
150310196SCurtis.Dunham@arm.com    a, b = itertools.tee(iterable)
150410196SCurtis.Dunham@arm.com    b.next()
150510196SCurtis.Dunham@arm.com    return itertools.izip(a, b)
150610196SCurtis.Dunham@arm.com
150710196SCurtis.Dunham@arm.com# Create false dependencies so SCons will parse ISAs, establish
150810196SCurtis.Dunham@arm.com# dependencies, and setup the build Environments serially. Either
150910196SCurtis.Dunham@arm.com# SCons (likely) and/or our SConscripts (possibly) cannot cope with -j
151010196SCurtis.Dunham@arm.com# greater than 1. It appears to be standard race condition stuff; it
151110196SCurtis.Dunham@arm.com# doesn't always fail, but usually, and the behaviors are different.
151210196SCurtis.Dunham@arm.com# Every time I tried to remove this, builds would fail in some
151310196SCurtis.Dunham@arm.com# creative new way. So, don't do that. You'll want to, though, because
151410196SCurtis.Dunham@arm.com# tests/SConscript takes a long time to make its Environments.
151510196SCurtis.Dunham@arm.comfor t1, t2 in pairwise(sorted(all_isa_deps.iterkeys())):
151610196SCurtis.Dunham@arm.com    main.Depends('#%s-deps'     % t2, '#%s-deps'     % t1)
151710196SCurtis.Dunham@arm.com    main.Depends('#%s-environs' % t2, '#%s-environs' % t1)
1518955SN/A
15198120Sgblack@eecs.umich.edu# base help text
15208120Sgblack@eecs.umich.eduHelp('''
15218120Sgblack@eecs.umich.eduUsage: scons [scons options] [build variables] [target(s)]
15228120Sgblack@eecs.umich.edu
15238120Sgblack@eecs.umich.eduExtra scons options:
15248120Sgblack@eecs.umich.edu%(options)s
15258120Sgblack@eecs.umich.edu
15268120Sgblack@eecs.umich.eduGlobal build variables:
15278120Sgblack@eecs.umich.edu%(global_vars)s
15288120Sgblack@eecs.umich.edu
15298120Sgblack@eecs.umich.edu%(local_vars)s
15308120Sgblack@eecs.umich.edu''' % help_texts)
1531