SConstruct revision 11811
1955SN/A# -*- mode:python -*-
2955SN/A
311408Sandreas.sandberg@arm.com# Copyright (c) 2013, 2015, 2016 ARM Limited
49812Sandreas.hansson@arm.com# All rights reserved.
59812Sandreas.hansson@arm.com#
69812Sandreas.hansson@arm.com# The license below extends only to copyright in the software and shall
79812Sandreas.hansson@arm.com# not be construed as granting a license to any other intellectual
89812Sandreas.hansson@arm.com# property including but not limited to intellectual property relating
99812Sandreas.hansson@arm.com# to a hardware implementation of the functionality of the software
109812Sandreas.hansson@arm.com# licensed hereunder.  You may use the software subject to the license
119812Sandreas.hansson@arm.com# terms below provided that you ensure that this notice is replicated
129812Sandreas.hansson@arm.com# unmodified and in its entirety in all distributions of the software,
139812Sandreas.hansson@arm.com# modified or unmodified, in source code or in binary form.
149812Sandreas.hansson@arm.com#
157816Ssteve.reinhardt@amd.com# Copyright (c) 2011 Advanced Micro Devices, Inc.
165871Snate@binkert.org# Copyright (c) 2009 The Hewlett-Packard Development Company
171762SN/A# Copyright (c) 2004-2005 The Regents of The University of Michigan
18955SN/A# All rights reserved.
19955SN/A#
20955SN/A# Redistribution and use in source and binary forms, with or without
21955SN/A# modification, are permitted provided that the following conditions are
22955SN/A# met: redistributions of source code must retain the above copyright
23955SN/A# notice, this list of conditions and the following disclaimer;
24955SN/A# redistributions in binary form must reproduce the above copyright
25955SN/A# notice, this list of conditions and the following disclaimer in the
26955SN/A# documentation and/or other materials provided with the distribution;
27955SN/A# neither the name of the copyright holders nor the names of its
28955SN/A# contributors may be used to endorse or promote products derived from
29955SN/A# this software without specific prior written permission.
30955SN/A#
31955SN/A# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32955SN/A# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33955SN/A# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
34955SN/A# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35955SN/A# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36955SN/A# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
37955SN/A# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
38955SN/A# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
39955SN/A# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
40955SN/A# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
41955SN/A# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
422665Ssaidi@eecs.umich.edu#
432665Ssaidi@eecs.umich.edu# Authors: Steve Reinhardt
445863Snate@binkert.org#          Nathan Binkert
45955SN/A
46955SN/A###################################################
47955SN/A#
48955SN/A# SCons top-level build description (SConstruct) file.
49955SN/A#
508878Ssteve.reinhardt@amd.com# While in this directory ('gem5'), just type 'scons' to build the default
512632Sstever@eecs.umich.edu# configuration (see below), or type 'scons build/<CONFIG>/<binary>'
528878Ssteve.reinhardt@amd.com# to build some other configuration (e.g., 'build/ALPHA/gem5.opt' for
532632Sstever@eecs.umich.edu# the optimized full-system version).
54955SN/A#
558878Ssteve.reinhardt@amd.com# You can build gem5 in a different directory as long as there is a
562632Sstever@eecs.umich.edu# 'build/<CONFIG>' somewhere along the target path.  The build system
572761Sstever@eecs.umich.edu# expects that all configs under the same build directory are being
582632Sstever@eecs.umich.edu# built for the same host system.
592632Sstever@eecs.umich.edu#
602632Sstever@eecs.umich.edu# Examples:
612761Sstever@eecs.umich.edu#
622761Sstever@eecs.umich.edu#   The following two commands are equivalent.  The '-u' option tells
632761Sstever@eecs.umich.edu#   scons to search up the directory tree for this SConstruct file.
648878Ssteve.reinhardt@amd.com#   % cd <path-to-src>/gem5 ; scons build/ALPHA/gem5.debug
658878Ssteve.reinhardt@amd.com#   % cd <path-to-src>/gem5/build/ALPHA; scons -u gem5.debug
662761Sstever@eecs.umich.edu#
672761Sstever@eecs.umich.edu#   The following two commands are equivalent and demonstrate building
682761Sstever@eecs.umich.edu#   in a directory outside of the source tree.  The '-C' option tells
692761Sstever@eecs.umich.edu#   scons to chdir to the specified directory to find this SConstruct
702761Sstever@eecs.umich.edu#   file.
718878Ssteve.reinhardt@amd.com#   % cd <path-to-src>/gem5 ; scons /local/foo/build/ALPHA/gem5.debug
728878Ssteve.reinhardt@amd.com#   % cd /local/foo/build/ALPHA; scons -C <path-to-src>/gem5 gem5.debug
732632Sstever@eecs.umich.edu#
742632Sstever@eecs.umich.edu# You can use 'scons -H' to print scons options.  If you're in this
758878Ssteve.reinhardt@amd.com# 'gem5' directory (or use -u or -C to tell scons where to find this
768878Ssteve.reinhardt@amd.com# file), you can use 'scons -h' to print all the gem5-specific build
772632Sstever@eecs.umich.edu# options as well.
78955SN/A#
79955SN/A###################################################
80955SN/A
815863Snate@binkert.org# Check for recent-enough Python and SCons versions.
825863Snate@binkert.orgtry:
835863Snate@binkert.org    # Really old versions of scons only take two options for the
845863Snate@binkert.org    # function, so check once without the revision and once with the
855863Snate@binkert.org    # revision, the first instance will fail for stuff other than
865863Snate@binkert.org    # 0.98, and the second will fail for 0.98.0
875863Snate@binkert.org    EnsureSConsVersion(0, 98)
885863Snate@binkert.org    EnsureSConsVersion(0, 98, 1)
895863Snate@binkert.orgexcept SystemExit, e:
905863Snate@binkert.org    print """
915863Snate@binkert.orgFor more details, see:
928878Ssteve.reinhardt@amd.com    http://gem5.org/Dependencies
935863Snate@binkert.org"""
945863Snate@binkert.org    raise
955863Snate@binkert.org
969812Sandreas.hansson@arm.com# We ensure the python version early because because python-config
979812Sandreas.hansson@arm.com# requires python 2.5
985863Snate@binkert.orgtry:
999812Sandreas.hansson@arm.com    EnsurePythonVersion(2, 5)
1005863Snate@binkert.orgexcept SystemExit, e:
1015863Snate@binkert.org    print """
1025863Snate@binkert.orgYou can use a non-default installation of the Python interpreter by
1039812Sandreas.hansson@arm.comrearranging your PATH so that scons finds the non-default 'python' and
1049812Sandreas.hansson@arm.com'python-config' first.
1055863Snate@binkert.org
1065863Snate@binkert.orgFor more details, see:
1078878Ssteve.reinhardt@amd.com    http://gem5.org/wiki/index.php/Using_a_non-default_Python_installation
1085863Snate@binkert.org"""
1095863Snate@binkert.org    raise
1105863Snate@binkert.org
1116654Snate@binkert.org# Global Python includes
11210196SCurtis.Dunham@arm.comimport itertools
113955SN/Aimport os
1145396Ssaidi@eecs.umich.eduimport re
11511401Sandreas.sandberg@arm.comimport shutil
1165863Snate@binkert.orgimport subprocess
1175863Snate@binkert.orgimport sys
1184202Sbinkertn@umich.edu
1195863Snate@binkert.orgfrom os import mkdir, environ
1205863Snate@binkert.orgfrom os.path import abspath, basename, dirname, expanduser, normpath
1215863Snate@binkert.orgfrom os.path import exists,  isdir, isfile
1225863Snate@binkert.orgfrom os.path import join as joinpath, split as splitpath
123955SN/A
1246654Snate@binkert.org# SCons includes
1255273Sstever@gmail.comimport SCons
1265871Snate@binkert.orgimport SCons.Node
1275273Sstever@gmail.com
1286655Snate@binkert.orgextra_python_paths = [
1298878Ssteve.reinhardt@amd.com    Dir('src/python').srcnode().abspath, # gem5 includes
1306655Snate@binkert.org    Dir('ext/ply').srcnode().abspath, # ply is used by several files
1316655Snate@binkert.org    ]
1329219Spower.jg@gmail.com
1336655Snate@binkert.orgsys.path[1:1] = extra_python_paths
1345871Snate@binkert.org
1356654Snate@binkert.orgfrom m5.util import compareVersions, readCommand
1368947Sandreas.hansson@arm.comfrom m5.util.terminal import get_termcap
1375396Ssaidi@eecs.umich.edu
1388120Sgblack@eecs.umich.eduhelp_texts = {
1398120Sgblack@eecs.umich.edu    "options" : "",
1408120Sgblack@eecs.umich.edu    "global_vars" : "",
1418120Sgblack@eecs.umich.edu    "local_vars" : ""
1428120Sgblack@eecs.umich.edu}
1438120Sgblack@eecs.umich.edu
1448120Sgblack@eecs.umich.eduExport("help_texts")
1458120Sgblack@eecs.umich.edu
1468879Ssteve.reinhardt@amd.com
1478879Ssteve.reinhardt@amd.com# There's a bug in scons in that (1) by default, the help texts from
1488879Ssteve.reinhardt@amd.com# AddOption() are supposed to be displayed when you type 'scons -h'
1498879Ssteve.reinhardt@amd.com# and (2) you can override the help displayed by 'scons -h' using the
1508879Ssteve.reinhardt@amd.com# Help() function, but these two features are incompatible: once
1518879Ssteve.reinhardt@amd.com# you've overridden the help text using Help(), there's no way to get
1528879Ssteve.reinhardt@amd.com# at the help texts from AddOptions.  See:
1538879Ssteve.reinhardt@amd.com#     http://scons.tigris.org/issues/show_bug.cgi?id=2356
1548879Ssteve.reinhardt@amd.com#     http://scons.tigris.org/issues/show_bug.cgi?id=2611
1558879Ssteve.reinhardt@amd.com# This hack lets us extract the help text from AddOptions and
1568879Ssteve.reinhardt@amd.com# re-inject it via Help().  Ideally someday this bug will be fixed and
1578879Ssteve.reinhardt@amd.com# we can just use AddOption directly.
1588879Ssteve.reinhardt@amd.comdef AddLocalOption(*args, **kwargs):
1598120Sgblack@eecs.umich.edu    col_width = 30
1608120Sgblack@eecs.umich.edu
1618120Sgblack@eecs.umich.edu    help = "  " + ", ".join(args)
1628120Sgblack@eecs.umich.edu    if "help" in kwargs:
1638120Sgblack@eecs.umich.edu        length = len(help)
1648120Sgblack@eecs.umich.edu        if length >= col_width:
1658120Sgblack@eecs.umich.edu            help += "\n" + " " * col_width
1668120Sgblack@eecs.umich.edu        else:
1678120Sgblack@eecs.umich.edu            help += " " * (col_width - length)
1688120Sgblack@eecs.umich.edu        help += kwargs["help"]
1698120Sgblack@eecs.umich.edu    help_texts["options"] += help + "\n"
1708120Sgblack@eecs.umich.edu
1718120Sgblack@eecs.umich.edu    AddOption(*args, **kwargs)
1728120Sgblack@eecs.umich.edu
1738879Ssteve.reinhardt@amd.comAddLocalOption('--colors', dest='use_colors', action='store_true',
1748879Ssteve.reinhardt@amd.com               help="Add color to abbreviated scons output")
1758879Ssteve.reinhardt@amd.comAddLocalOption('--no-colors', dest='use_colors', action='store_false',
1768879Ssteve.reinhardt@amd.com               help="Don't add color to abbreviated scons output")
17710458Sandreas.hansson@arm.comAddLocalOption('--with-cxx-config', dest='with_cxx_config',
17810458Sandreas.hansson@arm.com               action='store_true',
17910458Sandreas.hansson@arm.com               help="Build with support for C++-based configuration")
1808879Ssteve.reinhardt@amd.comAddLocalOption('--default', dest='default', type='string', action='store',
1818879Ssteve.reinhardt@amd.com               help='Override which build_opts file to use for defaults')
1828879Ssteve.reinhardt@amd.comAddLocalOption('--ignore-style', dest='ignore_style', action='store_true',
1838879Ssteve.reinhardt@amd.com               help='Disable style checking hooks')
1849227Sandreas.hansson@arm.comAddLocalOption('--no-lto', dest='no_lto', action='store_true',
1859227Sandreas.hansson@arm.com               help='Disable Link-Time Optimization for fast')
1868879Ssteve.reinhardt@amd.comAddLocalOption('--update-ref', dest='update_ref', action='store_true',
1878879Ssteve.reinhardt@amd.com               help='Update test reference outputs')
1888879Ssteve.reinhardt@amd.comAddLocalOption('--verbose', dest='verbose', action='store_true',
1898879Ssteve.reinhardt@amd.com               help='Print full tool command lines')
19010453SAndrew.Bardsley@arm.comAddLocalOption('--without-python', dest='without_python',
19110453SAndrew.Bardsley@arm.com               action='store_true',
19210453SAndrew.Bardsley@arm.com               help='Build without Python configuration support')
19310456SCurtis.Dunham@arm.comAddLocalOption('--without-tcmalloc', dest='without_tcmalloc',
19410456SCurtis.Dunham@arm.com               action='store_true',
19510456SCurtis.Dunham@arm.com               help='Disable linking against tcmalloc')
19610457Sandreas.hansson@arm.comAddLocalOption('--with-ubsan', dest='with_ubsan', action='store_true',
19710457Sandreas.hansson@arm.com               help='Build with Undefined Behavior Sanitizer if available')
19811342Sandreas.hansson@arm.comAddLocalOption('--with-asan', dest='with_asan', action='store_true',
19911342Sandreas.hansson@arm.com               help='Build with Address Sanitizer if available')
2008120Sgblack@eecs.umich.edu
2018947Sandreas.hansson@arm.comtermcap = get_termcap(GetOption('use_colors'))
2027816Ssteve.reinhardt@amd.com
2035871Snate@binkert.org########################################################################
2045871Snate@binkert.org#
2056121Snate@binkert.org# Set up the main build environment.
2065871Snate@binkert.org#
2075871Snate@binkert.org########################################################################
2089926Sstan.czerniawski@arm.com
2099926Sstan.czerniawski@arm.com# export TERM so that clang reports errors in color
2109119Sandreas.hansson@arm.comuse_vars = set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH',
21110068Sandreas.hansson@arm.com                 'LIBRARY_PATH', 'PATH', 'PKG_CONFIG_PATH', 'PROTOC',
21210068Sandreas.hansson@arm.com                 'PYTHONPATH', 'RANLIB', 'SWIG', 'TERM' ])
213955SN/A
2149416SAndreas.Sandberg@ARM.comuse_prefixes = [
21511342Sandreas.hansson@arm.com    "ASAN_",           # address sanitizer symbolizer path and settings
21611212Sjoseph.gross@amd.com    "CCACHE_",         # ccache (caching compiler wrapper) configuration
21711212Sjoseph.gross@amd.com    "CCC_",            # clang static analyzer configuration
21811212Sjoseph.gross@amd.com    "DISTCC_",         # distcc (distributed compiler wrapper) configuration
21911212Sjoseph.gross@amd.com    "INCLUDE_SERVER_", # distcc pump server settings
22011212Sjoseph.gross@amd.com    "M5",              # M5 configuration (e.g., path to kernels)
2219416SAndreas.Sandberg@ARM.com    ]
2229416SAndreas.Sandberg@ARM.com
2235871Snate@binkert.orguse_env = {}
22410584Sandreas.hansson@arm.comfor key,val in sorted(os.environ.iteritems()):
2259416SAndreas.Sandberg@ARM.com    if key in use_vars or \
2269416SAndreas.Sandberg@ARM.com            any([key.startswith(prefix) for prefix in use_prefixes]):
2275871Snate@binkert.org        use_env[key] = val
228955SN/A
22910671Sandreas.hansson@arm.com# Tell scons to avoid implicit command dependencies to avoid issues
23010671Sandreas.hansson@arm.com# with the param wrappes being compiled twice (see
23110671Sandreas.hansson@arm.com# http://scons.tigris.org/issues/show_bug.cgi?id=2811)
23210671Sandreas.hansson@arm.commain = Environment(ENV=use_env, IMPLICIT_COMMAND_DEPENDENCIES=0)
2338881Smarc.orr@gmail.commain.Decider('MD5-timestamp')
2346121Snate@binkert.orgmain.root = Dir(".")         # The current directory (where this file lives).
2356121Snate@binkert.orgmain.srcdir = Dir("src")     # The source directory
2361533SN/A
2379239Sandreas.hansson@arm.commain_dict_keys = main.Dictionary().keys()
2389239Sandreas.hansson@arm.com
2399239Sandreas.hansson@arm.com# Check that we have a C/C++ compiler
2409239Sandreas.hansson@arm.comif not ('CC' in main_dict_keys and 'CXX' in main_dict_keys):
2419239Sandreas.hansson@arm.com    print "No C++ compiler installed (package g++ on Ubuntu and RedHat)"
2429239Sandreas.hansson@arm.com    Exit(1)
2439239Sandreas.hansson@arm.com
2449239Sandreas.hansson@arm.com# Check that swig is present
2459239Sandreas.hansson@arm.comif not 'SWIG' in main_dict_keys:
2469239Sandreas.hansson@arm.com    print "swig is not installed (package swig on Ubuntu and RedHat)"
2479239Sandreas.hansson@arm.com    Exit(1)
2489239Sandreas.hansson@arm.com
2496655Snate@binkert.org# add useful python code PYTHONPATH so it can be used by subprocesses
2506655Snate@binkert.org# as well
2516655Snate@binkert.orgmain.AppendENVPath('PYTHONPATH', extra_python_paths)
2526655Snate@binkert.org
2535871Snate@binkert.org########################################################################
2545871Snate@binkert.org#
2555863Snate@binkert.org# Mercurial Stuff.
2565871Snate@binkert.org#
2578878Ssteve.reinhardt@amd.com# If the gem5 directory is a mercurial repository, we should do some
2585871Snate@binkert.org# extra things.
2595871Snate@binkert.org#
2605871Snate@binkert.org########################################################################
2615863Snate@binkert.org
2626121Snate@binkert.orghgdir = main.root.Dir(".hg")
2635863Snate@binkert.org
26411408Sandreas.sandberg@arm.com
26511408Sandreas.sandberg@arm.comstyle_message = """
2668336Ssteve.reinhardt@amd.comYou're missing the gem5 style hook, which automatically checks your code
26711469SCurtis.Dunham@arm.comagainst the gem5 style rules on %s.
26811469SCurtis.Dunham@arm.comThis script will now install the hook in your %s.
2698336Ssteve.reinhardt@amd.comPress enter to continue, or ctrl-c to abort: """
2704678Snate@binkert.org
27111469SCurtis.Dunham@arm.commercurial_style_message = style_message % ("hg commit and qrefresh commands",
27211469SCurtis.Dunham@arm.com                                           ".hg/hgrc file")
27311469SCurtis.Dunham@arm.comgit_style_message = style_message % ("'git commit'",
27411469SCurtis.Dunham@arm.com                                     ".git/hooks/ directory")
27511408Sandreas.sandberg@arm.com
27611401Sandreas.sandberg@arm.commercurial_style_upgrade_message = """
27711401Sandreas.sandberg@arm.comYour Mercurial style hooks are not up-to-date. This script will now
27811401Sandreas.sandberg@arm.comtry to automatically update them. A backup of your hgrc will be saved
27911401Sandreas.sandberg@arm.comin .hg/hgrc.old.
28011401Sandreas.sandberg@arm.comPress enter to continue, or ctrl-c to abort: """
28111401Sandreas.sandberg@arm.com
2828336Ssteve.reinhardt@amd.commercurial_style_hook = """
2838336Ssteve.reinhardt@amd.com# The following lines were automatically added by gem5/SConstruct
2848336Ssteve.reinhardt@amd.com# to provide the gem5 style-checking hooks
2854678Snate@binkert.org[extensions]
28611401Sandreas.sandberg@arm.comhgstyle = %s/util/hgstyle.py
2874678Snate@binkert.org
2884678Snate@binkert.org[hooks]
28911401Sandreas.sandberg@arm.compretxncommit.style = python:hgstyle.check_style
29011401Sandreas.sandberg@arm.compre-qrefresh.style = python:hgstyle.check_style
2918336Ssteve.reinhardt@amd.com# End of SConstruct additions
2924678Snate@binkert.org
2938336Ssteve.reinhardt@amd.com""" % (main.root.abspath)
2948336Ssteve.reinhardt@amd.com
2958336Ssteve.reinhardt@amd.commercurial_lib_not_found = """
2968336Ssteve.reinhardt@amd.comMercurial libraries cannot be found, ignoring style hook.  If
2978336Ssteve.reinhardt@amd.comyou are a gem5 developer, please fix this and run the style
2988336Ssteve.reinhardt@amd.comhook. It is important.
2995871Snate@binkert.org"""
3005871Snate@binkert.org
3018336Ssteve.reinhardt@amd.com# Check for style hook and prompt for installation if it's not there.
30211408Sandreas.sandberg@arm.com# Skip this if --ignore-style was specified, there's no interactive
30311408Sandreas.sandberg@arm.com# terminal to prompt, or no recognized revision control system can be
30411408Sandreas.sandberg@arm.com# found.
30511408Sandreas.sandberg@arm.comignore_style = GetOption('ignore_style') or not sys.stdin.isatty()
30611408Sandreas.sandberg@arm.com
30711408Sandreas.sandberg@arm.com# Try wire up Mercurial to the style hooks
30811408Sandreas.sandberg@arm.comif not ignore_style and hgdir.exists():
3098336Ssteve.reinhardt@amd.com    style_hook = True
31011401Sandreas.sandberg@arm.com    style_hooks = tuple()
31111401Sandreas.sandberg@arm.com    hgrc = hgdir.File('hgrc')
31211401Sandreas.sandberg@arm.com    hgrc_old = hgdir.File('hgrc.old')
3135871Snate@binkert.org    try:
3148336Ssteve.reinhardt@amd.com        from mercurial import ui
3158336Ssteve.reinhardt@amd.com        ui = ui.ui()
31611401Sandreas.sandberg@arm.com        ui.readconfig(hgrc.abspath)
31711401Sandreas.sandberg@arm.com        style_hooks = (ui.config('hooks', 'pretxncommit.style', None),
31811401Sandreas.sandberg@arm.com                       ui.config('hooks', 'pre-qrefresh.style', None))
31911401Sandreas.sandberg@arm.com        style_hook = all(style_hooks)
32011401Sandreas.sandberg@arm.com        style_extension = ui.config('extensions', 'style', None)
3214678Snate@binkert.org    except ImportError:
3225871Snate@binkert.org        print mercurial_lib_not_found
3234678Snate@binkert.org
32411401Sandreas.sandberg@arm.com    if "python:style.check_style" in style_hooks:
32511401Sandreas.sandberg@arm.com        # Try to upgrade the style hooks
32611401Sandreas.sandberg@arm.com        print mercurial_style_upgrade_message
32711401Sandreas.sandberg@arm.com        # continue unless user does ctrl-c/ctrl-d etc.
32811401Sandreas.sandberg@arm.com        try:
32911401Sandreas.sandberg@arm.com            raw_input()
33011401Sandreas.sandberg@arm.com        except:
33111401Sandreas.sandberg@arm.com            print "Input exception, exiting scons.\n"
33211401Sandreas.sandberg@arm.com            sys.exit(1)
33311401Sandreas.sandberg@arm.com        shutil.copyfile(hgrc.abspath, hgrc_old.abspath)
33411401Sandreas.sandberg@arm.com        re_style_hook = re.compile(r"^([^=#]+)\.style\s*=\s*([^#\s]+).*")
33511401Sandreas.sandberg@arm.com        re_style_extension = re.compile("style\s*=\s*([^#\s]+).*")
33611450Sandreas.sandberg@arm.com        old, new = open(hgrc_old.abspath, 'r'), open(hgrc.abspath, 'w')
33711450Sandreas.sandberg@arm.com        for l in old:
33811450Sandreas.sandberg@arm.com            m_hook = re_style_hook.match(l)
33911450Sandreas.sandberg@arm.com            m_ext = re_style_extension.match(l)
34011450Sandreas.sandberg@arm.com            if m_hook:
34111450Sandreas.sandberg@arm.com                hook, check = m_hook.groups()
34211450Sandreas.sandberg@arm.com                if check != "python:style.check_style":
34311450Sandreas.sandberg@arm.com                    print "Warning: %s.style is using a non-default " \
34411450Sandreas.sandberg@arm.com                        "checker: %s" % (hook, check)
34511450Sandreas.sandberg@arm.com                if hook not in ("pretxncommit", "pre-qrefresh"):
34611450Sandreas.sandberg@arm.com                    print "Warning: Updating unknown style hook: %s" % hook
34711401Sandreas.sandberg@arm.com
34811450Sandreas.sandberg@arm.com                l = "%s.style = python:hgstyle.check_style\n" % hook
34911450Sandreas.sandberg@arm.com            elif m_ext and m_ext.group(1) == style_extension:
35011450Sandreas.sandberg@arm.com                l = "hgstyle = %s/util/hgstyle.py\n" % main.root.abspath
35111401Sandreas.sandberg@arm.com
35211450Sandreas.sandberg@arm.com            new.write(l)
35311401Sandreas.sandberg@arm.com    elif not style_hook:
3548336Ssteve.reinhardt@amd.com        print mercurial_style_message,
3558336Ssteve.reinhardt@amd.com        # continue unless user does ctrl-c/ctrl-d etc.
3568336Ssteve.reinhardt@amd.com        try:
3578336Ssteve.reinhardt@amd.com            raw_input()
3588336Ssteve.reinhardt@amd.com        except:
3598336Ssteve.reinhardt@amd.com            print "Input exception, exiting scons.\n"
3608336Ssteve.reinhardt@amd.com            sys.exit(1)
3618336Ssteve.reinhardt@amd.com        hgrc_path = '%s/.hg/hgrc' % main.root.abspath
3628336Ssteve.reinhardt@amd.com        print "Adding style hook to", hgrc_path, "\n"
3638336Ssteve.reinhardt@amd.com        try:
36411401Sandreas.sandberg@arm.com            with open(hgrc_path, 'a') as f:
36511401Sandreas.sandberg@arm.com                f.write(mercurial_style_hook)
3668336Ssteve.reinhardt@amd.com        except:
3678336Ssteve.reinhardt@amd.com            print "Error updating", hgrc_path
3688336Ssteve.reinhardt@amd.com            sys.exit(1)
3695871Snate@binkert.org
37011476Sandreas.sandberg@arm.comdef install_git_style_hooks():
37111476Sandreas.sandberg@arm.com    try:
37211476Sandreas.sandberg@arm.com        gitdir = Dir(readCommand(
37311476Sandreas.sandberg@arm.com            ["git", "rev-parse", "--git-dir"]).strip("\n"))
37411476Sandreas.sandberg@arm.com    except Exception, e:
37511476Sandreas.sandberg@arm.com        print "Warning: Failed to find git repo directory: %s" % e
37611476Sandreas.sandberg@arm.com        return
37711476Sandreas.sandberg@arm.com
37811476Sandreas.sandberg@arm.com    git_hooks = gitdir.Dir("hooks")
37911476Sandreas.sandberg@arm.com    git_pre_commit_hook = git_hooks.File("pre-commit")
38011408Sandreas.sandberg@arm.com    git_style_script = File("util/git-pre-commit.py")
38111408Sandreas.sandberg@arm.com
38211476Sandreas.sandberg@arm.com    if git_pre_commit_hook.exists():
38311476Sandreas.sandberg@arm.com        return
38411476Sandreas.sandberg@arm.com
38511408Sandreas.sandberg@arm.com    print git_style_message,
38611408Sandreas.sandberg@arm.com    try:
38711408Sandreas.sandberg@arm.com        raw_input()
38811408Sandreas.sandberg@arm.com    except:
38911408Sandreas.sandberg@arm.com        print "Input exception, exiting scons.\n"
39011408Sandreas.sandberg@arm.com        sys.exit(1)
39111408Sandreas.sandberg@arm.com
39211476Sandreas.sandberg@arm.com    if not git_hooks.exists():
39311476Sandreas.sandberg@arm.com        mkdir(git_hooks.get_abspath())
39411476Sandreas.sandberg@arm.com
39511476Sandreas.sandberg@arm.com    # Use a relative symlink if the hooks live in the source directory
39611476Sandreas.sandberg@arm.com    if git_pre_commit_hook.is_under(main.root):
39711476Sandreas.sandberg@arm.com        script_path = os.path.relpath(
39811408Sandreas.sandberg@arm.com            git_style_script.get_abspath(),
39911408Sandreas.sandberg@arm.com            git_pre_commit_hook.Dir(".").get_abspath())
40011476Sandreas.sandberg@arm.com    else:
40111476Sandreas.sandberg@arm.com        script_path = git_style_script.get_abspath()
40211476Sandreas.sandberg@arm.com
40311476Sandreas.sandberg@arm.com    try:
40411476Sandreas.sandberg@arm.com        os.symlink(script_path, git_pre_commit_hook.get_abspath())
40511408Sandreas.sandberg@arm.com    except:
40611408Sandreas.sandberg@arm.com        print "Error updating git pre-commit hook"
40711408Sandreas.sandberg@arm.com        raise
40811476Sandreas.sandberg@arm.com
40911476Sandreas.sandberg@arm.com# Try to wire up git to the style hooks
41011476Sandreas.sandberg@arm.comif not ignore_style and main.root.Entry(".git").exists():
41111476Sandreas.sandberg@arm.com    install_git_style_hooks()
4126121Snate@binkert.org
413955SN/A###################################################
414955SN/A#
4152632Sstever@eecs.umich.edu# Figure out which configurations to set up based on the path(s) of
4162632Sstever@eecs.umich.edu# the target(s).
417955SN/A#
418955SN/A###################################################
419955SN/A
420955SN/A# Find default configuration & binary.
4218878Ssteve.reinhardt@amd.comDefault(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug'))
422955SN/A
4232632Sstever@eecs.umich.edu# helper function: find last occurrence of element in list
4242632Sstever@eecs.umich.edudef rfind(l, elt, offs = -1):
4252632Sstever@eecs.umich.edu    for i in range(len(l)+offs, 0, -1):
4262632Sstever@eecs.umich.edu        if l[i] == elt:
4272632Sstever@eecs.umich.edu            return i
4282632Sstever@eecs.umich.edu    raise ValueError, "element not found"
4292632Sstever@eecs.umich.edu
4308268Ssteve.reinhardt@amd.com# Take a list of paths (or SCons Nodes) and return a list with all
4318268Ssteve.reinhardt@amd.com# paths made absolute and ~-expanded.  Paths will be interpreted
4328268Ssteve.reinhardt@amd.com# relative to the launch directory unless a different root is provided
4338268Ssteve.reinhardt@amd.comdef makePathListAbsolute(path_list, root=GetLaunchDir()):
4348268Ssteve.reinhardt@amd.com    return [abspath(joinpath(root, expanduser(str(p))))
4358268Ssteve.reinhardt@amd.com            for p in path_list]
4368268Ssteve.reinhardt@amd.com
4372632Sstever@eecs.umich.edu# Each target must have 'build' in the interior of the path; the
4382632Sstever@eecs.umich.edu# directory below this will determine the build parameters.  For
4392632Sstever@eecs.umich.edu# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
4402632Sstever@eecs.umich.edu# recognize that ALPHA_SE specifies the configuration because it
4418268Ssteve.reinhardt@amd.com# follow 'build' in the build path.
4422632Sstever@eecs.umich.edu
4438268Ssteve.reinhardt@amd.com# The funky assignment to "[:]" is needed to replace the list contents
4448268Ssteve.reinhardt@amd.com# in place rather than reassign the symbol to a new list, which
4458268Ssteve.reinhardt@amd.com# doesn't work (obviously!).
4468268Ssteve.reinhardt@amd.comBUILD_TARGETS[:] = makePathListAbsolute(BUILD_TARGETS)
4473718Sstever@eecs.umich.edu
4482634Sstever@eecs.umich.edu# Generate a list of the unique build roots and configs that the
4492634Sstever@eecs.umich.edu# collected targets reference.
4505863Snate@binkert.orgvariant_paths = []
4512638Sstever@eecs.umich.edubuild_root = None
4528268Ssteve.reinhardt@amd.comfor t in BUILD_TARGETS:
4532632Sstever@eecs.umich.edu    path_dirs = t.split('/')
4542632Sstever@eecs.umich.edu    try:
4552632Sstever@eecs.umich.edu        build_top = rfind(path_dirs, 'build', -2)
4562632Sstever@eecs.umich.edu    except:
4572632Sstever@eecs.umich.edu        print "Error: no non-leaf 'build' dir found on target path", t
4581858SN/A        Exit(1)
4593716Sstever@eecs.umich.edu    this_build_root = joinpath('/',*path_dirs[:build_top+1])
4602638Sstever@eecs.umich.edu    if not build_root:
4612638Sstever@eecs.umich.edu        build_root = this_build_root
4622638Sstever@eecs.umich.edu    else:
4632638Sstever@eecs.umich.edu        if this_build_root != build_root:
4642638Sstever@eecs.umich.edu            print "Error: build targets not under same build root\n"\
4652638Sstever@eecs.umich.edu                  "  %s\n  %s" % (build_root, this_build_root)
4662638Sstever@eecs.umich.edu            Exit(1)
4675863Snate@binkert.org    variant_path = joinpath('/',*path_dirs[:build_top+2])
4685863Snate@binkert.org    if variant_path not in variant_paths:
4695863Snate@binkert.org        variant_paths.append(variant_path)
470955SN/A
4715341Sstever@gmail.com# Make sure build_root exists (might not if this is the first build there)
4725341Sstever@gmail.comif not isdir(build_root):
4735863Snate@binkert.org    mkdir(build_root)
4747756SAli.Saidi@ARM.commain['BUILDROOT'] = build_root
4755341Sstever@gmail.com
4766121Snate@binkert.orgExport('main')
4774494Ssaidi@eecs.umich.edu
4786121Snate@binkert.orgmain.SConsignFile(joinpath(build_root, "sconsign"))
4791105SN/A
4802667Sstever@eecs.umich.edu# Default duplicate option is to use hard links, but this messes up
4812667Sstever@eecs.umich.edu# when you use emacs to edit a file in the target dir, as emacs moves
4822667Sstever@eecs.umich.edu# file to file~ then copies to file, breaking the link.  Symbolic
4832667Sstever@eecs.umich.edu# (soft) links work better.
4846121Snate@binkert.orgmain.SetOption('duplicate', 'soft-copy')
4852667Sstever@eecs.umich.edu
4865341Sstever@gmail.com#
4875863Snate@binkert.org# Set up global sticky variables... these are common to an entire build
4885341Sstever@gmail.com# tree (not specific to a particular build like ALPHA_SE)
4895341Sstever@gmail.com#
4905341Sstever@gmail.com
4918120Sgblack@eecs.umich.eduglobal_vars_file = joinpath(build_root, 'variables.global')
4925341Sstever@gmail.com
4938120Sgblack@eecs.umich.eduglobal_vars = Variables(global_vars_file, args=ARGUMENTS)
4945341Sstever@gmail.com
4958120Sgblack@eecs.umich.eduglobal_vars.AddVariables(
4966121Snate@binkert.org    ('CC', 'C compiler', environ.get('CC', main['CC'])),
4976121Snate@binkert.org    ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])),
4988980Ssteve.reinhardt@amd.com    ('SWIG', 'SWIG tool', environ.get('SWIG', main['SWIG'])),
4999396Sandreas.hansson@arm.com    ('PROTOC', 'protoc tool', environ.get('PROTOC', 'protoc')),
5005397Ssaidi@eecs.umich.edu    ('BATCH', 'Use batch pool for build and tests', False),
5015397Ssaidi@eecs.umich.edu    ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
5027727SAli.Saidi@ARM.com    ('M5_BUILD_CACHE', 'Cache built objects in this directory', False),
5038268Ssteve.reinhardt@amd.com    ('EXTRAS', 'Add extra directories to the compilation', '')
5046168Snate@binkert.org    )
5055341Sstever@gmail.com
5068120Sgblack@eecs.umich.edu# Update main environment with values from ARGUMENTS & global_vars_file
5078120Sgblack@eecs.umich.eduglobal_vars.Update(main)
5088120Sgblack@eecs.umich.eduhelp_texts["global_vars"] += global_vars.GenerateHelpText(main)
5096814Sgblack@eecs.umich.edu
5105863Snate@binkert.org# Save sticky variable settings back to current variables file
5118120Sgblack@eecs.umich.eduglobal_vars.Save(global_vars_file, main)
5125341Sstever@gmail.com
5135863Snate@binkert.org# Parse EXTRAS variable to build list of all directories where we're
5148268Ssteve.reinhardt@amd.com# look for sources etc.  This list is exported as extras_dir_list.
5156121Snate@binkert.orgbase_dir = main.srcdir.abspath
5166121Snate@binkert.orgif main['EXTRAS']:
5178268Ssteve.reinhardt@amd.com    extras_dir_list = makePathListAbsolute(main['EXTRAS'].split(':'))
5185742Snate@binkert.orgelse:
5195742Snate@binkert.org    extras_dir_list = []
5205341Sstever@gmail.com
5215742Snate@binkert.orgExport('base_dir')
5225742Snate@binkert.orgExport('extras_dir_list')
5235341Sstever@gmail.com
5246017Snate@binkert.org# the ext directory should be on the #includes path
5256121Snate@binkert.orgmain.Append(CPPPATH=[Dir('ext')])
5266017Snate@binkert.org
5277816Ssteve.reinhardt@amd.comdef strip_build_path(path, env):
5287756SAli.Saidi@ARM.com    path = str(path)
5297756SAli.Saidi@ARM.com    variant_base = env['BUILDROOT'] + os.path.sep
5307756SAli.Saidi@ARM.com    if path.startswith(variant_base):
5317756SAli.Saidi@ARM.com        path = path[len(variant_base):]
5327756SAli.Saidi@ARM.com    elif path.startswith('build/'):
5337756SAli.Saidi@ARM.com        path = path[6:]
5347756SAli.Saidi@ARM.com    return path
5357756SAli.Saidi@ARM.com
5367816Ssteve.reinhardt@amd.com# Generate a string of the form:
5377816Ssteve.reinhardt@amd.com#   common/path/prefix/src1, src2 -> tgt1, tgt2
5387816Ssteve.reinhardt@amd.com# to print while building.
5397816Ssteve.reinhardt@amd.comclass Transform(object):
5407816Ssteve.reinhardt@amd.com    # all specific color settings should be here and nowhere else
5417816Ssteve.reinhardt@amd.com    tool_color = termcap.Normal
5427816Ssteve.reinhardt@amd.com    pfx_color = termcap.Yellow
5437816Ssteve.reinhardt@amd.com    srcs_color = termcap.Yellow + termcap.Bold
5447816Ssteve.reinhardt@amd.com    arrow_color = termcap.Blue + termcap.Bold
5457816Ssteve.reinhardt@amd.com    tgts_color = termcap.Yellow + termcap.Bold
5467756SAli.Saidi@ARM.com
5477816Ssteve.reinhardt@amd.com    def __init__(self, tool, max_sources=99):
5487816Ssteve.reinhardt@amd.com        self.format = self.tool_color + (" [%8s] " % tool) \
5497816Ssteve.reinhardt@amd.com                      + self.pfx_color + "%s" \
5507816Ssteve.reinhardt@amd.com                      + self.srcs_color + "%s" \
5517816Ssteve.reinhardt@amd.com                      + self.arrow_color + " -> " \
5527816Ssteve.reinhardt@amd.com                      + self.tgts_color + "%s" \
5537816Ssteve.reinhardt@amd.com                      + termcap.Normal
5547816Ssteve.reinhardt@amd.com        self.max_sources = max_sources
5557816Ssteve.reinhardt@amd.com
5567816Ssteve.reinhardt@amd.com    def __call__(self, target, source, env, for_signature=None):
5577816Ssteve.reinhardt@amd.com        # truncate source list according to max_sources param
5587816Ssteve.reinhardt@amd.com        source = source[0:self.max_sources]
5597816Ssteve.reinhardt@amd.com        def strip(f):
5607816Ssteve.reinhardt@amd.com            return strip_build_path(str(f), env)
5617816Ssteve.reinhardt@amd.com        if len(source) > 0:
5627816Ssteve.reinhardt@amd.com            srcs = map(strip, source)
5637816Ssteve.reinhardt@amd.com        else:
5647816Ssteve.reinhardt@amd.com            srcs = ['']
5657816Ssteve.reinhardt@amd.com        tgts = map(strip, target)
5667816Ssteve.reinhardt@amd.com        # surprisingly, os.path.commonprefix is a dumb char-by-char string
5677816Ssteve.reinhardt@amd.com        # operation that has nothing to do with paths.
5687816Ssteve.reinhardt@amd.com        com_pfx = os.path.commonprefix(srcs + tgts)
5697816Ssteve.reinhardt@amd.com        com_pfx_len = len(com_pfx)
5707816Ssteve.reinhardt@amd.com        if com_pfx:
5717816Ssteve.reinhardt@amd.com            # do some cleanup and sanity checking on common prefix
5727816Ssteve.reinhardt@amd.com            if com_pfx[-1] == ".":
5737816Ssteve.reinhardt@amd.com                # prefix matches all but file extension: ok
5747816Ssteve.reinhardt@amd.com                # back up one to change 'foo.cc -> o' to 'foo.cc -> .o'
5757816Ssteve.reinhardt@amd.com                com_pfx = com_pfx[0:-1]
5767816Ssteve.reinhardt@amd.com            elif com_pfx[-1] == "/":
5777816Ssteve.reinhardt@amd.com                # common prefix is directory path: OK
5787816Ssteve.reinhardt@amd.com                pass
5797816Ssteve.reinhardt@amd.com            else:
5807816Ssteve.reinhardt@amd.com                src0_len = len(srcs[0])
5817816Ssteve.reinhardt@amd.com                tgt0_len = len(tgts[0])
5827816Ssteve.reinhardt@amd.com                if src0_len == com_pfx_len:
5837816Ssteve.reinhardt@amd.com                    # source is a substring of target, OK
5847816Ssteve.reinhardt@amd.com                    pass
5857816Ssteve.reinhardt@amd.com                elif tgt0_len == com_pfx_len:
5867816Ssteve.reinhardt@amd.com                    # target is a substring of source, need to back up to
5877816Ssteve.reinhardt@amd.com                    # avoid empty string on RHS of arrow
5887816Ssteve.reinhardt@amd.com                    sep_idx = com_pfx.rfind(".")
5897816Ssteve.reinhardt@amd.com                    if sep_idx != -1:
5907816Ssteve.reinhardt@amd.com                        com_pfx = com_pfx[0:sep_idx]
5917816Ssteve.reinhardt@amd.com                    else:
5927816Ssteve.reinhardt@amd.com                        com_pfx = ''
5937816Ssteve.reinhardt@amd.com                elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".":
5947816Ssteve.reinhardt@amd.com                    # still splitting at file extension: ok
5957816Ssteve.reinhardt@amd.com                    pass
5967816Ssteve.reinhardt@amd.com                else:
5977816Ssteve.reinhardt@amd.com                    # probably a fluke; ignore it
5987816Ssteve.reinhardt@amd.com                    com_pfx = ''
5997816Ssteve.reinhardt@amd.com        # recalculate length in case com_pfx was modified
6007816Ssteve.reinhardt@amd.com        com_pfx_len = len(com_pfx)
6017816Ssteve.reinhardt@amd.com        def fmt(files):
6027816Ssteve.reinhardt@amd.com            f = map(lambda s: s[com_pfx_len:], files)
6037816Ssteve.reinhardt@amd.com            return ', '.join(f)
6047816Ssteve.reinhardt@amd.com        return self.format % (com_pfx, fmt(srcs), fmt(tgts))
6057816Ssteve.reinhardt@amd.com
6067816Ssteve.reinhardt@amd.comExport('Transform')
6077816Ssteve.reinhardt@amd.com
6088947Sandreas.hansson@arm.com# enable the regression script to use the termcap
6098947Sandreas.hansson@arm.commain['TERMCAP'] = termcap
6107756SAli.Saidi@ARM.com
6118120Sgblack@eecs.umich.eduif GetOption('verbose'):
6127756SAli.Saidi@ARM.com    def MakeAction(action, string, *args, **kwargs):
6137756SAli.Saidi@ARM.com        return Action(action, *args, **kwargs)
6147756SAli.Saidi@ARM.comelse:
6157756SAli.Saidi@ARM.com    MakeAction = Action
6167816Ssteve.reinhardt@amd.com    main['CCCOMSTR']        = Transform("CC")
6177816Ssteve.reinhardt@amd.com    main['CXXCOMSTR']       = Transform("CXX")
6187816Ssteve.reinhardt@amd.com    main['ASCOMSTR']        = Transform("AS")
6197816Ssteve.reinhardt@amd.com    main['SWIGCOMSTR']      = Transform("SWIG")
6207816Ssteve.reinhardt@amd.com    main['ARCOMSTR']        = Transform("AR", 0)
6217816Ssteve.reinhardt@amd.com    main['LINKCOMSTR']      = Transform("LINK", 0)
6227816Ssteve.reinhardt@amd.com    main['RANLIBCOMSTR']    = Transform("RANLIB", 0)
6237816Ssteve.reinhardt@amd.com    main['M4COMSTR']        = Transform("M4")
6247816Ssteve.reinhardt@amd.com    main['SHCCCOMSTR']      = Transform("SHCC")
6257816Ssteve.reinhardt@amd.com    main['SHCXXCOMSTR']     = Transform("SHCXX")
6267756SAli.Saidi@ARM.comExport('MakeAction')
6277756SAli.Saidi@ARM.com
6289227Sandreas.hansson@arm.com# Initialize the Link-Time Optimization (LTO) flags
6299227Sandreas.hansson@arm.commain['LTO_CCFLAGS'] = []
6309227Sandreas.hansson@arm.commain['LTO_LDFLAGS'] = []
6319227Sandreas.hansson@arm.com
6329590Sandreas@sandberg.pp.se# According to the readme, tcmalloc works best if the compiler doesn't
6339590Sandreas@sandberg.pp.se# assume that we're using the builtin malloc and friends. These flags
6349590Sandreas@sandberg.pp.se# are compiler-specific, so we need to set them after we detect which
6359590Sandreas@sandberg.pp.se# compiler we're using.
6369590Sandreas@sandberg.pp.semain['TCMALLOC_CCFLAGS'] = []
6379590Sandreas@sandberg.pp.se
6386654Snate@binkert.orgCXX_version = readCommand([main['CXX'],'--version'], exception=False)
6396654Snate@binkert.orgCXX_V = readCommand([main['CXX'],'-V'], exception=False)
6405871Snate@binkert.org
6416121Snate@binkert.orgmain['GCC'] = CXX_version and CXX_version.find('g++') >= 0
6428946Sandreas.hansson@arm.commain['CLANG'] = CXX_version and CXX_version.find('clang') >= 0
6439419Sandreas.hansson@arm.comif main['GCC'] + main['CLANG'] > 1:
6443940Ssaidi@eecs.umich.edu    print 'Error: How can we have two at the same time?'
6453918Ssaidi@eecs.umich.edu    Exit(1)
6463918Ssaidi@eecs.umich.edu
6471858SN/A# Set up default C++ compiler flags
6489556Sandreas.hansson@arm.comif main['GCC'] or main['CLANG']:
6499556Sandreas.hansson@arm.com    # As gcc and clang share many flags, do the common parts here
6509556Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-pipe'])
6519556Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-fno-strict-aliasing'])
65211294Sandreas.hansson@arm.com    # Enable -Wall and -Wextra and then disable the few warnings that
65311294Sandreas.hansson@arm.com    # we consistently violate
65411294Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-Wall', '-Wundef', '-Wextra',
65511294Sandreas.hansson@arm.com                         '-Wno-sign-compare', '-Wno-unused-parameter'])
65610878Sandreas.hansson@arm.com    # We always compile using C++11
65710878Sandreas.hansson@arm.com    main.Append(CXXFLAGS=['-std=c++11'])
65811811Sbaz21@cam.ac.uk    if sys.platform.startswith('freebsd'):
65911811Sbaz21@cam.ac.uk        main.Append(CCFLAGS=['-I/usr/local/include'])
66011811Sbaz21@cam.ac.uk        main.Append(CXXFLAGS=['-I/usr/local/include'])
6619556Sandreas.hansson@arm.comelse:
6629556Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal,
6639556Sandreas.hansson@arm.com    print "Don't know what compiler options to use for your compiler."
6649556Sandreas.hansson@arm.com    print termcap.Yellow + '       compiler:' + termcap.Normal, main['CXX']
6659556Sandreas.hansson@arm.com    print termcap.Yellow + '       version:' + termcap.Normal,
6669556Sandreas.hansson@arm.com    if not CXX_version:
6679556Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\
6689556Sandreas.hansson@arm.com               termcap.Normal
6699556Sandreas.hansson@arm.com    else:
6709556Sandreas.hansson@arm.com        print CXX_version.replace('\n', '<nl>')
6719556Sandreas.hansson@arm.com    print "       If you're trying to use a compiler other than GCC"
6729556Sandreas.hansson@arm.com    print "       or clang, there appears to be something wrong with your"
6739556Sandreas.hansson@arm.com    print "       environment."
6749556Sandreas.hansson@arm.com    print "       "
6759556Sandreas.hansson@arm.com    print "       If you are trying to use a compiler other than those listed"
6769556Sandreas.hansson@arm.com    print "       above you will need to ease fix SConstruct and "
6779556Sandreas.hansson@arm.com    print "       src/SConscript to support that compiler."
6789556Sandreas.hansson@arm.com    Exit(1)
6799556Sandreas.hansson@arm.com
6806121Snate@binkert.orgif main['GCC']:
68111500Sandreas.hansson@arm.com    # Check for a supported version of gcc. >= 4.8 is chosen for its
68210238Sandreas.hansson@arm.com    # level of c++11 support. See
68310878Sandreas.hansson@arm.com    # http://gcc.gnu.org/projects/cxx0x.html for details.
6849420Sandreas.hansson@arm.com    gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False)
68511500Sandreas.hansson@arm.com    if compareVersions(gcc_version, "4.8") < 0:
68611500Sandreas.hansson@arm.com        print 'Error: gcc version 4.8 or newer required.'
6879420Sandreas.hansson@arm.com        print '       Installed version:', gcc_version
6889420Sandreas.hansson@arm.com        Exit(1)
6899420Sandreas.hansson@arm.com
6909420Sandreas.hansson@arm.com    main['GCC_VERSION'] = gcc_version
6919420Sandreas.hansson@arm.com
69210264Sandreas.hansson@arm.com    # gcc from version 4.8 and above generates "rep; ret" instructions
69310264Sandreas.hansson@arm.com    # to avoid performance penalties on certain AMD chips. Older
69410264Sandreas.hansson@arm.com    # assemblers detect this as an error, "Error: expecting string
69510264Sandreas.hansson@arm.com    # instruction after `rep'"
69611500Sandreas.hansson@arm.com    as_version_raw = readCommand([main['AS'], '-v', '/dev/null'],
69711500Sandreas.hansson@arm.com                                 exception=False).split()
69810264Sandreas.hansson@arm.com
69911500Sandreas.hansson@arm.com    # version strings may contain extra distro-specific
70011500Sandreas.hansson@arm.com    # qualifiers, so play it safe and keep only what comes before
70111500Sandreas.hansson@arm.com    # the first hyphen
70211500Sandreas.hansson@arm.com    as_version = as_version_raw[-1].split('-')[0] if as_version_raw else None
70310866Sandreas.hansson@arm.com
70411500Sandreas.hansson@arm.com    if not as_version or compareVersions(as_version, "2.23") < 0:
70511500Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + \
70611500Sandreas.hansson@arm.com            'Warning: This combination of gcc and binutils have' + \
70711500Sandreas.hansson@arm.com            ' known incompatibilities.\n' + \
70811500Sandreas.hansson@arm.com            '         If you encounter build problems, please update ' + \
70911500Sandreas.hansson@arm.com            'binutils to 2.23.' + \
71011500Sandreas.hansson@arm.com            termcap.Normal
71110264Sandreas.hansson@arm.com
71210457Sandreas.hansson@arm.com    # Make sure we warn if the user has requested to compile with the
71310457Sandreas.hansson@arm.com    # Undefined Benahvior Sanitizer and this version of gcc does not
71410457Sandreas.hansson@arm.com    # support it.
71510457Sandreas.hansson@arm.com    if GetOption('with_ubsan') and \
71610457Sandreas.hansson@arm.com            compareVersions(gcc_version, '4.9') < 0:
71710457Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + \
71810457Sandreas.hansson@arm.com            'Warning: UBSan is only supported using gcc 4.9 and later.' + \
71910457Sandreas.hansson@arm.com            termcap.Normal
72010457Sandreas.hansson@arm.com
72110238Sandreas.hansson@arm.com    # Add the appropriate Link-Time Optimization (LTO) flags
72210238Sandreas.hansson@arm.com    # unless LTO is explicitly turned off. Note that these flags
72310238Sandreas.hansson@arm.com    # are only used by the fast target.
72410238Sandreas.hansson@arm.com    if not GetOption('no_lto'):
72510238Sandreas.hansson@arm.com        # Pass the LTO flag when compiling to produce GIMPLE
72610238Sandreas.hansson@arm.com        # output, we merely create the flags here and only append
72710416Sandreas.hansson@arm.com        # them later
72810238Sandreas.hansson@arm.com        main['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
7299227Sandreas.hansson@arm.com
73010238Sandreas.hansson@arm.com        # Use the same amount of jobs for LTO as we are running
73110416Sandreas.hansson@arm.com        # scons with
73210416Sandreas.hansson@arm.com        main['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
7339227Sandreas.hansson@arm.com
7349590Sandreas@sandberg.pp.se    main.Append(TCMALLOC_CCFLAGS=['-fno-builtin-malloc', '-fno-builtin-calloc',
7359590Sandreas@sandberg.pp.se                                  '-fno-builtin-realloc', '-fno-builtin-free'])
7369590Sandreas@sandberg.pp.se
73711497SMatteo.Andreozzi@arm.com    # add option to check for undeclared overrides
73811497SMatteo.Andreozzi@arm.com    if compareVersions(gcc_version, "5.0") > 0:
73911497SMatteo.Andreozzi@arm.com        main.Append(CCFLAGS=['-Wno-error=suggest-override'])
74011497SMatteo.Andreozzi@arm.com
7418737Skoansin.tan@gmail.comelif main['CLANG']:
74210878Sandreas.hansson@arm.com    # Check for a supported version of clang, >= 3.1 is needed to
74311500Sandreas.hansson@arm.com    # support similar features as gcc 4.8. See
7449420Sandreas.hansson@arm.com    # http://clang.llvm.org/cxx_status.html for details
7458737Skoansin.tan@gmail.com    clang_version_re = re.compile(".* version (\d+\.\d+)")
74610106SMitch.Hayenga@arm.com    clang_version_match = clang_version_re.search(CXX_version)
7478737Skoansin.tan@gmail.com    if (clang_version_match):
7488737Skoansin.tan@gmail.com        clang_version = clang_version_match.groups()[0]
74910878Sandreas.hansson@arm.com        if compareVersions(clang_version, "3.1") < 0:
75010878Sandreas.hansson@arm.com            print 'Error: clang version 3.1 or newer required.'
7518737Skoansin.tan@gmail.com            print '       Installed version:', clang_version
7528737Skoansin.tan@gmail.com            Exit(1)
7538737Skoansin.tan@gmail.com    else:
7548737Skoansin.tan@gmail.com        print 'Error: Unable to determine clang version.'
7558737Skoansin.tan@gmail.com        Exit(1)
7568737Skoansin.tan@gmail.com
75711294Sandreas.hansson@arm.com    # clang has a few additional warnings that we disable, extraneous
7589556Sandreas.hansson@arm.com    # parantheses are allowed due to Ruby's printing of the AST,
7599556Sandreas.hansson@arm.com    # finally self assignments are allowed as the generated CPU code
7609556Sandreas.hansson@arm.com    # is relying on this
76111294Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-Wno-parentheses',
76210278SAndreas.Sandberg@ARM.com                         '-Wno-self-assign',
76310278SAndreas.Sandberg@ARM.com                         # Some versions of libstdc++ (4.8?) seem to
76410278SAndreas.Sandberg@ARM.com                         # use struct hash and class hash
76510278SAndreas.Sandberg@ARM.com                         # interchangeably.
76610278SAndreas.Sandberg@ARM.com                         '-Wno-mismatched-tags',
76710278SAndreas.Sandberg@ARM.com                         ])
7689556Sandreas.hansson@arm.com
7699590Sandreas@sandberg.pp.se    main.Append(TCMALLOC_CCFLAGS=['-fno-builtin'])
7709590Sandreas@sandberg.pp.se
7719420Sandreas.hansson@arm.com    # On Mac OS X/Darwin we need to also use libc++ (part of XCode) as
7729846Sandreas.hansson@arm.com    # opposed to libstdc++, as the later is dated.
7739846Sandreas.hansson@arm.com    if sys.platform == "darwin":
7749846Sandreas.hansson@arm.com        main.Append(CXXFLAGS=['-stdlib=libc++'])
7759846Sandreas.hansson@arm.com        main.Append(LIBS=['c++'])
7768946Sandreas.hansson@arm.com
77711811Sbaz21@cam.ac.uk    # On FreeBSD we need libthr.
77811811Sbaz21@cam.ac.uk    if sys.platform.startswith('freebsd'):
77911811Sbaz21@cam.ac.uk        main.Append(LIBS=['thr'])
78011811Sbaz21@cam.ac.uk
7813918Ssaidi@eecs.umich.eduelse:
7829068SAli.Saidi@ARM.com    print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal,
7839068SAli.Saidi@ARM.com    print "Don't know what compiler options to use for your compiler."
7849068SAli.Saidi@ARM.com    print termcap.Yellow + '       compiler:' + termcap.Normal, main['CXX']
7859068SAli.Saidi@ARM.com    print termcap.Yellow + '       version:' + termcap.Normal,
7869068SAli.Saidi@ARM.com    if not CXX_version:
7879068SAli.Saidi@ARM.com        print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\
7889068SAli.Saidi@ARM.com               termcap.Normal
7899068SAli.Saidi@ARM.com    else:
7909068SAli.Saidi@ARM.com        print CXX_version.replace('\n', '<nl>')
7919419Sandreas.hansson@arm.com    print "       If you're trying to use a compiler other than GCC"
7929068SAli.Saidi@ARM.com    print "       or clang, there appears to be something wrong with your"
7939068SAli.Saidi@ARM.com    print "       environment."
7949068SAli.Saidi@ARM.com    print "       "
7959068SAli.Saidi@ARM.com    print "       If you are trying to use a compiler other than those listed"
7969068SAli.Saidi@ARM.com    print "       above you will need to ease fix SConstruct and "
7979068SAli.Saidi@ARM.com    print "       src/SConscript to support that compiler."
7983918Ssaidi@eecs.umich.edu    Exit(1)
7993918Ssaidi@eecs.umich.edu
8006157Snate@binkert.org# Set up common yacc/bison flags (needed for Ruby)
8016157Snate@binkert.orgmain['YACCFLAGS'] = '-d'
8026157Snate@binkert.orgmain['YACCHXXFILESUFFIX'] = '.hh'
8036157Snate@binkert.org
8045397Ssaidi@eecs.umich.edu# Do this after we save setting back, or else we'll tack on an
8055397Ssaidi@eecs.umich.edu# extra 'qdo' every time we run scons.
8066121Snate@binkert.orgif main['BATCH']:
8076121Snate@binkert.org    main['CC']     = main['BATCH_CMD'] + ' ' + main['CC']
8086121Snate@binkert.org    main['CXX']    = main['BATCH_CMD'] + ' ' + main['CXX']
8096121Snate@binkert.org    main['AS']     = main['BATCH_CMD'] + ' ' + main['AS']
8106121Snate@binkert.org    main['AR']     = main['BATCH_CMD'] + ' ' + main['AR']
8116121Snate@binkert.org    main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB']
8125397Ssaidi@eecs.umich.edu
8131851SN/Aif sys.platform == 'cygwin':
8141851SN/A    # cygwin has some header file issues...
8157739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=["-Wno-uninitialized"])
816955SN/A
8179396Sandreas.hansson@arm.com# Check for the protobuf compiler
8189396Sandreas.hansson@arm.comprotoc_version = readCommand([main['PROTOC'], '--version'],
8199396Sandreas.hansson@arm.com                             exception='').split()
8209396Sandreas.hansson@arm.com
8219396Sandreas.hansson@arm.com# First two words should be "libprotoc x.y.z"
8229396Sandreas.hansson@arm.comif len(protoc_version) < 2 or protoc_version[0] != 'libprotoc':
8239396Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + \
8249396Sandreas.hansson@arm.com        'Warning: Protocol buffer compiler (protoc) not found.\n' + \
8259396Sandreas.hansson@arm.com        '         Please install protobuf-compiler for tracing support.' + \
8269396Sandreas.hansson@arm.com        termcap.Normal
8279396Sandreas.hansson@arm.com    main['PROTOC'] = False
8289396Sandreas.hansson@arm.comelse:
8299396Sandreas.hansson@arm.com    # Based on the availability of the compress stream wrappers,
8309396Sandreas.hansson@arm.com    # require 2.1.0
8319396Sandreas.hansson@arm.com    min_protoc_version = '2.1.0'
8329396Sandreas.hansson@arm.com    if compareVersions(protoc_version[1], min_protoc_version) < 0:
8339477Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + \
8349477Sandreas.hansson@arm.com            'Warning: protoc version', min_protoc_version, \
8359477Sandreas.hansson@arm.com            'or newer required.\n' + \
8369477Sandreas.hansson@arm.com            '         Installed version:', protoc_version[1], \
8379477Sandreas.hansson@arm.com            termcap.Normal
8389477Sandreas.hansson@arm.com        main['PROTOC'] = False
8399477Sandreas.hansson@arm.com    else:
8409477Sandreas.hansson@arm.com        # Attempt to determine the appropriate include path and
8419477Sandreas.hansson@arm.com        # library path using pkg-config, that means we also need to
8429477Sandreas.hansson@arm.com        # check for pkg-config. Note that it is possible to use
8439477Sandreas.hansson@arm.com        # protobuf without the involvement of pkg-config. Later on we
8449477Sandreas.hansson@arm.com        # check go a library config check and at that point the test
8459477Sandreas.hansson@arm.com        # will fail if libprotobuf cannot be found.
8469477Sandreas.hansson@arm.com        if readCommand(['pkg-config', '--version'], exception=''):
8479477Sandreas.hansson@arm.com            try:
8489477Sandreas.hansson@arm.com                # Attempt to establish what linking flags to add for protobuf
8499477Sandreas.hansson@arm.com                # using pkg-config
8509477Sandreas.hansson@arm.com                main.ParseConfig('pkg-config --cflags --libs-only-L protobuf')
8519477Sandreas.hansson@arm.com            except:
8529477Sandreas.hansson@arm.com                print termcap.Yellow + termcap.Bold + \
8539477Sandreas.hansson@arm.com                    'Warning: pkg-config could not get protobuf flags.' + \
8549477Sandreas.hansson@arm.com                    termcap.Normal
8559396Sandreas.hansson@arm.com
8563053Sstever@eecs.umich.edu# Check for SWIG
8576121Snate@binkert.orgif not main.has_key('SWIG'):
8583053Sstever@eecs.umich.edu    print 'Error: SWIG utility not found.'
8593053Sstever@eecs.umich.edu    print '       Please install (see http://www.swig.org) and retry.'
8603053Sstever@eecs.umich.edu    Exit(1)
8613053Sstever@eecs.umich.edu
8623053Sstever@eecs.umich.edu# Check for appropriate SWIG version
8639072Sandreas.hansson@arm.comswig_version = readCommand([main['SWIG'], '-version'], exception='').split()
8643053Sstever@eecs.umich.edu# First 3 words should be "SWIG Version x.y.z"
8654742Sstever@eecs.umich.eduif len(swig_version) < 3 or \
8664742Sstever@eecs.umich.edu        swig_version[0] != 'SWIG' or swig_version[1] != 'Version':
8673053Sstever@eecs.umich.edu    print 'Error determining SWIG version.'
8683053Sstever@eecs.umich.edu    Exit(1)
8693053Sstever@eecs.umich.edu
87010181SCurtis.Dunham@arm.commin_swig_version = '2.0.4'
8716654Snate@binkert.orgif compareVersions(swig_version[2], min_swig_version) < 0:
8723053Sstever@eecs.umich.edu    print 'Error: SWIG version', min_swig_version, 'or newer required.'
8733053Sstever@eecs.umich.edu    print '       Installed version:', swig_version[2]
8743053Sstever@eecs.umich.edu    Exit(1)
8753053Sstever@eecs.umich.edu
87610425Sandreas.hansson@arm.com# Check for known incompatibilities. The standard library shipped with
87710425Sandreas.hansson@arm.com# gcc >= 4.9 does not play well with swig versions prior to 3.0
87810425Sandreas.hansson@arm.comif main['GCC'] and compareVersions(gcc_version, '4.9') >= 0 and \
87910425Sandreas.hansson@arm.com        compareVersions(swig_version[2], '3.0') < 0:
88010425Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + \
88110425Sandreas.hansson@arm.com        'Warning: This combination of gcc and swig have' + \
88210425Sandreas.hansson@arm.com        ' known incompatibilities.\n' + \
88310425Sandreas.hansson@arm.com        '         If you encounter build problems, please update ' + \
88410425Sandreas.hansson@arm.com        'swig to 3.0 or later.' + \
88510425Sandreas.hansson@arm.com        termcap.Normal
88610425Sandreas.hansson@arm.com
8872667Sstever@eecs.umich.edu# Set up SWIG flags & scanner
8884554Sbinkertn@umich.eduswig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
8896121Snate@binkert.orgmain.Append(SWIGFLAGS=swig_flags)
8902667Sstever@eecs.umich.edu
89110710Sandreas.hansson@arm.com# Check for 'timeout' from GNU coreutils. If present, regressions will
89210710Sandreas.hansson@arm.com# be run with a time limit. We require version 8.13 since we rely on
89310710Sandreas.hansson@arm.com# support for the '--foreground' option.
89411811Sbaz21@cam.ac.ukif sys.platform.startswith('freebsd'):
89511811Sbaz21@cam.ac.uk    timeout_lines = readCommand(['gtimeout', '--version'],
89611811Sbaz21@cam.ac.uk                                exception='').splitlines()
89711811Sbaz21@cam.ac.ukelse:
89811811Sbaz21@cam.ac.uk    timeout_lines = readCommand(['timeout', '--version'],
89911811Sbaz21@cam.ac.uk                                exception='').splitlines()
90010710Sandreas.hansson@arm.com# Get the first line and tokenize it
90110710Sandreas.hansson@arm.comtimeout_version = timeout_lines[0].split() if timeout_lines else []
90210710Sandreas.hansson@arm.commain['TIMEOUT'] =  timeout_version and \
90310710Sandreas.hansson@arm.com    compareVersions(timeout_version[-1], '8.13') >= 0
90410384SCurtis.Dunham@arm.com
9054554Sbinkertn@umich.edu# filter out all existing swig scanners, they mess up the dependency
9064554Sbinkertn@umich.edu# stuff for some reason
9074554Sbinkertn@umich.eduscanners = []
9086121Snate@binkert.orgfor scanner in main['SCANNERS']:
9094554Sbinkertn@umich.edu    skeys = scanner.skeys
9104554Sbinkertn@umich.edu    if skeys == '.i':
9114554Sbinkertn@umich.edu        continue
9124781Snate@binkert.org
9134554Sbinkertn@umich.edu    if isinstance(skeys, (list, tuple)) and '.i' in skeys:
9144554Sbinkertn@umich.edu        continue
9152667Sstever@eecs.umich.edu
9164554Sbinkertn@umich.edu    scanners.append(scanner)
9174554Sbinkertn@umich.edu
9184554Sbinkertn@umich.edu# add the new swig scanner that we like better
9194554Sbinkertn@umich.edufrom SCons.Scanner import ClassicCPP as CPPScanner
9202667Sstever@eecs.umich.eduswig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
9214554Sbinkertn@umich.eduscanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re))
9222667Sstever@eecs.umich.edu
9234554Sbinkertn@umich.edu# replace the scanners list that has what we want
9246121Snate@binkert.orgmain['SCANNERS'] = scanners
9252667Sstever@eecs.umich.edu
9269986Sandreas@sandberg.pp.se# Add a custom Check function to test for structure members.
9279986Sandreas@sandberg.pp.sedef CheckMember(context, include, decl, member, include_quotes="<>"):
9289986Sandreas@sandberg.pp.se    context.Message("Checking for member %s in %s..." %
9299986Sandreas@sandberg.pp.se                    (member, decl))
9309986Sandreas@sandberg.pp.se    text = """
9319986Sandreas@sandberg.pp.se#include %(header)s
9329986Sandreas@sandberg.pp.seint main(){
9339986Sandreas@sandberg.pp.se  %(decl)s test;
9349986Sandreas@sandberg.pp.se  (void)test.%(member)s;
9359986Sandreas@sandberg.pp.se  return 0;
9369986Sandreas@sandberg.pp.se};
9379986Sandreas@sandberg.pp.se""" % { "header" : include_quotes[0] + include + include_quotes[1],
9389986Sandreas@sandberg.pp.se        "decl" : decl,
9399986Sandreas@sandberg.pp.se        "member" : member,
9409986Sandreas@sandberg.pp.se        }
9419986Sandreas@sandberg.pp.se
9429986Sandreas@sandberg.pp.se    ret = context.TryCompile(text, extension=".cc")
9439986Sandreas@sandberg.pp.se    context.Result(ret)
9449986Sandreas@sandberg.pp.se    return ret
9459986Sandreas@sandberg.pp.se
9462638Sstever@eecs.umich.edu# Platform-specific configuration.  Note again that we assume that all
9472638Sstever@eecs.umich.edu# builds under a given build root run on the same host platform.
9486121Snate@binkert.orgconf = Configure(main,
9493716Sstever@eecs.umich.edu                 conf_dir = joinpath(build_root, '.scons_config'),
9505522Snate@binkert.org                 log_file = joinpath(build_root, 'scons_config.log'),
9519986Sandreas@sandberg.pp.se                 custom_tests = {
9529986Sandreas@sandberg.pp.se        'CheckMember' : CheckMember,
9539986Sandreas@sandberg.pp.se        })
9545522Snate@binkert.org
9555227Ssaidi@eecs.umich.edu# Check if we should compile a 64 bit binary on Mac OS X/Darwin
9565227Ssaidi@eecs.umich.edutry:
9575227Ssaidi@eecs.umich.edu    import platform
9585227Ssaidi@eecs.umich.edu    uname = platform.uname()
9596654Snate@binkert.org    if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0:
9606654Snate@binkert.org        if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
9617769SAli.Saidi@ARM.com            main.Append(CCFLAGS=['-arch', 'x86_64'])
9627769SAli.Saidi@ARM.com            main.Append(CFLAGS=['-arch', 'x86_64'])
9637769SAli.Saidi@ARM.com            main.Append(LINKFLAGS=['-arch', 'x86_64'])
9647769SAli.Saidi@ARM.com            main.Append(ASFLAGS=['-arch', 'x86_64'])
9655227Ssaidi@eecs.umich.eduexcept:
9665227Ssaidi@eecs.umich.edu    pass
9675227Ssaidi@eecs.umich.edu
9685204Sstever@gmail.com# Recent versions of scons substitute a "Null" object for Configure()
9695204Sstever@gmail.com# when configuration isn't necessary, e.g., if the "--help" option is
9705204Sstever@gmail.com# present.  Unfortuantely this Null object always returns false,
9715204Sstever@gmail.com# breaking all our configuration checks.  We replace it with our own
9725204Sstever@gmail.com# more optimistic null object that returns True instead.
9735204Sstever@gmail.comif not conf:
9745204Sstever@gmail.com    def NullCheck(*args, **kwargs):
9755204Sstever@gmail.com        return True
9765204Sstever@gmail.com
9775204Sstever@gmail.com    class NullConf:
9785204Sstever@gmail.com        def __init__(self, env):
9795204Sstever@gmail.com            self.env = env
9805204Sstever@gmail.com        def Finish(self):
9815204Sstever@gmail.com            return self.env
9825204Sstever@gmail.com        def __getattr__(self, mname):
9835204Sstever@gmail.com            return NullCheck
9845204Sstever@gmail.com
9856121Snate@binkert.org    conf = NullConf(main)
9865204Sstever@gmail.com
9877727SAli.Saidi@ARM.com# Cache build files in the supplied directory.
9887727SAli.Saidi@ARM.comif main['M5_BUILD_CACHE']:
9897727SAli.Saidi@ARM.com    print 'Using build cache located at', main['M5_BUILD_CACHE']
9907727SAli.Saidi@ARM.com    CacheDir(main['M5_BUILD_CACHE'])
9917727SAli.Saidi@ARM.com
99210453SAndrew.Bardsley@arm.comif not GetOption('without_python'):
99310453SAndrew.Bardsley@arm.com    # Find Python include and library directories for embedding the
99410453SAndrew.Bardsley@arm.com    # interpreter. We rely on python-config to resolve the appropriate
99510453SAndrew.Bardsley@arm.com    # includes and linker flags. ParseConfig does not seem to understand
99610453SAndrew.Bardsley@arm.com    # the more exotic linker flags such as -Xlinker and -export-dynamic so
99710453SAndrew.Bardsley@arm.com    # we add them explicitly below. If you want to link in an alternate
99810453SAndrew.Bardsley@arm.com    # version of python, see above for instructions on how to invoke
99910453SAndrew.Bardsley@arm.com    # scons with the appropriate PATH set.
100010453SAndrew.Bardsley@arm.com    #
100110453SAndrew.Bardsley@arm.com    # First we check if python2-config exists, else we use python-config
100210453SAndrew.Bardsley@arm.com    python_config = readCommand(['which', 'python2-config'],
100310160Sandreas.hansson@arm.com                                exception='').strip()
100410453SAndrew.Bardsley@arm.com    if not os.path.exists(python_config):
100510453SAndrew.Bardsley@arm.com        python_config = readCommand(['which', 'python-config'],
100610453SAndrew.Bardsley@arm.com                                    exception='').strip()
100710453SAndrew.Bardsley@arm.com    py_includes = readCommand([python_config, '--includes'],
100810453SAndrew.Bardsley@arm.com                              exception='').split()
100910453SAndrew.Bardsley@arm.com    # Strip the -I from the include folders before adding them to the
101010453SAndrew.Bardsley@arm.com    # CPPPATH
101110453SAndrew.Bardsley@arm.com    main.Append(CPPPATH=map(lambda inc: inc[2:], py_includes))
10129812Sandreas.hansson@arm.com
101310453SAndrew.Bardsley@arm.com    # Read the linker flags and split them into libraries and other link
101410453SAndrew.Bardsley@arm.com    # flags. The libraries are added later through the call the CheckLib.
101510453SAndrew.Bardsley@arm.com    py_ld_flags = readCommand([python_config, '--ldflags'],
101610453SAndrew.Bardsley@arm.com        exception='').split()
101710453SAndrew.Bardsley@arm.com    py_libs = []
101810453SAndrew.Bardsley@arm.com    for lib in py_ld_flags:
101910453SAndrew.Bardsley@arm.com         if not lib.startswith('-l'):
102010453SAndrew.Bardsley@arm.com             main.Append(LINKFLAGS=[lib])
102110453SAndrew.Bardsley@arm.com         else:
102210453SAndrew.Bardsley@arm.com             lib = lib[2:]
102310453SAndrew.Bardsley@arm.com             if lib not in py_libs:
102410453SAndrew.Bardsley@arm.com                 py_libs.append(lib)
10257727SAli.Saidi@ARM.com
102610453SAndrew.Bardsley@arm.com    # verify that this stuff works
102710453SAndrew.Bardsley@arm.com    if not conf.CheckHeader('Python.h', '<>'):
102810453SAndrew.Bardsley@arm.com        print "Error: can't find Python.h header in", py_includes
102910453SAndrew.Bardsley@arm.com        print "Install Python headers (package python-dev on Ubuntu and RedHat)"
103010453SAndrew.Bardsley@arm.com        Exit(1)
10313118Sstever@eecs.umich.edu
103210453SAndrew.Bardsley@arm.com    for lib in py_libs:
103310453SAndrew.Bardsley@arm.com        if not conf.CheckLib(lib):
103410453SAndrew.Bardsley@arm.com            print "Error: can't find library %s required by python" % lib
103510453SAndrew.Bardsley@arm.com            Exit(1)
10363118Sstever@eecs.umich.edu
10373483Ssaidi@eecs.umich.edu# On Solaris you need to use libsocket for socket ops
10383494Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
10393494Ssaidi@eecs.umich.edu   if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
10403483Ssaidi@eecs.umich.edu       print "Can't find library with socket calls (e.g. accept())"
10413483Ssaidi@eecs.umich.edu       Exit(1)
10423483Ssaidi@eecs.umich.edu
10433053Sstever@eecs.umich.edu# Check for zlib.  If the check passes, libz will be automatically
10443053Sstever@eecs.umich.edu# added to the LIBS environment variable.
10453918Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
10463053Sstever@eecs.umich.edu    print 'Error: did not find needed zlib compression library '\
10473053Sstever@eecs.umich.edu          'and/or zlib.h header file.'
10483053Sstever@eecs.umich.edu    print '       Please install zlib and try again.'
10493053Sstever@eecs.umich.edu    Exit(1)
10503053Sstever@eecs.umich.edu
10519396Sandreas.hansson@arm.com# If we have the protobuf compiler, also make sure we have the
10529396Sandreas.hansson@arm.com# development libraries. If the check passes, libprotobuf will be
10539396Sandreas.hansson@arm.com# automatically added to the LIBS environment variable. After
10549396Sandreas.hansson@arm.com# this, we can use the HAVE_PROTOBUF flag to determine if we have
10559396Sandreas.hansson@arm.com# got both protoc and libprotobuf available.
10569396Sandreas.hansson@arm.commain['HAVE_PROTOBUF'] = main['PROTOC'] and \
10579396Sandreas.hansson@arm.com    conf.CheckLibWithHeader('protobuf', 'google/protobuf/message.h',
10589396Sandreas.hansson@arm.com                            'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;')
10599396Sandreas.hansson@arm.com
10609477Sandreas.hansson@arm.com# If we have the compiler but not the library, print another warning.
10619396Sandreas.hansson@arm.comif main['PROTOC'] and not main['HAVE_PROTOBUF']:
10629477Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + \
10639477Sandreas.hansson@arm.com        'Warning: did not find protocol buffer library and/or headers.\n' + \
10649477Sandreas.hansson@arm.com    '       Please install libprotobuf-dev for tracing support.' + \
10659477Sandreas.hansson@arm.com    termcap.Normal
10669396Sandreas.hansson@arm.com
10677840Snate@binkert.org# Check for librt.
10687865Sgblack@eecs.umich.eduhave_posix_clock = \
10697865Sgblack@eecs.umich.edu    conf.CheckLibWithHeader(None, 'time.h', 'C',
10707865Sgblack@eecs.umich.edu                            'clock_nanosleep(0,0,NULL,NULL);') or \
10717865Sgblack@eecs.umich.edu    conf.CheckLibWithHeader('rt', 'time.h', 'C',
10727865Sgblack@eecs.umich.edu                            'clock_nanosleep(0,0,NULL,NULL);')
10737840Snate@binkert.org
10749900Sandreas@sandberg.pp.sehave_posix_timers = \
10759900Sandreas@sandberg.pp.se    conf.CheckLibWithHeader([None, 'rt'], [ 'time.h', 'signal.h' ], 'C',
10769900Sandreas@sandberg.pp.se                            'timer_create(CLOCK_MONOTONIC, NULL, NULL);')
10779900Sandreas@sandberg.pp.se
107810456SCurtis.Dunham@arm.comif not GetOption('without_tcmalloc'):
107910456SCurtis.Dunham@arm.com    if conf.CheckLib('tcmalloc'):
108010456SCurtis.Dunham@arm.com        main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS'])
108110456SCurtis.Dunham@arm.com    elif conf.CheckLib('tcmalloc_minimal'):
108210456SCurtis.Dunham@arm.com        main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS'])
108310456SCurtis.Dunham@arm.com    else:
108410456SCurtis.Dunham@arm.com        print termcap.Yellow + termcap.Bold + \
108510456SCurtis.Dunham@arm.com              "You can get a 12% performance improvement by "\
108610456SCurtis.Dunham@arm.com              "installing tcmalloc (libgoogle-perftools-dev package "\
108710456SCurtis.Dunham@arm.com              "on Ubuntu or RedHat)." + termcap.Normal
10889045SAli.Saidi@ARM.com
108911235Sandreas.sandberg@arm.com
109011235Sandreas.sandberg@arm.com# Detect back trace implementations. The last implementation in the
109111235Sandreas.sandberg@arm.com# list will be used by default.
109211235Sandreas.sandberg@arm.combacktrace_impls = [ "none" ]
109311235Sandreas.sandberg@arm.com
109411235Sandreas.sandberg@arm.comif conf.CheckLibWithHeader(None, 'execinfo.h', 'C',
109511235Sandreas.sandberg@arm.com                           'backtrace_symbols_fd((void*)0, 0, 0);'):
109611235Sandreas.sandberg@arm.com    backtrace_impls.append("glibc")
109711811Sbaz21@cam.ac.ukelif conf.CheckLibWithHeader('execinfo', 'execinfo.h', 'C',
109811811Sbaz21@cam.ac.uk                           'backtrace_symbols_fd((void*)0, 0, 0);'):
109911811Sbaz21@cam.ac.uk    # NetBSD and FreeBSD need libexecinfo.
110011811Sbaz21@cam.ac.uk    backtrace_impls.append("glibc")
110111811Sbaz21@cam.ac.uk    main.Append(LIBS=['execinfo'])
110211235Sandreas.sandberg@arm.com
110311235Sandreas.sandberg@arm.comif backtrace_impls[-1] == "none":
110411235Sandreas.sandberg@arm.com    default_backtrace_impl = "none"
110511235Sandreas.sandberg@arm.com    print termcap.Yellow + termcap.Bold + \
110611235Sandreas.sandberg@arm.com        "No suitable back trace implementation found." + \
110711235Sandreas.sandberg@arm.com        termcap.Normal
110811235Sandreas.sandberg@arm.com
11097840Snate@binkert.orgif not have_posix_clock:
11107840Snate@binkert.org    print "Can't find library for POSIX clocks."
11117840Snate@binkert.org
11121858SN/A# Check for <fenv.h> (C99 FP environment control)
11131858SN/Ahave_fenv = conf.CheckHeader('fenv.h', '<>')
11141858SN/Aif not have_fenv:
11151858SN/A    print "Warning: Header file <fenv.h> not found."
11161858SN/A    print "         This host has no IEEE FP rounding mode control."
11171858SN/A
11189903Sandreas.hansson@arm.com# Check if we should enable KVM-based hardware virtualization. The API
11199903Sandreas.hansson@arm.com# we rely on exists since version 2.6.36 of the kernel, but somehow
11209903Sandreas.hansson@arm.com# the KVM_API_VERSION does not reflect the change. We test for one of
11219903Sandreas.hansson@arm.com# the types as a fall back.
112210841Sandreas.sandberg@arm.comhave_kvm = conf.CheckHeader('linux/kvm.h', '<>')
11239651SAndreas.Sandberg@ARM.comif not have_kvm:
11249903Sandreas.hansson@arm.com    print "Info: Compatible header file <linux/kvm.h> not found, " \
11259651SAndreas.Sandberg@ARM.com        "disabling KVM support."
11269651SAndreas.Sandberg@ARM.com
112710841Sandreas.sandberg@arm.com# x86 needs support for xsave. We test for the structure here since we
112810841Sandreas.sandberg@arm.com# won't be able to run new tests by the time we know which ISA we're
112910841Sandreas.sandberg@arm.com# targeting.
113010841Sandreas.sandberg@arm.comhave_kvm_xsave = conf.CheckTypeSize('struct kvm_xsave',
113110841Sandreas.sandberg@arm.com                                    '#include <linux/kvm.h>') != 0
113210841Sandreas.sandberg@arm.com
11339651SAndreas.Sandberg@ARM.com# Check if the requested target ISA is compatible with the host
11349651SAndreas.Sandberg@ARM.comdef is_isa_kvm_compatible(isa):
11359651SAndreas.Sandberg@ARM.com    try:
11369651SAndreas.Sandberg@ARM.com        import platform
11379651SAndreas.Sandberg@ARM.com        host_isa = platform.machine()
11389651SAndreas.Sandberg@ARM.com    except:
11399651SAndreas.Sandberg@ARM.com        print "Warning: Failed to determine host ISA."
11409651SAndreas.Sandberg@ARM.com        return False
11419651SAndreas.Sandberg@ARM.com
114210841Sandreas.sandberg@arm.com    if not have_posix_timers:
114310841Sandreas.sandberg@arm.com        print "Warning: Can not enable KVM, host seems to lack support " \
114410841Sandreas.sandberg@arm.com            "for POSIX timers"
114510841Sandreas.sandberg@arm.com        return False
114610841Sandreas.sandberg@arm.com
114710841Sandreas.sandberg@arm.com    if isa == "arm":
114810860Sandreas.sandberg@arm.com        return host_isa in ( "armv7l", "aarch64" )
114910841Sandreas.sandberg@arm.com    elif isa == "x86":
115010841Sandreas.sandberg@arm.com        if host_isa != "x86_64":
115110841Sandreas.sandberg@arm.com            return False
115210841Sandreas.sandberg@arm.com
115310841Sandreas.sandberg@arm.com        if not have_kvm_xsave:
115410841Sandreas.sandberg@arm.com            print "KVM on x86 requires xsave support in kernel headers."
115510841Sandreas.sandberg@arm.com            return False
115610841Sandreas.sandberg@arm.com
115710841Sandreas.sandberg@arm.com        return True
115810841Sandreas.sandberg@arm.com    else:
115910841Sandreas.sandberg@arm.com        return False
11609651SAndreas.Sandberg@ARM.com
11619651SAndreas.Sandberg@ARM.com
11629986Sandreas@sandberg.pp.se# Check if the exclude_host attribute is available. We want this to
11639986Sandreas@sandberg.pp.se# get accurate instruction counts in KVM.
11649986Sandreas@sandberg.pp.semain['HAVE_PERF_ATTR_EXCLUDE_HOST'] = conf.CheckMember(
11659986Sandreas@sandberg.pp.se    'linux/perf_event.h', 'struct perf_event_attr', 'exclude_host')
11669986Sandreas@sandberg.pp.se
11679986Sandreas@sandberg.pp.se
11685863Snate@binkert.org######################################################################
11695863Snate@binkert.org#
11705863Snate@binkert.org# Finish the configuration
11715863Snate@binkert.org#
11726121Snate@binkert.orgmain = conf.Finish()
11731858SN/A
11745863Snate@binkert.org######################################################################
11755863Snate@binkert.org#
11765863Snate@binkert.org# Collect all non-global variables
11775863Snate@binkert.org#
11785863Snate@binkert.org
11792139SN/A# Define the universe of supported ISAs
11804202Sbinkertn@umich.eduall_isa_list = [ ]
118111308Santhony.gutierrez@amd.comall_gpu_isa_list = [ ]
11824202Sbinkertn@umich.eduExport('all_isa_list')
118311308Santhony.gutierrez@amd.comExport('all_gpu_isa_list')
11842139SN/A
11856994Snate@binkert.orgclass CpuModel(object):
11866994Snate@binkert.org    '''The CpuModel class encapsulates everything the ISA parser needs to
11876994Snate@binkert.org    know about a particular CPU model.'''
11886994Snate@binkert.org
11896994Snate@binkert.org    # Dict of available CPU model objects.  Accessible as CpuModel.dict.
11906994Snate@binkert.org    dict = {}
11916994Snate@binkert.org
11926994Snate@binkert.org    # Constructor.  Automatically adds models to CpuModel.dict.
119310319SAndreas.Sandberg@ARM.com    def __init__(self, name, default=False):
11946994Snate@binkert.org        self.name = name           # name of model
11956994Snate@binkert.org
11966994Snate@binkert.org        # This cpu is enabled by default
11976994Snate@binkert.org        self.default = default
11986994Snate@binkert.org
11996994Snate@binkert.org        # Add self to dict
12006994Snate@binkert.org        if name in CpuModel.dict:
12016994Snate@binkert.org            raise AttributeError, "CpuModel '%s' already registered" % name
12026994Snate@binkert.org        CpuModel.dict[name] = self
12036994Snate@binkert.org
12046994Snate@binkert.orgExport('CpuModel')
12052155SN/A
12065863Snate@binkert.org# Sticky variables get saved in the variables file so they persist from
12071869SN/A# one invocation to the next (unless overridden, in which case the new
12081869SN/A# value becomes sticky).
12095863Snate@binkert.orgsticky_vars = Variables(args=ARGUMENTS)
12105863Snate@binkert.orgExport('sticky_vars')
12114202Sbinkertn@umich.edu
12126108Snate@binkert.org# Sticky variables that should be exported
12136108Snate@binkert.orgexport_vars = []
12146108Snate@binkert.orgExport('export_vars')
12156108Snate@binkert.org
12169219Spower.jg@gmail.com# For Ruby
12179219Spower.jg@gmail.comall_protocols = []
12189219Spower.jg@gmail.comExport('all_protocols')
12199219Spower.jg@gmail.comprotocol_dirs = []
12209219Spower.jg@gmail.comExport('protocol_dirs')
12219219Spower.jg@gmail.comslicc_includes = []
12229219Spower.jg@gmail.comExport('slicc_includes')
12239219Spower.jg@gmail.com
12244202Sbinkertn@umich.edu# Walk the tree and execute all SConsopts scripts that wil add to the
12255863Snate@binkert.org# above variables
122610135SCurtis.Dunham@arm.comif GetOption('verbose'):
12278474Sgblack@eecs.umich.edu    print "Reading SConsopts"
12285742Snate@binkert.orgfor bdir in [ base_dir ] + extras_dir_list:
12298268Ssteve.reinhardt@amd.com    if not isdir(bdir):
12308268Ssteve.reinhardt@amd.com        print "Error: directory '%s' does not exist" % bdir
12318268Ssteve.reinhardt@amd.com        Exit(1)
12325742Snate@binkert.org    for root, dirs, files in os.walk(bdir):
12335341Sstever@gmail.com        if 'SConsopts' in files:
12348474Sgblack@eecs.umich.edu            if GetOption('verbose'):
12358474Sgblack@eecs.umich.edu                print "Reading", joinpath(root, 'SConsopts')
12365342Sstever@gmail.com            SConscript(joinpath(root, 'SConsopts'))
12374202Sbinkertn@umich.edu
12384202Sbinkertn@umich.eduall_isa_list.sort()
123911308Santhony.gutierrez@amd.comall_gpu_isa_list.sort()
12404202Sbinkertn@umich.edu
12415863Snate@binkert.orgsticky_vars.AddVariables(
12425863Snate@binkert.org    EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list),
124311308Santhony.gutierrez@amd.com    EnumVariable('TARGET_GPU_ISA', 'Target GPU ISA', 'hsail', all_gpu_isa_list),
12446994Snate@binkert.org    ListVariable('CPU_MODELS', 'CPU models',
12456994Snate@binkert.org                 sorted(n for n,m in CpuModel.dict.iteritems() if m.default),
124610319SAndreas.Sandberg@ARM.com                 sorted(CpuModel.dict.keys())),
12475863Snate@binkert.org    BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
12485863Snate@binkert.org                 False),
12495863Snate@binkert.org    BoolVariable('SS_COMPATIBLE_FP',
12505863Snate@binkert.org                 'Make floating-point results compatible with SimpleScalar',
12515863Snate@binkert.org                 False),
12525863Snate@binkert.org    BoolVariable('USE_SSE2',
12535863Snate@binkert.org                 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
12545863Snate@binkert.org                 False),
12557840Snate@binkert.org    BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock),
12565863Snate@binkert.org    BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
12575952Ssaidi@eecs.umich.edu    BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False),
12589651SAndreas.Sandberg@ARM.com    BoolVariable('USE_KVM', 'Enable hardware virtualized (KVM) CPU models', have_kvm),
125911308Santhony.gutierrez@amd.com    BoolVariable('BUILD_GPU', 'Build the compute-GPU model', False),
12609219Spower.jg@gmail.com    EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None',
12619219Spower.jg@gmail.com                  all_protocols),
126211235Sandreas.sandberg@arm.com    EnumVariable('BACKTRACE_IMPL', 'Post-mortem dump implementation',
126311235Sandreas.sandberg@arm.com                 backtrace_impls[-1], backtrace_impls)
12641869SN/A    )
12651858SN/A
12665863Snate@binkert.org# These variables get exported to #defines in config/*.hh (see src/SConscript).
126711308Santhony.gutierrez@amd.comexport_vars += ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'TARGET_GPU_ISA',
126811308Santhony.gutierrez@amd.com                'CP_ANNOTATE', 'USE_POSIX_CLOCK', 'USE_KVM', 'PROTOCOL',
126911308Santhony.gutierrez@amd.com                'HAVE_PROTOBUF', 'HAVE_PERF_ATTR_EXCLUDE_HOST']
12701858SN/A
1271955SN/A###################################################
1272955SN/A#
12731869SN/A# Define a SCons builder for configuration flag headers.
12741869SN/A#
12751869SN/A###################################################
12761869SN/A
12771869SN/A# This function generates a config header file that #defines the
12785863Snate@binkert.org# variable symbol to the current variable setting (0 or 1).  The source
12795863Snate@binkert.org# operands are the name of the variable and a Value node containing the
12805863Snate@binkert.org# value of the variable.
12811869SN/Adef build_config_file(target, source, env):
12825863Snate@binkert.org    (variable, value) = [s.get_contents() for s in source]
12831869SN/A    f = file(str(target[0]), 'w')
12845863Snate@binkert.org    print >> f, '#define', variable, value
12851869SN/A    f.close()
12861869SN/A    return None
12871869SN/A
12881869SN/A# Combine the two functions into a scons Action object.
12898483Sgblack@eecs.umich.educonfig_action = MakeAction(build_config_file, Transform("CONFIG H", 2))
12901869SN/A
12911869SN/A# The emitter munges the source & target node lists to reflect what
12921869SN/A# we're really doing.
12931869SN/Adef config_emitter(target, source, env):
12945863Snate@binkert.org    # extract variable name from Builder arg
12955863Snate@binkert.org    variable = str(target[0])
12961869SN/A    # True target is config header file
12975863Snate@binkert.org    target = joinpath('config', variable.lower() + '.hh')
12985863Snate@binkert.org    val = env[variable]
12993356Sbinkertn@umich.edu    if isinstance(val, bool):
13003356Sbinkertn@umich.edu        # Force value to 0/1
13013356Sbinkertn@umich.edu        val = int(val)
13023356Sbinkertn@umich.edu    elif isinstance(val, str):
13033356Sbinkertn@umich.edu        val = '"' + val + '"'
13044781Snate@binkert.org
13055863Snate@binkert.org    # Sources are variable name & value (packaged in SCons Value nodes)
13065863Snate@binkert.org    return ([target], [Value(variable), Value(val)])
13071869SN/A
13081869SN/Aconfig_builder = Builder(emitter = config_emitter, action = config_action)
13091869SN/A
13106121Snate@binkert.orgmain.Append(BUILDERS = { 'ConfigFile' : config_builder })
13111869SN/A
13122638Sstever@eecs.umich.edu# libelf build is shared across all configs in the build root.
13136121Snate@binkert.orgmain.SConscript('ext/libelf/SConscript',
13146121Snate@binkert.org                variant_dir = joinpath(build_root, 'libelf'))
13152638Sstever@eecs.umich.edu
131611293Sandreas.hansson@arm.com# iostream3 build is shared across all configs in the build root.
131711293Sandreas.hansson@arm.commain.SConscript('ext/iostream3/SConscript',
131811293Sandreas.hansson@arm.com                variant_dir = joinpath(build_root, 'iostream3'))
13195749Scws3k@cs.virginia.edu
13209537Satgutier@umich.edu# libfdt build is shared across all configs in the build root.
13219537Satgutier@umich.edumain.SConscript('ext/libfdt/SConscript',
13229537Satgutier@umich.edu                variant_dir = joinpath(build_root, 'libfdt'))
13239537Satgutier@umich.edu
13249888Sandreas@sandberg.pp.se# fputils build is shared across all configs in the build root.
13259888Sandreas@sandberg.pp.semain.SConscript('ext/fputils/SConscript',
13269888Sandreas@sandberg.pp.se                variant_dir = joinpath(build_root, 'fputils'))
13279888Sandreas@sandberg.pp.se
132810066Sandreas.hansson@arm.com# DRAMSim2 build is shared across all configs in the build root.
132910066Sandreas.hansson@arm.commain.SConscript('ext/dramsim2/SConscript',
133010066Sandreas.hansson@arm.com                variant_dir = joinpath(build_root, 'dramsim2'))
133110066Sandreas.hansson@arm.com
133210428Sandreas.hansson@arm.com# DRAMPower build is shared across all configs in the build root.
133310428Sandreas.hansson@arm.commain.SConscript('ext/drampower/SConscript',
133410428Sandreas.hansson@arm.com                variant_dir = joinpath(build_root, 'drampower'))
133510428Sandreas.hansson@arm.com
133610915Sandreas.sandberg@arm.com# nomali build is shared across all configs in the build root.
133710915Sandreas.sandberg@arm.commain.SConscript('ext/nomali/SConscript',
133810915Sandreas.sandberg@arm.com                variant_dir = joinpath(build_root, 'nomali'))
133910915Sandreas.sandberg@arm.com
13401869SN/A###################################################
13411869SN/A#
13423546Sgblack@eecs.umich.edu# This function is used to set up a directory with switching headers
13433546Sgblack@eecs.umich.edu#
13443546Sgblack@eecs.umich.edu###################################################
13453546Sgblack@eecs.umich.edu
13466121Snate@binkert.orgmain['ALL_ISA_LIST'] = all_isa_list
134711308Santhony.gutierrez@amd.commain['ALL_GPU_ISA_LIST'] = all_gpu_isa_list
134810196SCurtis.Dunham@arm.comall_isa_deps = {}
13495863Snate@binkert.orgdef make_switching_dir(dname, switch_headers, env):
13503546Sgblack@eecs.umich.edu    # Generate the header.  target[0] is the full path of the output
13513546Sgblack@eecs.umich.edu    # header to generate.  'source' is a dummy variable, since we get the
13523546Sgblack@eecs.umich.edu    # list of ISAs from env['ALL_ISA_LIST'].
13533546Sgblack@eecs.umich.edu    def gen_switch_hdr(target, source, env):
13544781Snate@binkert.org        fname = str(target[0])
13556658Snate@binkert.org        isa = env['TARGET_ISA'].lower()
135610196SCurtis.Dunham@arm.com        try:
135710196SCurtis.Dunham@arm.com            f = open(fname, 'w')
135810196SCurtis.Dunham@arm.com            print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname))
135910196SCurtis.Dunham@arm.com            f.close()
136010196SCurtis.Dunham@arm.com        except IOError:
136110196SCurtis.Dunham@arm.com            print "Failed to create %s" % fname
136210196SCurtis.Dunham@arm.com            raise
13633546Sgblack@eecs.umich.edu
13643546Sgblack@eecs.umich.edu    # Build SCons Action object. 'varlist' specifies env vars that this
13653546Sgblack@eecs.umich.edu    # action depends on; when env['ALL_ISA_LIST'] changes these actions
13663546Sgblack@eecs.umich.edu    # should get re-executed.
13677756SAli.Saidi@ARM.com    switch_hdr_action = MakeAction(gen_switch_hdr,
13687816Ssteve.reinhardt@amd.com                          Transform("GENERATE"), varlist=['ALL_ISA_LIST'])
13693546Sgblack@eecs.umich.edu
13703546Sgblack@eecs.umich.edu    # Instantiate actions for each header
13713546Sgblack@eecs.umich.edu    for hdr in switch_headers:
13723546Sgblack@eecs.umich.edu        env.Command(hdr, [], switch_hdr_action)
137310196SCurtis.Dunham@arm.com
137410196SCurtis.Dunham@arm.com    isa_target = Dir('.').up().name.lower().replace('_', '-')
137510196SCurtis.Dunham@arm.com    env['PHONY_BASE'] = '#'+isa_target
137610196SCurtis.Dunham@arm.com    all_isa_deps[isa_target] = None
137710196SCurtis.Dunham@arm.com
13784202Sbinkertn@umich.eduExport('make_switching_dir')
13793546Sgblack@eecs.umich.edu
138011308Santhony.gutierrez@amd.comdef make_gpu_switching_dir(dname, switch_headers, env):
138111308Santhony.gutierrez@amd.com    # Generate the header.  target[0] is the full path of the output
138211308Santhony.gutierrez@amd.com    # header to generate.  'source' is a dummy variable, since we get the
138311308Santhony.gutierrez@amd.com    # list of ISAs from env['ALL_ISA_LIST'].
138411308Santhony.gutierrez@amd.com    def gen_switch_hdr(target, source, env):
138511308Santhony.gutierrez@amd.com        fname = str(target[0])
138611308Santhony.gutierrez@amd.com
138711308Santhony.gutierrez@amd.com        isa = env['TARGET_GPU_ISA'].lower()
138811308Santhony.gutierrez@amd.com
138911308Santhony.gutierrez@amd.com        try:
139011308Santhony.gutierrez@amd.com            f = open(fname, 'w')
139111308Santhony.gutierrez@amd.com            print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname))
139211308Santhony.gutierrez@amd.com            f.close()
139311308Santhony.gutierrez@amd.com        except IOError:
139411308Santhony.gutierrez@amd.com            print "Failed to create %s" % fname
139511308Santhony.gutierrez@amd.com            raise
139611308Santhony.gutierrez@amd.com
139711308Santhony.gutierrez@amd.com    # Build SCons Action object. 'varlist' specifies env vars that this
139811308Santhony.gutierrez@amd.com    # action depends on; when env['ALL_ISA_LIST'] changes these actions
139911308Santhony.gutierrez@amd.com    # should get re-executed.
140011308Santhony.gutierrez@amd.com    switch_hdr_action = MakeAction(gen_switch_hdr,
140111308Santhony.gutierrez@amd.com                          Transform("GENERATE"), varlist=['ALL_ISA_GPU_LIST'])
140211308Santhony.gutierrez@amd.com
140311308Santhony.gutierrez@amd.com    # Instantiate actions for each header
140411308Santhony.gutierrez@amd.com    for hdr in switch_headers:
140511308Santhony.gutierrez@amd.com        env.Command(hdr, [], switch_hdr_action)
140611308Santhony.gutierrez@amd.com
140711308Santhony.gutierrez@amd.comExport('make_gpu_switching_dir')
140811308Santhony.gutierrez@amd.com
140910196SCurtis.Dunham@arm.com# all-isas -> all-deps -> all-environs -> all_targets
141010196SCurtis.Dunham@arm.commain.Alias('#all-isas', [])
141110196SCurtis.Dunham@arm.commain.Alias('#all-deps', '#all-isas')
141210196SCurtis.Dunham@arm.com
141310196SCurtis.Dunham@arm.com# Dummy target to ensure all environments are created before telling
141410196SCurtis.Dunham@arm.com# SCons what to actually make (the command line arguments).  We attach
141510196SCurtis.Dunham@arm.com# them to the dependence graph after the environments are complete.
141610196SCurtis.Dunham@arm.comORIG_BUILD_TARGETS = list(BUILD_TARGETS) # force a copy; gets closure to work.
141710196SCurtis.Dunham@arm.comdef environsComplete(target, source, env):
141810196SCurtis.Dunham@arm.com    for t in ORIG_BUILD_TARGETS:
141910196SCurtis.Dunham@arm.com        main.Depends('#all-targets', t)
142010196SCurtis.Dunham@arm.com
142110196SCurtis.Dunham@arm.com# Each build/* switching_dir attaches its *-environs target to #all-environs.
142210196SCurtis.Dunham@arm.commain.Append(BUILDERS = {'CompleteEnvirons' :
142310196SCurtis.Dunham@arm.com                        Builder(action=MakeAction(environsComplete, None))})
142410196SCurtis.Dunham@arm.commain.CompleteEnvirons('#all-environs', [])
142510196SCurtis.Dunham@arm.com
142610196SCurtis.Dunham@arm.comdef doNothing(**ignored): pass
142710196SCurtis.Dunham@arm.commain.Append(BUILDERS = {'Dummy': Builder(action=MakeAction(doNothing, None))})
142810196SCurtis.Dunham@arm.com
142910196SCurtis.Dunham@arm.com# The final target to which all the original targets ultimately get attached.
143010196SCurtis.Dunham@arm.commain.Dummy('#all-targets', '#all-environs')
143110196SCurtis.Dunham@arm.comBUILD_TARGETS[:] = ['#all-targets']
143210196SCurtis.Dunham@arm.com
14333546Sgblack@eecs.umich.edu###################################################
14343546Sgblack@eecs.umich.edu#
1435955SN/A# Define build environments for selected configurations.
1436955SN/A#
1437955SN/A###################################################
1438955SN/A
14395863Snate@binkert.orgfor variant_path in variant_paths:
144010135SCurtis.Dunham@arm.com    if not GetOption('silent'):
144110135SCurtis.Dunham@arm.com        print "Building in", variant_path
14425343Sstever@gmail.com
14435343Sstever@gmail.com    # Make a copy of the build-root environment to use for this config.
14446121Snate@binkert.org    env = main.Clone()
14455863Snate@binkert.org    env['BUILDDIR'] = variant_path
14464773Snate@binkert.org
14475863Snate@binkert.org    # variant_dir is the tail component of build path, and is used to
14482632Sstever@eecs.umich.edu    # determine the build parameters (e.g., 'ALPHA_SE')
14495863Snate@binkert.org    (build_root, variant_dir) = splitpath(variant_path)
14502023SN/A
14515863Snate@binkert.org    # Set env variables according to the build directory config.
14525863Snate@binkert.org    sticky_vars.files = []
14535863Snate@binkert.org    # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
14545863Snate@binkert.org    # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
14555863Snate@binkert.org    # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
14565863Snate@binkert.org    current_vars_file = joinpath(build_root, 'variables', variant_dir)
14575863Snate@binkert.org    if isfile(current_vars_file):
14585863Snate@binkert.org        sticky_vars.files.append(current_vars_file)
145910135SCurtis.Dunham@arm.com        if not GetOption('silent'):
146010135SCurtis.Dunham@arm.com            print "Using saved variables file %s" % current_vars_file
14612632Sstever@eecs.umich.edu    else:
14625863Snate@binkert.org        # Build dir-specific variables file doesn't exist.
14632023SN/A
14642632Sstever@eecs.umich.edu        # Make sure the directory is there so we can create it later
14655863Snate@binkert.org        opt_dir = dirname(current_vars_file)
14665342Sstever@gmail.com        if not isdir(opt_dir):
14675863Snate@binkert.org            mkdir(opt_dir)
14682632Sstever@eecs.umich.edu
14695863Snate@binkert.org        # Get default build variables from source tree.  Variables are
14705863Snate@binkert.org        # normally determined by name of $VARIANT_DIR, but can be
14718267Ssteve.reinhardt@amd.com        # overridden by '--default=' arg on command line.
14728120Sgblack@eecs.umich.edu        default = GetOption('default')
14738267Ssteve.reinhardt@amd.com        opts_dir = joinpath(main.root.abspath, 'build_opts')
14748267Ssteve.reinhardt@amd.com        if default:
14758267Ssteve.reinhardt@amd.com            default_vars_files = [joinpath(build_root, 'variables', default),
14768267Ssteve.reinhardt@amd.com                                  joinpath(opts_dir, default)]
14778267Ssteve.reinhardt@amd.com        else:
14788267Ssteve.reinhardt@amd.com            default_vars_files = [joinpath(opts_dir, variant_dir)]
14798267Ssteve.reinhardt@amd.com        existing_files = filter(isfile, default_vars_files)
14808267Ssteve.reinhardt@amd.com        if existing_files:
14818267Ssteve.reinhardt@amd.com            default_vars_file = existing_files[0]
14825863Snate@binkert.org            sticky_vars.files.append(default_vars_file)
14835863Snate@binkert.org            print "Variables file %s not found,\n  using defaults in %s" \
14845863Snate@binkert.org                  % (current_vars_file, default_vars_file)
14852632Sstever@eecs.umich.edu        else:
14868267Ssteve.reinhardt@amd.com            print "Error: cannot find variables file %s or " \
14878267Ssteve.reinhardt@amd.com                  "default file(s) %s" \
14888267Ssteve.reinhardt@amd.com                  % (current_vars_file, ' or '.join(default_vars_files))
14892632Sstever@eecs.umich.edu            Exit(1)
14901888SN/A
14915863Snate@binkert.org    # Apply current variable settings to env
14925863Snate@binkert.org    sticky_vars.Update(env)
14931858SN/A
14948120Sgblack@eecs.umich.edu    help_texts["local_vars"] += \
14958120Sgblack@eecs.umich.edu        "Build variables for %s:\n" % variant_dir \
14967756SAli.Saidi@ARM.com                 + sticky_vars.GenerateHelpText(env)
14972598SN/A
14985863Snate@binkert.org    # Process variable settings.
14991858SN/A
15001858SN/A    if not have_fenv and env['USE_FENV']:
15011858SN/A        print "Warning: <fenv.h> not available; " \
15025863Snate@binkert.org              "forcing USE_FENV to False in", variant_dir + "."
15031858SN/A        env['USE_FENV'] = False
15041858SN/A
15051858SN/A    if not env['USE_FENV']:
15065863Snate@binkert.org        print "Warning: No IEEE FP rounding mode control in", variant_dir + "."
15071871SN/A        print "         FP results may deviate slightly from other platforms."
15081858SN/A
15091858SN/A    if env['EFENCE']:
15101858SN/A        env.Append(LIBS=['efence'])
15111858SN/A
15129651SAndreas.Sandberg@ARM.com    if env['USE_KVM']:
15139651SAndreas.Sandberg@ARM.com        if not have_kvm:
15149651SAndreas.Sandberg@ARM.com            print "Warning: Can not enable KVM, host seems to lack KVM support"
15159651SAndreas.Sandberg@ARM.com            env['USE_KVM'] = False
15169651SAndreas.Sandberg@ARM.com        elif not is_isa_kvm_compatible(env['TARGET_ISA']):
15179651SAndreas.Sandberg@ARM.com            print "Info: KVM support disabled due to unsupported host and " \
15189651SAndreas.Sandberg@ARM.com                "target ISA combination"
15199651SAndreas.Sandberg@ARM.com            env['USE_KVM'] = False
15209651SAndreas.Sandberg@ARM.com
152111798Santhony.gutierrez@amd.com    if env['BUILD_GPU']:
152211798Santhony.gutierrez@amd.com        env.Append(CPPDEFINES=['BUILD_GPU'])
152311798Santhony.gutierrez@amd.com
15249986Sandreas@sandberg.pp.se    # Warn about missing optional functionality
15259986Sandreas@sandberg.pp.se    if env['USE_KVM']:
15269986Sandreas@sandberg.pp.se        if not main['HAVE_PERF_ATTR_EXCLUDE_HOST']:
15279986Sandreas@sandberg.pp.se            print "Warning: perf_event headers lack support for the " \
15289986Sandreas@sandberg.pp.se                "exclude_host attribute. KVM instruction counts will " \
15299986Sandreas@sandberg.pp.se                "be inaccurate."
15309986Sandreas@sandberg.pp.se
15315863Snate@binkert.org    # Save sticky variable settings back to current variables file
15325863Snate@binkert.org    sticky_vars.Save(current_vars_file, env)
15331869SN/A
15341965SN/A    if env['USE_SSE2']:
15357739Sgblack@eecs.umich.edu        env.Append(CCFLAGS=['-msse2'])
15361965SN/A
15372761Sstever@eecs.umich.edu    # The src/SConscript file sets up the build rules in 'env' according
15385863Snate@binkert.org    # to the configured variables.  It returns a list of environments,
15391869SN/A    # one for each variant build (debug, opt, etc.)
154010196SCurtis.Dunham@arm.com    SConscript('src/SConscript', variant_dir = variant_path, exports = 'env')
15411869SN/A
154210196SCurtis.Dunham@arm.comdef pairwise(iterable):
154310196SCurtis.Dunham@arm.com    "s -> (s0,s1), (s1,s2), (s2, s3), ..."
154410196SCurtis.Dunham@arm.com    a, b = itertools.tee(iterable)
154510196SCurtis.Dunham@arm.com    b.next()
154610196SCurtis.Dunham@arm.com    return itertools.izip(a, b)
154710196SCurtis.Dunham@arm.com
154810196SCurtis.Dunham@arm.com# Create false dependencies so SCons will parse ISAs, establish
154910196SCurtis.Dunham@arm.com# dependencies, and setup the build Environments serially. Either
155010196SCurtis.Dunham@arm.com# SCons (likely) and/or our SConscripts (possibly) cannot cope with -j
155110196SCurtis.Dunham@arm.com# greater than 1. It appears to be standard race condition stuff; it
155210196SCurtis.Dunham@arm.com# doesn't always fail, but usually, and the behaviors are different.
155310196SCurtis.Dunham@arm.com# Every time I tried to remove this, builds would fail in some
155410196SCurtis.Dunham@arm.com# creative new way. So, don't do that. You'll want to, though, because
155510196SCurtis.Dunham@arm.com# tests/SConscript takes a long time to make its Environments.
155610196SCurtis.Dunham@arm.comfor t1, t2 in pairwise(sorted(all_isa_deps.iterkeys())):
155710196SCurtis.Dunham@arm.com    main.Depends('#%s-deps'     % t2, '#%s-deps'     % t1)
155810196SCurtis.Dunham@arm.com    main.Depends('#%s-environs' % t2, '#%s-environs' % t1)
1559955SN/A
15608120Sgblack@eecs.umich.edu# base help text
15618120Sgblack@eecs.umich.eduHelp('''
15628120Sgblack@eecs.umich.eduUsage: scons [scons options] [build variables] [target(s)]
15638120Sgblack@eecs.umich.edu
15648120Sgblack@eecs.umich.eduExtra scons options:
15658120Sgblack@eecs.umich.edu%(options)s
15668120Sgblack@eecs.umich.edu
15678120Sgblack@eecs.umich.eduGlobal build variables:
15688120Sgblack@eecs.umich.edu%(global_vars)s
15698120Sgblack@eecs.umich.edu
15708120Sgblack@eecs.umich.edu%(local_vars)s
15718120Sgblack@eecs.umich.edu''' % help_texts)
1572