SConstruct revision 10584:babb40bd2fc6
1955SN/A# -*- mode:python -*-
2955SN/A
39812Sandreas.hansson@arm.com# Copyright (c) 2013 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
112955SN/Aimport itertools
1135396Ssaidi@eecs.umich.eduimport os
1145863Snate@binkert.orgimport re
1155863Snate@binkert.orgimport subprocess
1164202Sbinkertn@umich.eduimport sys
1175863Snate@binkert.org
1185863Snate@binkert.orgfrom os import mkdir, environ
1195863Snate@binkert.orgfrom os.path import abspath, basename, dirname, expanduser, normpath
1205863Snate@binkert.orgfrom os.path import exists,  isdir, isfile
121955SN/Afrom os.path import join as joinpath, split as splitpath
1226654Snate@binkert.org
1235273Sstever@gmail.com# SCons includes
1245871Snate@binkert.orgimport SCons
1255273Sstever@gmail.comimport SCons.Node
1266655Snate@binkert.org
1278878Ssteve.reinhardt@amd.comextra_python_paths = [
1286655Snate@binkert.org    Dir('src/python').srcnode().abspath, # gem5 includes
1296655Snate@binkert.org    Dir('ext/ply').srcnode().abspath, # ply is used by several files
1309219Spower.jg@gmail.com    ]
1316655Snate@binkert.org
1325871Snate@binkert.orgsys.path[1:1] = extra_python_paths
1336654Snate@binkert.org
1348947Sandreas.hansson@arm.comfrom m5.util import compareVersions, readCommand
1355396Ssaidi@eecs.umich.edufrom m5.util.terminal import get_termcap
1368120Sgblack@eecs.umich.edu
1378120Sgblack@eecs.umich.eduhelp_texts = {
1388120Sgblack@eecs.umich.edu    "options" : "",
1398120Sgblack@eecs.umich.edu    "global_vars" : "",
1408120Sgblack@eecs.umich.edu    "local_vars" : ""
1418120Sgblack@eecs.umich.edu}
1428120Sgblack@eecs.umich.edu
1438120Sgblack@eecs.umich.eduExport("help_texts")
1448879Ssteve.reinhardt@amd.com
1458879Ssteve.reinhardt@amd.com
1468879Ssteve.reinhardt@amd.com# There's a bug in scons in that (1) by default, the help texts from
1478879Ssteve.reinhardt@amd.com# AddOption() are supposed to be displayed when you type 'scons -h'
1488879Ssteve.reinhardt@amd.com# and (2) you can override the help displayed by 'scons -h' using the
1498879Ssteve.reinhardt@amd.com# Help() function, but these two features are incompatible: once
1508879Ssteve.reinhardt@amd.com# you've overridden the help text using Help(), there's no way to get
1518879Ssteve.reinhardt@amd.com# at the help texts from AddOptions.  See:
1528879Ssteve.reinhardt@amd.com#     http://scons.tigris.org/issues/show_bug.cgi?id=2356
1538879Ssteve.reinhardt@amd.com#     http://scons.tigris.org/issues/show_bug.cgi?id=2611
1548879Ssteve.reinhardt@amd.com# This hack lets us extract the help text from AddOptions and
1558879Ssteve.reinhardt@amd.com# re-inject it via Help().  Ideally someday this bug will be fixed and
1568879Ssteve.reinhardt@amd.com# we can just use AddOption directly.
1578120Sgblack@eecs.umich.edudef AddLocalOption(*args, **kwargs):
1588120Sgblack@eecs.umich.edu    col_width = 30
1598120Sgblack@eecs.umich.edu
1608120Sgblack@eecs.umich.edu    help = "  " + ", ".join(args)
1618120Sgblack@eecs.umich.edu    if "help" in kwargs:
1628120Sgblack@eecs.umich.edu        length = len(help)
1638120Sgblack@eecs.umich.edu        if length >= col_width:
1648120Sgblack@eecs.umich.edu            help += "\n" + " " * col_width
1658120Sgblack@eecs.umich.edu        else:
1668120Sgblack@eecs.umich.edu            help += " " * (col_width - length)
1678120Sgblack@eecs.umich.edu        help += kwargs["help"]
1688120Sgblack@eecs.umich.edu    help_texts["options"] += help + "\n"
1698120Sgblack@eecs.umich.edu
1708120Sgblack@eecs.umich.edu    AddOption(*args, **kwargs)
1718879Ssteve.reinhardt@amd.com
1728879Ssteve.reinhardt@amd.comAddLocalOption('--colors', dest='use_colors', action='store_true',
1738879Ssteve.reinhardt@amd.com               help="Add color to abbreviated scons output")
1748879Ssteve.reinhardt@amd.comAddLocalOption('--no-colors', dest='use_colors', action='store_false',
1758879Ssteve.reinhardt@amd.com               help="Don't add color to abbreviated scons output")
1768879Ssteve.reinhardt@amd.comAddLocalOption('--with-cxx-config', dest='with_cxx_config',
1778879Ssteve.reinhardt@amd.com               action='store_true',
1788879Ssteve.reinhardt@amd.com               help="Build with support for C++-based configuration")
1799227Sandreas.hansson@arm.comAddLocalOption('--default', dest='default', type='string', action='store',
1809227Sandreas.hansson@arm.com               help='Override which build_opts file to use for defaults')
1818879Ssteve.reinhardt@amd.comAddLocalOption('--ignore-style', dest='ignore_style', action='store_true',
1828879Ssteve.reinhardt@amd.com               help='Disable style checking hooks')
1838879Ssteve.reinhardt@amd.comAddLocalOption('--no-lto', dest='no_lto', action='store_true',
1848879Ssteve.reinhardt@amd.com               help='Disable Link-Time Optimization for fast')
1858120Sgblack@eecs.umich.eduAddLocalOption('--update-ref', dest='update_ref', action='store_true',
1868947Sandreas.hansson@arm.com               help='Update test reference outputs')
1877816Ssteve.reinhardt@amd.comAddLocalOption('--verbose', dest='verbose', action='store_true',
1885871Snate@binkert.org               help='Print full tool command lines')
1895871Snate@binkert.orgAddLocalOption('--without-python', dest='without_python',
1906121Snate@binkert.org               action='store_true',
1915871Snate@binkert.org               help='Build without Python configuration support')
1925871Snate@binkert.orgAddLocalOption('--without-tcmalloc', dest='without_tcmalloc',
1939119Sandreas.hansson@arm.com               action='store_true',
1949396Sandreas.hansson@arm.com               help='Disable linking against tcmalloc')
1959396Sandreas.hansson@arm.comAddLocalOption('--with-ubsan', dest='with_ubsan', action='store_true',
196955SN/A               help='Build with Undefined Behavior Sanitizer if available')
1979416SAndreas.Sandberg@ARM.com
1989416SAndreas.Sandberg@ARM.comtermcap = get_termcap(GetOption('use_colors'))
1999416SAndreas.Sandberg@ARM.com
2009416SAndreas.Sandberg@ARM.com########################################################################
2019416SAndreas.Sandberg@ARM.com#
2029416SAndreas.Sandberg@ARM.com# Set up the main build environment.
2039416SAndreas.Sandberg@ARM.com#
2045871Snate@binkert.org########################################################################
2055871Snate@binkert.org
2069416SAndreas.Sandberg@ARM.com# export TERM so that clang reports errors in color
2079416SAndreas.Sandberg@ARM.comuse_vars = set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH',
2085871Snate@binkert.org                 'LIBRARY_PATH', 'PATH', 'PKG_CONFIG_PATH', 'PROTOC',
209955SN/A                 'PYTHONPATH', 'RANLIB', 'SWIG', 'TERM' ])
2106121Snate@binkert.org
2118881Smarc.orr@gmail.comuse_prefixes = [
2126121Snate@binkert.org    "M5",           # M5 configuration (e.g., path to kernels)
2136121Snate@binkert.org    "DISTCC_",      # distcc (distributed compiler wrapper) configuration
2141533SN/A    "CCACHE_",      # ccache (caching compiler wrapper) configuration
2159239Sandreas.hansson@arm.com    "CCC_",         # clang static analyzer configuration
2169239Sandreas.hansson@arm.com    ]
2179239Sandreas.hansson@arm.com
2189239Sandreas.hansson@arm.comuse_env = {}
2199239Sandreas.hansson@arm.comfor key,val in sorted(os.environ.iteritems()):
2209239Sandreas.hansson@arm.com    if key in use_vars or \
2219239Sandreas.hansson@arm.com            any([key.startswith(prefix) for prefix in use_prefixes]):
2229239Sandreas.hansson@arm.com        use_env[key] = val
2239239Sandreas.hansson@arm.com
2249239Sandreas.hansson@arm.commain = Environment(ENV=use_env)
2259239Sandreas.hansson@arm.commain.Decider('MD5-timestamp')
2269239Sandreas.hansson@arm.commain.root = Dir(".")         # The current directory (where this file lives).
2276655Snate@binkert.orgmain.srcdir = Dir("src")     # The source directory
2286655Snate@binkert.org
2296655Snate@binkert.orgmain_dict_keys = main.Dictionary().keys()
2306655Snate@binkert.org
2315871Snate@binkert.org# Check that we have a C/C++ compiler
2325871Snate@binkert.orgif not ('CC' in main_dict_keys and 'CXX' in main_dict_keys):
2335863Snate@binkert.org    print "No C++ compiler installed (package g++ on Ubuntu and RedHat)"
2345871Snate@binkert.org    Exit(1)
2358878Ssteve.reinhardt@amd.com
2365871Snate@binkert.org# Check that swig is present
2375871Snate@binkert.orgif not 'SWIG' in main_dict_keys:
2385871Snate@binkert.org    print "swig is not installed (package swig on Ubuntu and RedHat)"
2395863Snate@binkert.org    Exit(1)
2406121Snate@binkert.org
2415863Snate@binkert.org# add useful python code PYTHONPATH so it can be used by subprocesses
2425871Snate@binkert.org# as well
2438336Ssteve.reinhardt@amd.commain.AppendENVPath('PYTHONPATH', extra_python_paths)
2448336Ssteve.reinhardt@amd.com
2458336Ssteve.reinhardt@amd.com########################################################################
2468336Ssteve.reinhardt@amd.com#
2474678Snate@binkert.org# Mercurial Stuff.
2488336Ssteve.reinhardt@amd.com#
2498336Ssteve.reinhardt@amd.com# If the gem5 directory is a mercurial repository, we should do some
2508336Ssteve.reinhardt@amd.com# extra things.
2514678Snate@binkert.org#
2524678Snate@binkert.org########################################################################
2534678Snate@binkert.org
2544678Snate@binkert.orghgdir = main.root.Dir(".hg")
2557827Snate@binkert.org
2567827Snate@binkert.orgmercurial_style_message = """
2578336Ssteve.reinhardt@amd.comYou're missing the gem5 style hook, which automatically checks your code
2584678Snate@binkert.orgagainst the gem5 style rules on hg commit and qrefresh commands.  This
2598336Ssteve.reinhardt@amd.comscript will now install the hook in your .hg/hgrc file.
2608336Ssteve.reinhardt@amd.comPress enter to continue, or ctrl-c to abort: """
2618336Ssteve.reinhardt@amd.com
2628336Ssteve.reinhardt@amd.commercurial_style_hook = """
2638336Ssteve.reinhardt@amd.com# The following lines were automatically added by gem5/SConstruct
2648336Ssteve.reinhardt@amd.com# to provide the gem5 style-checking hooks
2655871Snate@binkert.org[extensions]
2665871Snate@binkert.orgstyle = %s/util/style.py
2678336Ssteve.reinhardt@amd.com
2688336Ssteve.reinhardt@amd.com[hooks]
2698336Ssteve.reinhardt@amd.compretxncommit.style = python:style.check_style
2708336Ssteve.reinhardt@amd.compre-qrefresh.style = python:style.check_style
2718336Ssteve.reinhardt@amd.com# End of SConstruct additions
2725871Snate@binkert.org
2738336Ssteve.reinhardt@amd.com""" % (main.root.abspath)
2748336Ssteve.reinhardt@amd.com
2758336Ssteve.reinhardt@amd.commercurial_lib_not_found = """
2768336Ssteve.reinhardt@amd.comMercurial libraries cannot be found, ignoring style hook.  If
2778336Ssteve.reinhardt@amd.comyou are a gem5 developer, please fix this and run the style
2784678Snate@binkert.orghook. It is important.
2795871Snate@binkert.org"""
2804678Snate@binkert.org
2818336Ssteve.reinhardt@amd.com# Check for style hook and prompt for installation if it's not there.
2828336Ssteve.reinhardt@amd.com# Skip this if --ignore-style was specified, there's no .hg dir to
2838336Ssteve.reinhardt@amd.com# install a hook in, or there's no interactive terminal to prompt.
2848336Ssteve.reinhardt@amd.comif not GetOption('ignore_style') and hgdir.exists() and sys.stdin.isatty():
2858336Ssteve.reinhardt@amd.com    style_hook = True
2868336Ssteve.reinhardt@amd.com    try:
2878336Ssteve.reinhardt@amd.com        from mercurial import ui
2888336Ssteve.reinhardt@amd.com        ui = ui.ui()
2898336Ssteve.reinhardt@amd.com        ui.readconfig(hgdir.File('hgrc').abspath)
2908336Ssteve.reinhardt@amd.com        style_hook = ui.config('hooks', 'pretxncommit.style', None) and \
2918336Ssteve.reinhardt@amd.com                     ui.config('hooks', 'pre-qrefresh.style', None)
2928336Ssteve.reinhardt@amd.com    except ImportError:
2938336Ssteve.reinhardt@amd.com        print mercurial_lib_not_found
2948336Ssteve.reinhardt@amd.com
2958336Ssteve.reinhardt@amd.com    if not style_hook:
2968336Ssteve.reinhardt@amd.com        print mercurial_style_message,
2978336Ssteve.reinhardt@amd.com        # continue unless user does ctrl-c/ctrl-d etc.
2985871Snate@binkert.org        try:
2996121Snate@binkert.org            raw_input()
300955SN/A        except:
301955SN/A            print "Input exception, exiting scons.\n"
3022632Sstever@eecs.umich.edu            sys.exit(1)
3032632Sstever@eecs.umich.edu        hgrc_path = '%s/.hg/hgrc' % main.root.abspath
304955SN/A        print "Adding style hook to", hgrc_path, "\n"
305955SN/A        try:
306955SN/A            hgrc = open(hgrc_path, 'a')
307955SN/A            hgrc.write(mercurial_style_hook)
3088878Ssteve.reinhardt@amd.com            hgrc.close()
309955SN/A        except:
3102632Sstever@eecs.umich.edu            print "Error updating", hgrc_path
3112632Sstever@eecs.umich.edu            sys.exit(1)
3122632Sstever@eecs.umich.edu
3132632Sstever@eecs.umich.edu
3142632Sstever@eecs.umich.edu###################################################
3152632Sstever@eecs.umich.edu#
3162632Sstever@eecs.umich.edu# Figure out which configurations to set up based on the path(s) of
3178268Ssteve.reinhardt@amd.com# the target(s).
3188268Ssteve.reinhardt@amd.com#
3198268Ssteve.reinhardt@amd.com###################################################
3208268Ssteve.reinhardt@amd.com
3218268Ssteve.reinhardt@amd.com# Find default configuration & binary.
3228268Ssteve.reinhardt@amd.comDefault(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug'))
3238268Ssteve.reinhardt@amd.com
3242632Sstever@eecs.umich.edu# helper function: find last occurrence of element in list
3252632Sstever@eecs.umich.edudef rfind(l, elt, offs = -1):
3262632Sstever@eecs.umich.edu    for i in range(len(l)+offs, 0, -1):
3272632Sstever@eecs.umich.edu        if l[i] == elt:
3288268Ssteve.reinhardt@amd.com            return i
3292632Sstever@eecs.umich.edu    raise ValueError, "element not found"
3308268Ssteve.reinhardt@amd.com
3318268Ssteve.reinhardt@amd.com# Take a list of paths (or SCons Nodes) and return a list with all
3328268Ssteve.reinhardt@amd.com# paths made absolute and ~-expanded.  Paths will be interpreted
3338268Ssteve.reinhardt@amd.com# relative to the launch directory unless a different root is provided
3343718Sstever@eecs.umich.edudef makePathListAbsolute(path_list, root=GetLaunchDir()):
3352634Sstever@eecs.umich.edu    return [abspath(joinpath(root, expanduser(str(p))))
3362634Sstever@eecs.umich.edu            for p in path_list]
3375863Snate@binkert.org
3382638Sstever@eecs.umich.edu# Each target must have 'build' in the interior of the path; the
3398268Ssteve.reinhardt@amd.com# directory below this will determine the build parameters.  For
3402632Sstever@eecs.umich.edu# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
3412632Sstever@eecs.umich.edu# recognize that ALPHA_SE specifies the configuration because it
3422632Sstever@eecs.umich.edu# follow 'build' in the build path.
3432632Sstever@eecs.umich.edu
3442632Sstever@eecs.umich.edu# The funky assignment to "[:]" is needed to replace the list contents
3451858SN/A# in place rather than reassign the symbol to a new list, which
3463716Sstever@eecs.umich.edu# doesn't work (obviously!).
3472638Sstever@eecs.umich.eduBUILD_TARGETS[:] = makePathListAbsolute(BUILD_TARGETS)
3482638Sstever@eecs.umich.edu
3492638Sstever@eecs.umich.edu# Generate a list of the unique build roots and configs that the
3502638Sstever@eecs.umich.edu# collected targets reference.
3512638Sstever@eecs.umich.eduvariant_paths = []
3522638Sstever@eecs.umich.edubuild_root = None
3532638Sstever@eecs.umich.edufor t in BUILD_TARGETS:
3545863Snate@binkert.org    path_dirs = t.split('/')
3555863Snate@binkert.org    try:
3565863Snate@binkert.org        build_top = rfind(path_dirs, 'build', -2)
357955SN/A    except:
3585341Sstever@gmail.com        print "Error: no non-leaf 'build' dir found on target path", t
3595341Sstever@gmail.com        Exit(1)
3605863Snate@binkert.org    this_build_root = joinpath('/',*path_dirs[:build_top+1])
3617756SAli.Saidi@ARM.com    if not build_root:
3625341Sstever@gmail.com        build_root = this_build_root
3636121Snate@binkert.org    else:
3644494Ssaidi@eecs.umich.edu        if this_build_root != build_root:
3656121Snate@binkert.org            print "Error: build targets not under same build root\n"\
3661105SN/A                  "  %s\n  %s" % (build_root, this_build_root)
3672667Sstever@eecs.umich.edu            Exit(1)
3682667Sstever@eecs.umich.edu    variant_path = joinpath('/',*path_dirs[:build_top+2])
3692667Sstever@eecs.umich.edu    if variant_path not in variant_paths:
3702667Sstever@eecs.umich.edu        variant_paths.append(variant_path)
3716121Snate@binkert.org
3722667Sstever@eecs.umich.edu# Make sure build_root exists (might not if this is the first build there)
3735341Sstever@gmail.comif not isdir(build_root):
3745863Snate@binkert.org    mkdir(build_root)
3755341Sstever@gmail.commain['BUILDROOT'] = build_root
3765341Sstever@gmail.com
3775341Sstever@gmail.comExport('main')
3788120Sgblack@eecs.umich.edu
3795341Sstever@gmail.commain.SConsignFile(joinpath(build_root, "sconsign"))
3808120Sgblack@eecs.umich.edu
3815341Sstever@gmail.com# Default duplicate option is to use hard links, but this messes up
3828120Sgblack@eecs.umich.edu# when you use emacs to edit a file in the target dir, as emacs moves
3836121Snate@binkert.org# file to file~ then copies to file, breaking the link.  Symbolic
3846121Snate@binkert.org# (soft) links work better.
3858980Ssteve.reinhardt@amd.commain.SetOption('duplicate', 'soft-copy')
3869396Sandreas.hansson@arm.com
3875397Ssaidi@eecs.umich.edu#
3885397Ssaidi@eecs.umich.edu# Set up global sticky variables... these are common to an entire build
3897727SAli.Saidi@ARM.com# tree (not specific to a particular build like ALPHA_SE)
3908268Ssteve.reinhardt@amd.com#
3916168Snate@binkert.org
3925341Sstever@gmail.comglobal_vars_file = joinpath(build_root, 'variables.global')
3938120Sgblack@eecs.umich.edu
3948120Sgblack@eecs.umich.eduglobal_vars = Variables(global_vars_file, args=ARGUMENTS)
3958120Sgblack@eecs.umich.edu
3966814Sgblack@eecs.umich.eduglobal_vars.AddVariables(
3975863Snate@binkert.org    ('CC', 'C compiler', environ.get('CC', main['CC'])),
3988120Sgblack@eecs.umich.edu    ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])),
3995341Sstever@gmail.com    ('SWIG', 'SWIG tool', environ.get('SWIG', main['SWIG'])),
4005863Snate@binkert.org    ('PROTOC', 'protoc tool', environ.get('PROTOC', 'protoc')),
4018268Ssteve.reinhardt@amd.com    ('BATCH', 'Use batch pool for build and tests', False),
4026121Snate@binkert.org    ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
4036121Snate@binkert.org    ('M5_BUILD_CACHE', 'Cache built objects in this directory', False),
4048268Ssteve.reinhardt@amd.com    ('EXTRAS', 'Add extra directories to the compilation', '')
4055742Snate@binkert.org    )
4065742Snate@binkert.org
4075341Sstever@gmail.com# Update main environment with values from ARGUMENTS & global_vars_file
4085742Snate@binkert.orgglobal_vars.Update(main)
4095742Snate@binkert.orghelp_texts["global_vars"] += global_vars.GenerateHelpText(main)
4105341Sstever@gmail.com
4116017Snate@binkert.org# Save sticky variable settings back to current variables file
4126121Snate@binkert.orgglobal_vars.Save(global_vars_file, main)
4136017Snate@binkert.org
4147816Ssteve.reinhardt@amd.com# Parse EXTRAS variable to build list of all directories where we're
4157756SAli.Saidi@ARM.com# look for sources etc.  This list is exported as extras_dir_list.
4167756SAli.Saidi@ARM.combase_dir = main.srcdir.abspath
4177756SAli.Saidi@ARM.comif main['EXTRAS']:
4187756SAli.Saidi@ARM.com    extras_dir_list = makePathListAbsolute(main['EXTRAS'].split(':'))
4197756SAli.Saidi@ARM.comelse:
4207756SAli.Saidi@ARM.com    extras_dir_list = []
4217756SAli.Saidi@ARM.com
4227756SAli.Saidi@ARM.comExport('base_dir')
4237816Ssteve.reinhardt@amd.comExport('extras_dir_list')
4247816Ssteve.reinhardt@amd.com
4257816Ssteve.reinhardt@amd.com# the ext directory should be on the #includes path
4267816Ssteve.reinhardt@amd.commain.Append(CPPPATH=[Dir('ext')])
4277816Ssteve.reinhardt@amd.com
4287816Ssteve.reinhardt@amd.comdef strip_build_path(path, env):
4297816Ssteve.reinhardt@amd.com    path = str(path)
4307816Ssteve.reinhardt@amd.com    variant_base = env['BUILDROOT'] + os.path.sep
4317816Ssteve.reinhardt@amd.com    if path.startswith(variant_base):
4327816Ssteve.reinhardt@amd.com        path = path[len(variant_base):]
4337756SAli.Saidi@ARM.com    elif path.startswith('build/'):
4347816Ssteve.reinhardt@amd.com        path = path[6:]
4357816Ssteve.reinhardt@amd.com    return path
4367816Ssteve.reinhardt@amd.com
4377816Ssteve.reinhardt@amd.com# Generate a string of the form:
4387816Ssteve.reinhardt@amd.com#   common/path/prefix/src1, src2 -> tgt1, tgt2
4397816Ssteve.reinhardt@amd.com# to print while building.
4407816Ssteve.reinhardt@amd.comclass Transform(object):
4417816Ssteve.reinhardt@amd.com    # all specific color settings should be here and nowhere else
4427816Ssteve.reinhardt@amd.com    tool_color = termcap.Normal
4437816Ssteve.reinhardt@amd.com    pfx_color = termcap.Yellow
4447816Ssteve.reinhardt@amd.com    srcs_color = termcap.Yellow + termcap.Bold
4457816Ssteve.reinhardt@amd.com    arrow_color = termcap.Blue + termcap.Bold
4467816Ssteve.reinhardt@amd.com    tgts_color = termcap.Yellow + termcap.Bold
4477816Ssteve.reinhardt@amd.com
4487816Ssteve.reinhardt@amd.com    def __init__(self, tool, max_sources=99):
4497816Ssteve.reinhardt@amd.com        self.format = self.tool_color + (" [%8s] " % tool) \
4507816Ssteve.reinhardt@amd.com                      + self.pfx_color + "%s" \
4517816Ssteve.reinhardt@amd.com                      + self.srcs_color + "%s" \
4527816Ssteve.reinhardt@amd.com                      + self.arrow_color + " -> " \
4537816Ssteve.reinhardt@amd.com                      + self.tgts_color + "%s" \
4547816Ssteve.reinhardt@amd.com                      + termcap.Normal
4557816Ssteve.reinhardt@amd.com        self.max_sources = max_sources
4567816Ssteve.reinhardt@amd.com
4577816Ssteve.reinhardt@amd.com    def __call__(self, target, source, env, for_signature=None):
4587816Ssteve.reinhardt@amd.com        # truncate source list according to max_sources param
4597816Ssteve.reinhardt@amd.com        source = source[0:self.max_sources]
4607816Ssteve.reinhardt@amd.com        def strip(f):
4617816Ssteve.reinhardt@amd.com            return strip_build_path(str(f), env)
4627816Ssteve.reinhardt@amd.com        if len(source) > 0:
4637816Ssteve.reinhardt@amd.com            srcs = map(strip, source)
4647816Ssteve.reinhardt@amd.com        else:
4657816Ssteve.reinhardt@amd.com            srcs = ['']
4667816Ssteve.reinhardt@amd.com        tgts = map(strip, target)
4677816Ssteve.reinhardt@amd.com        # surprisingly, os.path.commonprefix is a dumb char-by-char string
4687816Ssteve.reinhardt@amd.com        # operation that has nothing to do with paths.
4697816Ssteve.reinhardt@amd.com        com_pfx = os.path.commonprefix(srcs + tgts)
4707816Ssteve.reinhardt@amd.com        com_pfx_len = len(com_pfx)
4717816Ssteve.reinhardt@amd.com        if com_pfx:
4727816Ssteve.reinhardt@amd.com            # do some cleanup and sanity checking on common prefix
4737816Ssteve.reinhardt@amd.com            if com_pfx[-1] == ".":
4747816Ssteve.reinhardt@amd.com                # prefix matches all but file extension: ok
4757816Ssteve.reinhardt@amd.com                # back up one to change 'foo.cc -> o' to 'foo.cc -> .o'
4767816Ssteve.reinhardt@amd.com                com_pfx = com_pfx[0:-1]
4777816Ssteve.reinhardt@amd.com            elif com_pfx[-1] == "/":
4787816Ssteve.reinhardt@amd.com                # common prefix is directory path: OK
4797816Ssteve.reinhardt@amd.com                pass
4807816Ssteve.reinhardt@amd.com            else:
4817816Ssteve.reinhardt@amd.com                src0_len = len(srcs[0])
4827816Ssteve.reinhardt@amd.com                tgt0_len = len(tgts[0])
4837816Ssteve.reinhardt@amd.com                if src0_len == com_pfx_len:
4847816Ssteve.reinhardt@amd.com                    # source is a substring of target, OK
4857816Ssteve.reinhardt@amd.com                    pass
4867816Ssteve.reinhardt@amd.com                elif tgt0_len == com_pfx_len:
4877816Ssteve.reinhardt@amd.com                    # target is a substring of source, need to back up to
4887816Ssteve.reinhardt@amd.com                    # avoid empty string on RHS of arrow
4897816Ssteve.reinhardt@amd.com                    sep_idx = com_pfx.rfind(".")
4907816Ssteve.reinhardt@amd.com                    if sep_idx != -1:
4917816Ssteve.reinhardt@amd.com                        com_pfx = com_pfx[0:sep_idx]
4927816Ssteve.reinhardt@amd.com                    else:
4937816Ssteve.reinhardt@amd.com                        com_pfx = ''
4947816Ssteve.reinhardt@amd.com                elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".":
4958947Sandreas.hansson@arm.com                    # still splitting at file extension: ok
4968947Sandreas.hansson@arm.com                    pass
4977756SAli.Saidi@ARM.com                else:
4988120Sgblack@eecs.umich.edu                    # probably a fluke; ignore it
4997756SAli.Saidi@ARM.com                    com_pfx = ''
5007756SAli.Saidi@ARM.com        # recalculate length in case com_pfx was modified
5017756SAli.Saidi@ARM.com        com_pfx_len = len(com_pfx)
5027756SAli.Saidi@ARM.com        def fmt(files):
5037816Ssteve.reinhardt@amd.com            f = map(lambda s: s[com_pfx_len:], files)
5047816Ssteve.reinhardt@amd.com            return ', '.join(f)
5057816Ssteve.reinhardt@amd.com        return self.format % (com_pfx, fmt(srcs), fmt(tgts))
5067816Ssteve.reinhardt@amd.com
5077816Ssteve.reinhardt@amd.comExport('Transform')
5087816Ssteve.reinhardt@amd.com
5097816Ssteve.reinhardt@amd.com# enable the regression script to use the termcap
5107816Ssteve.reinhardt@amd.commain['TERMCAP'] = termcap
5117816Ssteve.reinhardt@amd.com
5127816Ssteve.reinhardt@amd.comif GetOption('verbose'):
5137756SAli.Saidi@ARM.com    def MakeAction(action, string, *args, **kwargs):
5147756SAli.Saidi@ARM.com        return Action(action, *args, **kwargs)
5159227Sandreas.hansson@arm.comelse:
5169227Sandreas.hansson@arm.com    MakeAction = Action
5179227Sandreas.hansson@arm.com    main['CCCOMSTR']        = Transform("CC")
5189227Sandreas.hansson@arm.com    main['CXXCOMSTR']       = Transform("CXX")
5199590Sandreas@sandberg.pp.se    main['ASCOMSTR']        = Transform("AS")
5209590Sandreas@sandberg.pp.se    main['SWIGCOMSTR']      = Transform("SWIG")
5219590Sandreas@sandberg.pp.se    main['ARCOMSTR']        = Transform("AR", 0)
5229590Sandreas@sandberg.pp.se    main['LINKCOMSTR']      = Transform("LINK", 0)
5239590Sandreas@sandberg.pp.se    main['RANLIBCOMSTR']    = Transform("RANLIB", 0)
5249590Sandreas@sandberg.pp.se    main['M4COMSTR']        = Transform("M4")
5256654Snate@binkert.org    main['SHCCCOMSTR']      = Transform("SHCC")
5266654Snate@binkert.org    main['SHCXXCOMSTR']     = Transform("SHCXX")
5275871Snate@binkert.orgExport('MakeAction')
5286121Snate@binkert.org
5298946Sandreas.hansson@arm.com# Initialize the Link-Time Optimization (LTO) flags
5309419Sandreas.hansson@arm.commain['LTO_CCFLAGS'] = []
5313940Ssaidi@eecs.umich.edumain['LTO_LDFLAGS'] = []
5323918Ssaidi@eecs.umich.edu
5333918Ssaidi@eecs.umich.edu# According to the readme, tcmalloc works best if the compiler doesn't
5341858SN/A# assume that we're using the builtin malloc and friends. These flags
5359556Sandreas.hansson@arm.com# are compiler-specific, so we need to set them after we detect which
5369556Sandreas.hansson@arm.com# compiler we're using.
5379556Sandreas.hansson@arm.commain['TCMALLOC_CCFLAGS'] = []
5389556Sandreas.hansson@arm.com
5399556Sandreas.hansson@arm.comCXX_version = readCommand([main['CXX'],'--version'], exception=False)
5409556Sandreas.hansson@arm.comCXX_V = readCommand([main['CXX'],'-V'], exception=False)
5419556Sandreas.hansson@arm.com
5429556Sandreas.hansson@arm.commain['GCC'] = CXX_version and CXX_version.find('g++') >= 0
5439556Sandreas.hansson@arm.commain['CLANG'] = CXX_version and CXX_version.find('clang') >= 0
5449556Sandreas.hansson@arm.comif main['GCC'] + main['CLANG'] > 1:
5459556Sandreas.hansson@arm.com    print 'Error: How can we have two at the same time?'
5469556Sandreas.hansson@arm.com    Exit(1)
5479556Sandreas.hansson@arm.com
5489556Sandreas.hansson@arm.com# Set up default C++ compiler flags
5499556Sandreas.hansson@arm.comif main['GCC'] or main['CLANG']:
5509556Sandreas.hansson@arm.com    # As gcc and clang share many flags, do the common parts here
5519556Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-pipe'])
5529556Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-fno-strict-aliasing'])
5539556Sandreas.hansson@arm.com    # Enable -Wall and then disable the few warnings that we
5549556Sandreas.hansson@arm.com    # consistently violate
5559556Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef'])
5569556Sandreas.hansson@arm.com    # We always compile using C++11, but only gcc >= 4.7 and clang 3.1
5579556Sandreas.hansson@arm.com    # actually use that name, so we stick with c++0x
5589556Sandreas.hansson@arm.com    main.Append(CXXFLAGS=['-std=c++0x'])
5599556Sandreas.hansson@arm.com    # Add selected sanity checks from -Wextra
5609556Sandreas.hansson@arm.com    main.Append(CXXFLAGS=['-Wmissing-field-initializers',
5619556Sandreas.hansson@arm.com                          '-Woverloaded-virtual'])
5629556Sandreas.hansson@arm.comelse:
5639556Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal,
5649556Sandreas.hansson@arm.com    print "Don't know what compiler options to use for your compiler."
5659556Sandreas.hansson@arm.com    print termcap.Yellow + '       compiler:' + termcap.Normal, main['CXX']
5669556Sandreas.hansson@arm.com    print termcap.Yellow + '       version:' + termcap.Normal,
5676121Snate@binkert.org    if not CXX_version:
5689420Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\
5699420Sandreas.hansson@arm.com               termcap.Normal
5709420Sandreas.hansson@arm.com    else:
5719420Sandreas.hansson@arm.com        print CXX_version.replace('\n', '<nl>')
5729420Sandreas.hansson@arm.com    print "       If you're trying to use a compiler other than GCC"
5739420Sandreas.hansson@arm.com    print "       or clang, there appears to be something wrong with your"
5749420Sandreas.hansson@arm.com    print "       environment."
5759420Sandreas.hansson@arm.com    print "       "
5769420Sandreas.hansson@arm.com    print "       If you are trying to use a compiler other than those listed"
5779420Sandreas.hansson@arm.com    print "       above you will need to ease fix SConstruct and "
5789420Sandreas.hansson@arm.com    print "       src/SConscript to support that compiler."
5797618SAli.Saidi@arm.com    Exit(1)
5807618SAli.Saidi@arm.com
5817618SAli.Saidi@arm.comif main['GCC']:
5827739Sgblack@eecs.umich.edu    # Check for a supported version of gcc. >= 4.6 is chosen for its
5839227Sandreas.hansson@arm.com    # level of c++11 support. See
5849227Sandreas.hansson@arm.com    # http://gcc.gnu.org/projects/cxx0x.html for details. 4.6 is also
5859227Sandreas.hansson@arm.com    # the first version with proper LTO support.
5869227Sandreas.hansson@arm.com    gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False)
5879227Sandreas.hansson@arm.com    if compareVersions(gcc_version, "4.6") < 0:
5889227Sandreas.hansson@arm.com        print 'Error: gcc version 4.6 or newer required.'
5899227Sandreas.hansson@arm.com        print '       Installed version:', gcc_version
5909227Sandreas.hansson@arm.com        Exit(1)
5919227Sandreas.hansson@arm.com
5929227Sandreas.hansson@arm.com    main['GCC_VERSION'] = gcc_version
5939227Sandreas.hansson@arm.com
5949227Sandreas.hansson@arm.com    # gcc from version 4.8 and above generates "rep; ret" instructions
5959227Sandreas.hansson@arm.com    # to avoid performance penalties on certain AMD chips. Older
5969227Sandreas.hansson@arm.com    # assemblers detect this as an error, "Error: expecting string
5979227Sandreas.hansson@arm.com    # instruction after `rep'"
5989227Sandreas.hansson@arm.com    if compareVersions(gcc_version, "4.8") > 0:
5999227Sandreas.hansson@arm.com        as_version = readCommand([main['AS'], '-v', '/dev/null'],
6009227Sandreas.hansson@arm.com                                 exception=False).split()
6019590Sandreas@sandberg.pp.se
6029590Sandreas@sandberg.pp.se        if not as_version or compareVersions(as_version[-1], "2.23") < 0:
6039590Sandreas@sandberg.pp.se            print termcap.Yellow + termcap.Bold + \
6048737Skoansin.tan@gmail.com                'Warning: This combination of gcc and binutils have' + \
6059420Sandreas.hansson@arm.com                ' known incompatibilities.\n' + \
6069420Sandreas.hansson@arm.com                '         If you encounter build problems, please update ' + \
6079420Sandreas.hansson@arm.com                'binutils to 2.23.' + \
6088737Skoansin.tan@gmail.com                termcap.Normal
6098737Skoansin.tan@gmail.com
6108737Skoansin.tan@gmail.com    # Make sure we warn if the user has requested to compile with the
6118737Skoansin.tan@gmail.com    # Undefined Benahvior Sanitizer and this version of gcc does not
6128737Skoansin.tan@gmail.com    # support it.
6138737Skoansin.tan@gmail.com    if GetOption('with_ubsan') and \
6148737Skoansin.tan@gmail.com            compareVersions(gcc_version, '4.9') < 0:
6158737Skoansin.tan@gmail.com        print termcap.Yellow + termcap.Bold + \
6168737Skoansin.tan@gmail.com            'Warning: UBSan is only supported using gcc 4.9 and later.' + \
6178737Skoansin.tan@gmail.com            termcap.Normal
6188737Skoansin.tan@gmail.com
6198737Skoansin.tan@gmail.com    # Add the appropriate Link-Time Optimization (LTO) flags
6209556Sandreas.hansson@arm.com    # unless LTO is explicitly turned off. Note that these flags
6219556Sandreas.hansson@arm.com    # are only used by the fast target.
6229556Sandreas.hansson@arm.com    if not GetOption('no_lto'):
6239556Sandreas.hansson@arm.com        # Pass the LTO flag when compiling to produce GIMPLE
6249556Sandreas.hansson@arm.com        # output, we merely create the flags here and only append
6259556Sandreas.hansson@arm.com        # them later
6269556Sandreas.hansson@arm.com        main['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
6279556Sandreas.hansson@arm.com
6289556Sandreas.hansson@arm.com        # Use the same amount of jobs for LTO as we are running
6299556Sandreas.hansson@arm.com        # scons with
6309590Sandreas@sandberg.pp.se        main['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
6319590Sandreas@sandberg.pp.se
6329420Sandreas.hansson@arm.com    main.Append(TCMALLOC_CCFLAGS=['-fno-builtin-malloc', '-fno-builtin-calloc',
6339420Sandreas.hansson@arm.com                                  '-fno-builtin-realloc', '-fno-builtin-free'])
6349420Sandreas.hansson@arm.com
6359420Sandreas.hansson@arm.comelif main['CLANG']:
6369420Sandreas.hansson@arm.com    # Check for a supported version of clang, >= 3.0 is needed to
6379420Sandreas.hansson@arm.com    # support similar features as gcc 4.6. See
6389420Sandreas.hansson@arm.com    # http://clang.llvm.org/cxx_status.html for details
6399420Sandreas.hansson@arm.com    clang_version_re = re.compile(".* version (\d+\.\d+)")
6409420Sandreas.hansson@arm.com    clang_version_match = clang_version_re.search(CXX_version)
6419420Sandreas.hansson@arm.com    if (clang_version_match):
6428946Sandreas.hansson@arm.com        clang_version = clang_version_match.groups()[0]
6433918Ssaidi@eecs.umich.edu        if compareVersions(clang_version, "3.0") < 0:
6449068SAli.Saidi@ARM.com            print 'Error: clang version 3.0 or newer required.'
6459068SAli.Saidi@ARM.com            print '       Installed version:', clang_version
6469068SAli.Saidi@ARM.com            Exit(1)
6479068SAli.Saidi@ARM.com    else:
6489068SAli.Saidi@ARM.com        print 'Error: Unable to determine clang version.'
6499068SAli.Saidi@ARM.com        Exit(1)
6509068SAli.Saidi@ARM.com
6519068SAli.Saidi@ARM.com    # clang has a few additional warnings that we disable,
6529068SAli.Saidi@ARM.com    # tautological comparisons are allowed due to unsigned integers
6539419Sandreas.hansson@arm.com    # being compared to constants that happen to be 0, and extraneous
6549068SAli.Saidi@ARM.com    # parantheses are allowed due to Ruby's printing of the AST,
6559068SAli.Saidi@ARM.com    # finally self assignments are allowed as the generated CPU code
6569068SAli.Saidi@ARM.com    # is relying on this
6579068SAli.Saidi@ARM.com    main.Append(CCFLAGS=['-Wno-tautological-compare',
6589068SAli.Saidi@ARM.com                         '-Wno-parentheses',
6599068SAli.Saidi@ARM.com                         '-Wno-self-assign',
6603918Ssaidi@eecs.umich.edu                         # Some versions of libstdc++ (4.8?) seem to
6613918Ssaidi@eecs.umich.edu                         # use struct hash and class hash
6626157Snate@binkert.org                         # interchangeably.
6636157Snate@binkert.org                         '-Wno-mismatched-tags',
6646157Snate@binkert.org                         ])
6656157Snate@binkert.org
6665397Ssaidi@eecs.umich.edu    main.Append(TCMALLOC_CCFLAGS=['-fno-builtin'])
6675397Ssaidi@eecs.umich.edu
6686121Snate@binkert.org    # On Mac OS X/Darwin we need to also use libc++ (part of XCode) as
6696121Snate@binkert.org    # opposed to libstdc++, as the later is dated.
6706121Snate@binkert.org    if sys.platform == "darwin":
6716121Snate@binkert.org        main.Append(CXXFLAGS=['-stdlib=libc++'])
6726121Snate@binkert.org        main.Append(LIBS=['c++'])
6736121Snate@binkert.org
6745397Ssaidi@eecs.umich.eduelse:
6751851SN/A    print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal,
6761851SN/A    print "Don't know what compiler options to use for your compiler."
6777739Sgblack@eecs.umich.edu    print termcap.Yellow + '       compiler:' + termcap.Normal, main['CXX']
678955SN/A    print termcap.Yellow + '       version:' + termcap.Normal,
6799396Sandreas.hansson@arm.com    if not CXX_version:
6809396Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\
6819396Sandreas.hansson@arm.com               termcap.Normal
6829396Sandreas.hansson@arm.com    else:
6839396Sandreas.hansson@arm.com        print CXX_version.replace('\n', '<nl>')
6849396Sandreas.hansson@arm.com    print "       If you're trying to use a compiler other than GCC"
6859396Sandreas.hansson@arm.com    print "       or clang, there appears to be something wrong with your"
6869396Sandreas.hansson@arm.com    print "       environment."
6879396Sandreas.hansson@arm.com    print "       "
6889396Sandreas.hansson@arm.com    print "       If you are trying to use a compiler other than those listed"
6899396Sandreas.hansson@arm.com    print "       above you will need to ease fix SConstruct and "
6909396Sandreas.hansson@arm.com    print "       src/SConscript to support that compiler."
6919396Sandreas.hansson@arm.com    Exit(1)
6929396Sandreas.hansson@arm.com
6939396Sandreas.hansson@arm.com# Set up common yacc/bison flags (needed for Ruby)
6949396Sandreas.hansson@arm.commain['YACCFLAGS'] = '-d'
6959477Sandreas.hansson@arm.commain['YACCHXXFILESUFFIX'] = '.hh'
6969477Sandreas.hansson@arm.com
6979477Sandreas.hansson@arm.com# Do this after we save setting back, or else we'll tack on an
6989477Sandreas.hansson@arm.com# extra 'qdo' every time we run scons.
6999477Sandreas.hansson@arm.comif main['BATCH']:
7009477Sandreas.hansson@arm.com    main['CC']     = main['BATCH_CMD'] + ' ' + main['CC']
7019477Sandreas.hansson@arm.com    main['CXX']    = main['BATCH_CMD'] + ' ' + main['CXX']
7029477Sandreas.hansson@arm.com    main['AS']     = main['BATCH_CMD'] + ' ' + main['AS']
7039477Sandreas.hansson@arm.com    main['AR']     = main['BATCH_CMD'] + ' ' + main['AR']
7049477Sandreas.hansson@arm.com    main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB']
7059477Sandreas.hansson@arm.com
7069477Sandreas.hansson@arm.comif sys.platform == 'cygwin':
7079477Sandreas.hansson@arm.com    # cygwin has some header file issues...
7089477Sandreas.hansson@arm.com    main.Append(CCFLAGS=["-Wno-uninitialized"])
7099477Sandreas.hansson@arm.com
7109477Sandreas.hansson@arm.com# Check for the protobuf compiler
7119477Sandreas.hansson@arm.comprotoc_version = readCommand([main['PROTOC'], '--version'],
7129477Sandreas.hansson@arm.com                             exception='').split()
7139477Sandreas.hansson@arm.com
7149477Sandreas.hansson@arm.com# First two words should be "libprotoc x.y.z"
7159477Sandreas.hansson@arm.comif len(protoc_version) < 2 or protoc_version[0] != 'libprotoc':
7169477Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + \
7179396Sandreas.hansson@arm.com        'Warning: Protocol buffer compiler (protoc) not found.\n' + \
7183053Sstever@eecs.umich.edu        '         Please install protobuf-compiler for tracing support.' + \
7196121Snate@binkert.org        termcap.Normal
7203053Sstever@eecs.umich.edu    main['PROTOC'] = False
7213053Sstever@eecs.umich.eduelse:
7223053Sstever@eecs.umich.edu    # Based on the availability of the compress stream wrappers,
7233053Sstever@eecs.umich.edu    # require 2.1.0
7243053Sstever@eecs.umich.edu    min_protoc_version = '2.1.0'
7259072Sandreas.hansson@arm.com    if compareVersions(protoc_version[1], min_protoc_version) < 0:
7263053Sstever@eecs.umich.edu        print termcap.Yellow + termcap.Bold + \
7274742Sstever@eecs.umich.edu            'Warning: protoc version', min_protoc_version, \
7284742Sstever@eecs.umich.edu            'or newer required.\n' + \
7293053Sstever@eecs.umich.edu            '         Installed version:', protoc_version[1], \
7303053Sstever@eecs.umich.edu            termcap.Normal
7313053Sstever@eecs.umich.edu        main['PROTOC'] = False
7328960Ssteve.reinhardt@amd.com    else:
7336654Snate@binkert.org        # Attempt to determine the appropriate include path and
7343053Sstever@eecs.umich.edu        # library path using pkg-config, that means we also need to
7353053Sstever@eecs.umich.edu        # check for pkg-config. Note that it is possible to use
7363053Sstever@eecs.umich.edu        # protobuf without the involvement of pkg-config. Later on we
7373053Sstever@eecs.umich.edu        # check go a library config check and at that point the test
7389740SAli.Saidi@ARM.com        # will fail if libprotobuf cannot be found.
7399585Sandreas@sandberg.pp.se        if readCommand(['pkg-config', '--version'], exception=''):
7409740SAli.Saidi@ARM.com            try:
7419585Sandreas@sandberg.pp.se                # Attempt to establish what linking flags to add for protobuf
7429585Sandreas@sandberg.pp.se                # using pkg-config
7439585Sandreas@sandberg.pp.se                main.ParseConfig('pkg-config --cflags --libs-only-L protobuf')
7449585Sandreas@sandberg.pp.se            except:
7459585Sandreas@sandberg.pp.se                print termcap.Yellow + termcap.Bold + \
7469585Sandreas@sandberg.pp.se                    'Warning: pkg-config could not get protobuf flags.' + \
7472667Sstever@eecs.umich.edu                    termcap.Normal
7484554Sbinkertn@umich.edu
7496121Snate@binkert.org# Check for SWIG
7502667Sstever@eecs.umich.eduif not main.has_key('SWIG'):
7514554Sbinkertn@umich.edu    print 'Error: SWIG utility not found.'
7524554Sbinkertn@umich.edu    print '       Please install (see http://www.swig.org) and retry.'
7534554Sbinkertn@umich.edu    Exit(1)
7546121Snate@binkert.org
7554554Sbinkertn@umich.edu# Check for appropriate SWIG version
7564554Sbinkertn@umich.eduswig_version = readCommand([main['SWIG'], '-version'], exception='').split()
7574554Sbinkertn@umich.edu# First 3 words should be "SWIG Version x.y.z"
7584781Snate@binkert.orgif len(swig_version) < 3 or \
7594554Sbinkertn@umich.edu        swig_version[0] != 'SWIG' or swig_version[1] != 'Version':
7604554Sbinkertn@umich.edu    print 'Error determining SWIG version.'
7612667Sstever@eecs.umich.edu    Exit(1)
7624554Sbinkertn@umich.edu
7634554Sbinkertn@umich.edumin_swig_version = '2.0.4'
7644554Sbinkertn@umich.eduif compareVersions(swig_version[2], min_swig_version) < 0:
7654554Sbinkertn@umich.edu    print 'Error: SWIG version', min_swig_version, 'or newer required.'
7662667Sstever@eecs.umich.edu    print '       Installed version:', swig_version[2]
7674554Sbinkertn@umich.edu    Exit(1)
7682667Sstever@eecs.umich.edu
7694554Sbinkertn@umich.edu# Check for known incompatibilities. The standard library shipped with
7706121Snate@binkert.org# gcc >= 4.9 does not play well with swig versions prior to 3.0
7712667Sstever@eecs.umich.eduif main['GCC'] and compareVersions(gcc_version, '4.9') >= 0 and \
7725522Snate@binkert.org        compareVersions(swig_version[2], '3.0') < 0:
7735522Snate@binkert.org    print termcap.Yellow + termcap.Bold + \
7745522Snate@binkert.org        'Warning: This combination of gcc and swig have' + \
7755522Snate@binkert.org        ' known incompatibilities.\n' + \
7765522Snate@binkert.org        '         If you encounter build problems, please update ' + \
7775522Snate@binkert.org        'swig to 3.0 or later.' + \
7785522Snate@binkert.org        termcap.Normal
7795522Snate@binkert.org
7805522Snate@binkert.org# Set up SWIG flags & scanner
7815522Snate@binkert.orgswig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
7825522Snate@binkert.orgmain.Append(SWIGFLAGS=swig_flags)
7835522Snate@binkert.org
7845522Snate@binkert.org# Check for 'timeout' from GNU coreutils.  If present, regressions
7855522Snate@binkert.org# will be run with a time limit.
7865522Snate@binkert.orgTIMEOUT_version = readCommand(['timeout', '--version'], exception=False)
7875522Snate@binkert.orgmain['TIMEOUT'] = TIMEOUT_version and TIMEOUT_version.find('timeout') == 0
7885522Snate@binkert.org
7895522Snate@binkert.org# filter out all existing swig scanners, they mess up the dependency
7905522Snate@binkert.org# stuff for some reason
7915522Snate@binkert.orgscanners = []
7925522Snate@binkert.orgfor scanner in main['SCANNERS']:
7935522Snate@binkert.org    skeys = scanner.skeys
7945522Snate@binkert.org    if skeys == '.i':
7955522Snate@binkert.org        continue
7965522Snate@binkert.org
7975522Snate@binkert.org    if isinstance(skeys, (list, tuple)) and '.i' in skeys:
7982638Sstever@eecs.umich.edu        continue
7992638Sstever@eecs.umich.edu
8006121Snate@binkert.org    scanners.append(scanner)
8013716Sstever@eecs.umich.edu
8025522Snate@binkert.org# add the new swig scanner that we like better
8039420Sandreas.hansson@arm.comfrom SCons.Scanner import ClassicCPP as CPPScanner
8045522Snate@binkert.orgswig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
8055522Snate@binkert.orgscanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re))
8065522Snate@binkert.org
8075522Snate@binkert.org# replace the scanners list that has what we want
8081858SN/Amain['SCANNERS'] = scanners
8095227Ssaidi@eecs.umich.edu
8105227Ssaidi@eecs.umich.edu# Add a custom Check function to the Configure context so that we can
8115227Ssaidi@eecs.umich.edu# figure out if the compiler adds leading underscores to global
8125227Ssaidi@eecs.umich.edu# variables.  This is needed for the autogenerated asm files that we
8136654Snate@binkert.org# use for embedding the python code.
8146654Snate@binkert.orgdef CheckLeading(context):
8157769SAli.Saidi@ARM.com    context.Message("Checking for leading underscore in global variables...")
8167769SAli.Saidi@ARM.com    # 1) Define a global variable called x from asm so the C compiler
8177769SAli.Saidi@ARM.com    #    won't change the symbol at all.
8187769SAli.Saidi@ARM.com    # 2) Declare that variable.
8195227Ssaidi@eecs.umich.edu    # 3) Use the variable
8205227Ssaidi@eecs.umich.edu    #
8215227Ssaidi@eecs.umich.edu    # If the compiler prepends an underscore, this will successfully
8225204Sstever@gmail.com    # link because the external symbol 'x' will be called '_x' which
8235204Sstever@gmail.com    # was defined by the asm statement.  If the compiler does not
8245204Sstever@gmail.com    # prepend an underscore, this will not successfully link because
8255204Sstever@gmail.com    # '_x' will have been defined by assembly, while the C portion of
8265204Sstever@gmail.com    # the code will be trying to use 'x'
8275204Sstever@gmail.com    ret = context.TryLink('''
8285204Sstever@gmail.com        asm(".globl _x; _x: .byte 0");
8295204Sstever@gmail.com        extern int x;
8305204Sstever@gmail.com        int main() { return x; }
8315204Sstever@gmail.com        ''', extension=".c")
8325204Sstever@gmail.com    context.env.Append(LEADING_UNDERSCORE=ret)
8335204Sstever@gmail.com    context.Result(ret)
8345204Sstever@gmail.com    return ret
8355204Sstever@gmail.com
8365204Sstever@gmail.com# Add a custom Check function to test for structure members.
8375204Sstever@gmail.comdef CheckMember(context, include, decl, member, include_quotes="<>"):
8385204Sstever@gmail.com    context.Message("Checking for member %s in %s..." %
8396121Snate@binkert.org                    (member, decl))
8405204Sstever@gmail.com    text = """
8417727SAli.Saidi@ARM.com#include %(header)s
8427727SAli.Saidi@ARM.comint main(){
8437727SAli.Saidi@ARM.com  %(decl)s test;
8447727SAli.Saidi@ARM.com  (void)test.%(member)s;
8457727SAli.Saidi@ARM.com  return 0;
8469812Sandreas.hansson@arm.com};
8479812Sandreas.hansson@arm.com""" % { "header" : include_quotes[0] + include + include_quotes[1],
8489812Sandreas.hansson@arm.com        "decl" : decl,
8499812Sandreas.hansson@arm.com        "member" : member,
8509812Sandreas.hansson@arm.com        }
8519812Sandreas.hansson@arm.com
8529812Sandreas.hansson@arm.com    ret = context.TryCompile(text, extension=".cc")
8539812Sandreas.hansson@arm.com    context.Result(ret)
8549812Sandreas.hansson@arm.com    return ret
8559812Sandreas.hansson@arm.com
8569812Sandreas.hansson@arm.com# Platform-specific configuration.  Note again that we assume that all
8579812Sandreas.hansson@arm.com# builds under a given build root run on the same host platform.
8589812Sandreas.hansson@arm.comconf = Configure(main,
8599812Sandreas.hansson@arm.com                 conf_dir = joinpath(build_root, '.scons_config'),
8609812Sandreas.hansson@arm.com                 log_file = joinpath(build_root, 'scons_config.log'),
8619812Sandreas.hansson@arm.com                 custom_tests = {
8629812Sandreas.hansson@arm.com        'CheckLeading' : CheckLeading,
8639812Sandreas.hansson@arm.com        'CheckMember' : CheckMember,
8649812Sandreas.hansson@arm.com        })
8659812Sandreas.hansson@arm.com
8669812Sandreas.hansson@arm.com# Check for leading underscores.  Don't really need to worry either
8679812Sandreas.hansson@arm.com# way so don't need to check the return code.
8689812Sandreas.hansson@arm.comconf.CheckLeading()
8699812Sandreas.hansson@arm.com
8707727SAli.Saidi@ARM.com# Check if we should compile a 64 bit binary on Mac OS X/Darwin
8715863Snate@binkert.orgtry:
8723118Sstever@eecs.umich.edu    import platform
8735863Snate@binkert.org    uname = platform.uname()
8749239Sandreas.hansson@arm.com    if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0:
8753118Sstever@eecs.umich.edu        if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
8763118Sstever@eecs.umich.edu            main.Append(CCFLAGS=['-arch', 'x86_64'])
8775863Snate@binkert.org            main.Append(CFLAGS=['-arch', 'x86_64'])
8785863Snate@binkert.org            main.Append(LINKFLAGS=['-arch', 'x86_64'])
8795863Snate@binkert.org            main.Append(ASFLAGS=['-arch', 'x86_64'])
8805863Snate@binkert.orgexcept:
8813118Sstever@eecs.umich.edu    pass
8823483Ssaidi@eecs.umich.edu
8833494Ssaidi@eecs.umich.edu# Recent versions of scons substitute a "Null" object for Configure()
8843494Ssaidi@eecs.umich.edu# when configuration isn't necessary, e.g., if the "--help" option is
8853483Ssaidi@eecs.umich.edu# present.  Unfortuantely this Null object always returns false,
8863483Ssaidi@eecs.umich.edu# breaking all our configuration checks.  We replace it with our own
8873483Ssaidi@eecs.umich.edu# more optimistic null object that returns True instead.
8883053Sstever@eecs.umich.eduif not conf:
8893053Sstever@eecs.umich.edu    def NullCheck(*args, **kwargs):
8903918Ssaidi@eecs.umich.edu        return True
8913053Sstever@eecs.umich.edu
8923053Sstever@eecs.umich.edu    class NullConf:
8933053Sstever@eecs.umich.edu        def __init__(self, env):
8943053Sstever@eecs.umich.edu            self.env = env
8953053Sstever@eecs.umich.edu        def Finish(self):
8969396Sandreas.hansson@arm.com            return self.env
8979396Sandreas.hansson@arm.com        def __getattr__(self, mname):
8989396Sandreas.hansson@arm.com            return NullCheck
8999396Sandreas.hansson@arm.com
9009396Sandreas.hansson@arm.com    conf = NullConf(main)
9019396Sandreas.hansson@arm.com
9029396Sandreas.hansson@arm.com# Cache build files in the supplied directory.
9039396Sandreas.hansson@arm.comif main['M5_BUILD_CACHE']:
9049396Sandreas.hansson@arm.com    print 'Using build cache located at', main['M5_BUILD_CACHE']
9059477Sandreas.hansson@arm.com    CacheDir(main['M5_BUILD_CACHE'])
9069396Sandreas.hansson@arm.com
9079477Sandreas.hansson@arm.comif not GetOption('without_python'):
9089477Sandreas.hansson@arm.com    # Find Python include and library directories for embedding the
9099477Sandreas.hansson@arm.com    # interpreter. We rely on python-config to resolve the appropriate
9109477Sandreas.hansson@arm.com    # includes and linker flags. ParseConfig does not seem to understand
9119396Sandreas.hansson@arm.com    # the more exotic linker flags such as -Xlinker and -export-dynamic so
9127840Snate@binkert.org    # we add them explicitly below. If you want to link in an alternate
9137865Sgblack@eecs.umich.edu    # version of python, see above for instructions on how to invoke
9147865Sgblack@eecs.umich.edu    # scons with the appropriate PATH set.
9157865Sgblack@eecs.umich.edu    #
9167865Sgblack@eecs.umich.edu    # First we check if python2-config exists, else we use python-config
9177865Sgblack@eecs.umich.edu    python_config = readCommand(['which', 'python2-config'],
9187840Snate@binkert.org                                exception='').strip()
9199591Sandreas@sandberg.pp.se    if not os.path.exists(python_config):
9209591Sandreas@sandberg.pp.se        python_config = readCommand(['which', 'python-config'],
9219591Sandreas@sandberg.pp.se                                    exception='').strip()
9229590Sandreas@sandberg.pp.se    py_includes = readCommand([python_config, '--includes'],
9239590Sandreas@sandberg.pp.se                              exception='').split()
9249045SAli.Saidi@ARM.com    # Strip the -I from the include folders before adding them to the
9259045SAli.Saidi@ARM.com    # CPPPATH
9269071Sandreas.hansson@arm.com    main.Append(CPPPATH=map(lambda inc: inc[2:], py_includes))
9279071Sandreas.hansson@arm.com
9289045SAli.Saidi@ARM.com    # Read the linker flags and split them into libraries and other link
9297840Snate@binkert.org    # flags. The libraries are added later through the call the CheckLib.
9307840Snate@binkert.org    py_ld_flags = readCommand([python_config, '--ldflags'],
9317840Snate@binkert.org        exception='').split()
9321858SN/A    py_libs = []
9331858SN/A    for lib in py_ld_flags:
9341858SN/A         if not lib.startswith('-l'):
9351858SN/A             main.Append(LINKFLAGS=[lib])
9361858SN/A         else:
9371858SN/A             lib = lib[2:]
9389651SAndreas.Sandberg@ARM.com             if lib not in py_libs:
9399651SAndreas.Sandberg@ARM.com                 py_libs.append(lib)
9409651SAndreas.Sandberg@ARM.com
9419651SAndreas.Sandberg@ARM.com    # verify that this stuff works
9429651SAndreas.Sandberg@ARM.com    if not conf.CheckHeader('Python.h', '<>'):
9439651SAndreas.Sandberg@ARM.com        print "Error: can't find Python.h header in", py_includes
9449651SAndreas.Sandberg@ARM.com        print "Install Python headers (package python-dev on Ubuntu and RedHat)"
9459651SAndreas.Sandberg@ARM.com        Exit(1)
9469651SAndreas.Sandberg@ARM.com
9479657Sandreas.sandberg@arm.com    for lib in py_libs:
9489651SAndreas.Sandberg@ARM.com        if not conf.CheckLib(lib):
9499651SAndreas.Sandberg@ARM.com            print "Error: can't find library %s required by python" % lib
9509651SAndreas.Sandberg@ARM.com            Exit(1)
9519651SAndreas.Sandberg@ARM.com
9529651SAndreas.Sandberg@ARM.com# On Solaris you need to use libsocket for socket ops
9539651SAndreas.Sandberg@ARM.comif not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
9549651SAndreas.Sandberg@ARM.com   if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
9559651SAndreas.Sandberg@ARM.com       print "Can't find library with socket calls (e.g. accept())"
9569651SAndreas.Sandberg@ARM.com       Exit(1)
9579651SAndreas.Sandberg@ARM.com
9589651SAndreas.Sandberg@ARM.com# Check for zlib.  If the check passes, libz will be automatically
9595863Snate@binkert.org# added to the LIBS environment variable.
9605863Snate@binkert.orgif not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
9615863Snate@binkert.org    print 'Error: did not find needed zlib compression library '\
9625863Snate@binkert.org          'and/or zlib.h header file.'
9636121Snate@binkert.org    print '       Please install zlib and try again.'
9641858SN/A    Exit(1)
9655863Snate@binkert.org
9665863Snate@binkert.org# If we have the protobuf compiler, also make sure we have the
9675863Snate@binkert.org# development libraries. If the check passes, libprotobuf will be
9685863Snate@binkert.org# automatically added to the LIBS environment variable. After
9695863Snate@binkert.org# this, we can use the HAVE_PROTOBUF flag to determine if we have
9702139SN/A# got both protoc and libprotobuf available.
9714202Sbinkertn@umich.edumain['HAVE_PROTOBUF'] = main['PROTOC'] and \
9724202Sbinkertn@umich.edu    conf.CheckLibWithHeader('protobuf', 'google/protobuf/message.h',
9732139SN/A                            'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;')
9746994Snate@binkert.org
9756994Snate@binkert.org# If we have the compiler but not the library, print another warning.
9766994Snate@binkert.orgif main['PROTOC'] and not main['HAVE_PROTOBUF']:
9776994Snate@binkert.org    print termcap.Yellow + termcap.Bold + \
9786994Snate@binkert.org        'Warning: did not find protocol buffer library and/or headers.\n' + \
9796994Snate@binkert.org    '       Please install libprotobuf-dev for tracing support.' + \
9806994Snate@binkert.org    termcap.Normal
9816994Snate@binkert.org
9826994Snate@binkert.org# Check for librt.
9836994Snate@binkert.orghave_posix_clock = \
9846994Snate@binkert.org    conf.CheckLibWithHeader(None, 'time.h', 'C',
9856994Snate@binkert.org                            'clock_nanosleep(0,0,NULL,NULL);') or \
9866994Snate@binkert.org    conf.CheckLibWithHeader('rt', 'time.h', 'C',
9876994Snate@binkert.org                            'clock_nanosleep(0,0,NULL,NULL);')
9886994Snate@binkert.org
9896994Snate@binkert.orghave_posix_timers = \
9906994Snate@binkert.org    conf.CheckLibWithHeader([None, 'rt'], [ 'time.h', 'signal.h' ], 'C',
9916994Snate@binkert.org                            'timer_create(CLOCK_MONOTONIC, NULL, NULL);')
9926994Snate@binkert.org
9936994Snate@binkert.orgif not GetOption('without_tcmalloc'):
9946994Snate@binkert.org    if conf.CheckLib('tcmalloc'):
9956994Snate@binkert.org        main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS'])
9966994Snate@binkert.org    elif conf.CheckLib('tcmalloc_minimal'):
9976994Snate@binkert.org        main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS'])
9986994Snate@binkert.org    else:
9996994Snate@binkert.org        print termcap.Yellow + termcap.Bold + \
10006994Snate@binkert.org              "You can get a 12% performance improvement by "\
10016994Snate@binkert.org              "installing tcmalloc (libgoogle-perftools-dev package "\
10022155SN/A              "on Ubuntu or RedHat)." + termcap.Normal
10035863Snate@binkert.org
10041869SN/Aif not have_posix_clock:
10051869SN/A    print "Can't find library for POSIX clocks."
10065863Snate@binkert.org
10075863Snate@binkert.org# Check for <fenv.h> (C99 FP environment control)
10084202Sbinkertn@umich.eduhave_fenv = conf.CheckHeader('fenv.h', '<>')
10096108Snate@binkert.orgif not have_fenv:
10106108Snate@binkert.org    print "Warning: Header file <fenv.h> not found."
10116108Snate@binkert.org    print "         This host has no IEEE FP rounding mode control."
10126108Snate@binkert.org
10139219Spower.jg@gmail.com# Check if we should enable KVM-based hardware virtualization. The API
10149219Spower.jg@gmail.com# we rely on exists since version 2.6.36 of the kernel, but somehow
10159219Spower.jg@gmail.com# the KVM_API_VERSION does not reflect the change. We test for one of
10169219Spower.jg@gmail.com# the types as a fall back.
10179219Spower.jg@gmail.comhave_kvm = conf.CheckHeader('linux/kvm.h', '<>') and \
10189219Spower.jg@gmail.com    conf.CheckTypeSize('struct kvm_xsave', '#include <linux/kvm.h>') != 0
10199219Spower.jg@gmail.comif not have_kvm:
10209219Spower.jg@gmail.com    print "Info: Compatible header file <linux/kvm.h> not found, " \
10214202Sbinkertn@umich.edu        "disabling KVM support."
10225863Snate@binkert.org
10238474Sgblack@eecs.umich.edu# Check if the requested target ISA is compatible with the host
10248474Sgblack@eecs.umich.edudef is_isa_kvm_compatible(isa):
10255742Snate@binkert.org    isa_comp_table = {
10268268Ssteve.reinhardt@amd.com        "arm" : ( "armv7l" ),
10278268Ssteve.reinhardt@amd.com        "x86" : ( "x86_64" ),
10288268Ssteve.reinhardt@amd.com        }
10295742Snate@binkert.org    try:
10305341Sstever@gmail.com        import platform
10318474Sgblack@eecs.umich.edu        host_isa = platform.machine()
10328474Sgblack@eecs.umich.edu    except:
10335342Sstever@gmail.com        print "Warning: Failed to determine host ISA."
10344202Sbinkertn@umich.edu        return False
10354202Sbinkertn@umich.edu
10364202Sbinkertn@umich.edu    return host_isa in isa_comp_table.get(isa, [])
10375863Snate@binkert.org
10385863Snate@binkert.org
10396994Snate@binkert.org# Check if the exclude_host attribute is available. We want this to
10406994Snate@binkert.org# get accurate instruction counts in KVM.
10416994Snate@binkert.orgmain['HAVE_PERF_ATTR_EXCLUDE_HOST'] = conf.CheckMember(
10425863Snate@binkert.org    'linux/perf_event.h', 'struct perf_event_attr', 'exclude_host')
10435863Snate@binkert.org
10445863Snate@binkert.org
10455863Snate@binkert.org######################################################################
10465863Snate@binkert.org#
10475863Snate@binkert.org# Finish the configuration
10485863Snate@binkert.org#
10495863Snate@binkert.orgmain = conf.Finish()
10507840Snate@binkert.org
10515863Snate@binkert.org######################################################################
10525952Ssaidi@eecs.umich.edu#
10539651SAndreas.Sandberg@ARM.com# Collect all non-global variables
10549219Spower.jg@gmail.com#
10559219Spower.jg@gmail.com
10561869SN/A# Define the universe of supported ISAs
10571858SN/Aall_isa_list = [ ]
10585863Snate@binkert.orgExport('all_isa_list')
10599420Sandreas.hansson@arm.com
10609420Sandreas.hansson@arm.comclass CpuModel(object):
10611858SN/A    '''The CpuModel class encapsulates everything the ISA parser needs to
1062955SN/A    know about a particular CPU model.'''
1063955SN/A
10641869SN/A    # Dict of available CPU model objects.  Accessible as CpuModel.dict.
10651869SN/A    dict = {}
10661869SN/A
10671869SN/A    # Constructor.  Automatically adds models to CpuModel.dict.
10681869SN/A    def __init__(self, name, default=False):
10695863Snate@binkert.org        self.name = name           # name of model
10705863Snate@binkert.org
10715863Snate@binkert.org        # This cpu is enabled by default
10721869SN/A        self.default = default
10735863Snate@binkert.org
10741869SN/A        # Add self to dict
10755863Snate@binkert.org        if name in CpuModel.dict:
10761869SN/A            raise AttributeError, "CpuModel '%s' already registered" % name
10771869SN/A        CpuModel.dict[name] = self
10781869SN/A
10791869SN/AExport('CpuModel')
10808483Sgblack@eecs.umich.edu
10811869SN/A# Sticky variables get saved in the variables file so they persist from
10821869SN/A# one invocation to the next (unless overridden, in which case the new
10831869SN/A# value becomes sticky).
10841869SN/Asticky_vars = Variables(args=ARGUMENTS)
10855863Snate@binkert.orgExport('sticky_vars')
10865863Snate@binkert.org
10871869SN/A# Sticky variables that should be exported
10885863Snate@binkert.orgexport_vars = []
10895863Snate@binkert.orgExport('export_vars')
10903356Sbinkertn@umich.edu
10913356Sbinkertn@umich.edu# For Ruby
10923356Sbinkertn@umich.eduall_protocols = []
10933356Sbinkertn@umich.eduExport('all_protocols')
10943356Sbinkertn@umich.eduprotocol_dirs = []
10954781Snate@binkert.orgExport('protocol_dirs')
10965863Snate@binkert.orgslicc_includes = []
10975863Snate@binkert.orgExport('slicc_includes')
10981869SN/A
10991869SN/A# Walk the tree and execute all SConsopts scripts that wil add to the
11001869SN/A# above variables
11016121Snate@binkert.orgif GetOption('verbose'):
11021869SN/A    print "Reading SConsopts"
11032638Sstever@eecs.umich.edufor bdir in [ base_dir ] + extras_dir_list:
11046121Snate@binkert.org    if not isdir(bdir):
11056121Snate@binkert.org        print "Error: directory '%s' does not exist" % bdir
11062638Sstever@eecs.umich.edu        Exit(1)
11075749Scws3k@cs.virginia.edu    for root, dirs, files in os.walk(bdir):
11086121Snate@binkert.org        if 'SConsopts' in files:
11096121Snate@binkert.org            if GetOption('verbose'):
11105749Scws3k@cs.virginia.edu                print "Reading", joinpath(root, 'SConsopts')
11119537Satgutier@umich.edu            SConscript(joinpath(root, 'SConsopts'))
11129537Satgutier@umich.edu
11139537Satgutier@umich.eduall_isa_list.sort()
11149537Satgutier@umich.edu
11151869SN/Asticky_vars.AddVariables(
11161869SN/A    EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list),
11173546Sgblack@eecs.umich.edu    ListVariable('CPU_MODELS', 'CPU models',
11183546Sgblack@eecs.umich.edu                 sorted(n for n,m in CpuModel.dict.iteritems() if m.default),
11193546Sgblack@eecs.umich.edu                 sorted(CpuModel.dict.keys())),
11203546Sgblack@eecs.umich.edu    BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
11216121Snate@binkert.org                 False),
11225863Snate@binkert.org    BoolVariable('SS_COMPATIBLE_FP',
11233546Sgblack@eecs.umich.edu                 'Make floating-point results compatible with SimpleScalar',
11243546Sgblack@eecs.umich.edu                 False),
11253546Sgblack@eecs.umich.edu    BoolVariable('USE_SSE2',
11263546Sgblack@eecs.umich.edu                 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
11274781Snate@binkert.org                 False),
11284781Snate@binkert.org    BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock),
11296658Snate@binkert.org    BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
11306658Snate@binkert.org    BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False),
11314781Snate@binkert.org    BoolVariable('USE_KVM', 'Enable hardware virtualized (KVM) CPU models', have_kvm),
11323546Sgblack@eecs.umich.edu    EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None',
11333546Sgblack@eecs.umich.edu                  all_protocols),
11343546Sgblack@eecs.umich.edu    )
11353546Sgblack@eecs.umich.edu
11367756SAli.Saidi@ARM.com# These variables get exported to #defines in config/*.hh (see src/SConscript).
11377816Ssteve.reinhardt@amd.comexport_vars += ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'CP_ANNOTATE',
11383546Sgblack@eecs.umich.edu                'USE_POSIX_CLOCK', 'PROTOCOL', 'HAVE_PROTOBUF',
11393546Sgblack@eecs.umich.edu                'HAVE_PERF_ATTR_EXCLUDE_HOST']
11403546Sgblack@eecs.umich.edu
11413546Sgblack@eecs.umich.edu###################################################
11424202Sbinkertn@umich.edu#
11433546Sgblack@eecs.umich.edu# Define a SCons builder for configuration flag headers.
11443546Sgblack@eecs.umich.edu#
11453546Sgblack@eecs.umich.edu###################################################
1146955SN/A
1147955SN/A# This function generates a config header file that #defines the
1148955SN/A# variable symbol to the current variable setting (0 or 1).  The source
1149955SN/A# operands are the name of the variable and a Value node containing the
11505863Snate@binkert.org# value of the variable.
11515863Snate@binkert.orgdef build_config_file(target, source, env):
11525343Sstever@gmail.com    (variable, value) = [s.get_contents() for s in source]
11535343Sstever@gmail.com    f = file(str(target[0]), 'w')
11546121Snate@binkert.org    print >> f, '#define', variable, value
11555863Snate@binkert.org    f.close()
11564773Snate@binkert.org    return None
11575863Snate@binkert.org
11582632Sstever@eecs.umich.edu# Combine the two functions into a scons Action object.
11595863Snate@binkert.orgconfig_action = MakeAction(build_config_file, Transform("CONFIG H", 2))
11602023SN/A
11615863Snate@binkert.org# The emitter munges the source & target node lists to reflect what
11625863Snate@binkert.org# we're really doing.
11635863Snate@binkert.orgdef config_emitter(target, source, env):
11645863Snate@binkert.org    # extract variable name from Builder arg
11655863Snate@binkert.org    variable = str(target[0])
11665863Snate@binkert.org    # True target is config header file
11675863Snate@binkert.org    target = joinpath('config', variable.lower() + '.hh')
11685863Snate@binkert.org    val = env[variable]
11695863Snate@binkert.org    if isinstance(val, bool):
11702632Sstever@eecs.umich.edu        # Force value to 0/1
11715863Snate@binkert.org        val = int(val)
11722023SN/A    elif isinstance(val, str):
11732632Sstever@eecs.umich.edu        val = '"' + val + '"'
11745863Snate@binkert.org
11755342Sstever@gmail.com    # Sources are variable name & value (packaged in SCons Value nodes)
11765863Snate@binkert.org    return ([target], [Value(variable), Value(val)])
11772632Sstever@eecs.umich.edu
11785863Snate@binkert.orgconfig_builder = Builder(emitter = config_emitter, action = config_action)
11795863Snate@binkert.org
11808267Ssteve.reinhardt@amd.commain.Append(BUILDERS = { 'ConfigFile' : config_builder })
11818120Sgblack@eecs.umich.edu
11828267Ssteve.reinhardt@amd.com# libelf build is shared across all configs in the build root.
11838267Ssteve.reinhardt@amd.commain.SConscript('ext/libelf/SConscript',
11848267Ssteve.reinhardt@amd.com                variant_dir = joinpath(build_root, 'libelf'))
11858267Ssteve.reinhardt@amd.com
11868267Ssteve.reinhardt@amd.com# gzstream build is shared across all configs in the build root.
11878267Ssteve.reinhardt@amd.commain.SConscript('ext/gzstream/SConscript',
11888267Ssteve.reinhardt@amd.com                variant_dir = joinpath(build_root, 'gzstream'))
11898267Ssteve.reinhardt@amd.com
11908267Ssteve.reinhardt@amd.com# libfdt build is shared across all configs in the build root.
11915863Snate@binkert.orgmain.SConscript('ext/libfdt/SConscript',
11925863Snate@binkert.org                variant_dir = joinpath(build_root, 'libfdt'))
11935863Snate@binkert.org
11942632Sstever@eecs.umich.edu# fputils build is shared across all configs in the build root.
11958267Ssteve.reinhardt@amd.commain.SConscript('ext/fputils/SConscript',
11968267Ssteve.reinhardt@amd.com                variant_dir = joinpath(build_root, 'fputils'))
11978267Ssteve.reinhardt@amd.com
11982632Sstever@eecs.umich.edu# DRAMSim2 build is shared across all configs in the build root.
11991888SN/Amain.SConscript('ext/dramsim2/SConscript',
12005863Snate@binkert.org                variant_dir = joinpath(build_root, 'dramsim2'))
12015863Snate@binkert.org
12021858SN/A# DRAMPower build is shared across all configs in the build root.
12038120Sgblack@eecs.umich.edumain.SConscript('ext/drampower/SConscript',
12048120Sgblack@eecs.umich.edu                variant_dir = joinpath(build_root, 'drampower'))
12057756SAli.Saidi@ARM.com
12062598SN/A###################################################
12075863Snate@binkert.org#
12081858SN/A# This function is used to set up a directory with switching headers
12091858SN/A#
12101858SN/A###################################################
12115863Snate@binkert.org
12121858SN/Amain['ALL_ISA_LIST'] = all_isa_list
12131858SN/Aall_isa_deps = {}
12141858SN/Adef make_switching_dir(dname, switch_headers, env):
12155863Snate@binkert.org    # Generate the header.  target[0] is the full path of the output
12161871SN/A    # header to generate.  'source' is a dummy variable, since we get the
12171858SN/A    # list of ISAs from env['ALL_ISA_LIST'].
12181858SN/A    def gen_switch_hdr(target, source, env):
12191858SN/A        fname = str(target[0])
12201858SN/A        isa = env['TARGET_ISA'].lower()
12219651SAndreas.Sandberg@ARM.com        try:
12229651SAndreas.Sandberg@ARM.com            f = open(fname, 'w')
12239651SAndreas.Sandberg@ARM.com            print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname))
12249651SAndreas.Sandberg@ARM.com            f.close()
12259651SAndreas.Sandberg@ARM.com        except IOError:
12269651SAndreas.Sandberg@ARM.com            print "Failed to create %s" % fname
12279651SAndreas.Sandberg@ARM.com            raise
12289651SAndreas.Sandberg@ARM.com
12299651SAndreas.Sandberg@ARM.com    # Build SCons Action object. 'varlist' specifies env vars that this
12305863Snate@binkert.org    # action depends on; when env['ALL_ISA_LIST'] changes these actions
12315863Snate@binkert.org    # should get re-executed.
12321869SN/A    switch_hdr_action = MakeAction(gen_switch_hdr,
12331965SN/A                          Transform("GENERATE"), varlist=['ALL_ISA_LIST'])
12347739Sgblack@eecs.umich.edu
12351965SN/A    # Instantiate actions for each header
12362761Sstever@eecs.umich.edu    for hdr in switch_headers:
12375863Snate@binkert.org        env.Command(hdr, [], switch_hdr_action)
12381869SN/A
12395863Snate@binkert.org    isa_target = Dir('.').up().name.lower().replace('_', '-')
12402667Sstever@eecs.umich.edu    env['PHONY_BASE'] = '#'+isa_target
12411869SN/A    all_isa_deps[isa_target] = None
12421869SN/A
12432929Sktlim@umich.eduExport('make_switching_dir')
12442929Sktlim@umich.edu
12455863Snate@binkert.org# all-isas -> all-deps -> all-environs -> all_targets
12462929Sktlim@umich.edumain.Alias('#all-isas', [])
1247955SN/Amain.Alias('#all-deps', '#all-isas')
12488120Sgblack@eecs.umich.edu
12498120Sgblack@eecs.umich.edu# Dummy target to ensure all environments are created before telling
12508120Sgblack@eecs.umich.edu# SCons what to actually make (the command line arguments).  We attach
12518120Sgblack@eecs.umich.edu# them to the dependence graph after the environments are complete.
12528120Sgblack@eecs.umich.eduORIG_BUILD_TARGETS = list(BUILD_TARGETS) # force a copy; gets closure to work.
12538120Sgblack@eecs.umich.edudef environsComplete(target, source, env):
12548120Sgblack@eecs.umich.edu    for t in ORIG_BUILD_TARGETS:
12558120Sgblack@eecs.umich.edu        main.Depends('#all-targets', t)
12568120Sgblack@eecs.umich.edu
12578120Sgblack@eecs.umich.edu# Each build/* switching_dir attaches its *-environs target to #all-environs.
12588120Sgblack@eecs.umich.edumain.Append(BUILDERS = {'CompleteEnvirons' :
12598120Sgblack@eecs.umich.edu                        Builder(action=MakeAction(environsComplete, None))})
1260main.CompleteEnvirons('#all-environs', [])
1261
1262def doNothing(**ignored): pass
1263main.Append(BUILDERS = {'Dummy': Builder(action=MakeAction(doNothing, None))})
1264
1265# The final target to which all the original targets ultimately get attached.
1266main.Dummy('#all-targets', '#all-environs')
1267BUILD_TARGETS[:] = ['#all-targets']
1268
1269###################################################
1270#
1271# Define build environments for selected configurations.
1272#
1273###################################################
1274
1275for variant_path in variant_paths:
1276    if not GetOption('silent'):
1277        print "Building in", variant_path
1278
1279    # Make a copy of the build-root environment to use for this config.
1280    env = main.Clone()
1281    env['BUILDDIR'] = variant_path
1282
1283    # variant_dir is the tail component of build path, and is used to
1284    # determine the build parameters (e.g., 'ALPHA_SE')
1285    (build_root, variant_dir) = splitpath(variant_path)
1286
1287    # Set env variables according to the build directory config.
1288    sticky_vars.files = []
1289    # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
1290    # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
1291    # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
1292    current_vars_file = joinpath(build_root, 'variables', variant_dir)
1293    if isfile(current_vars_file):
1294        sticky_vars.files.append(current_vars_file)
1295        if not GetOption('silent'):
1296            print "Using saved variables file %s" % current_vars_file
1297    else:
1298        # Build dir-specific variables file doesn't exist.
1299
1300        # Make sure the directory is there so we can create it later
1301        opt_dir = dirname(current_vars_file)
1302        if not isdir(opt_dir):
1303            mkdir(opt_dir)
1304
1305        # Get default build variables from source tree.  Variables are
1306        # normally determined by name of $VARIANT_DIR, but can be
1307        # overridden by '--default=' arg on command line.
1308        default = GetOption('default')
1309        opts_dir = joinpath(main.root.abspath, 'build_opts')
1310        if default:
1311            default_vars_files = [joinpath(build_root, 'variables', default),
1312                                  joinpath(opts_dir, default)]
1313        else:
1314            default_vars_files = [joinpath(opts_dir, variant_dir)]
1315        existing_files = filter(isfile, default_vars_files)
1316        if existing_files:
1317            default_vars_file = existing_files[0]
1318            sticky_vars.files.append(default_vars_file)
1319            print "Variables file %s not found,\n  using defaults in %s" \
1320                  % (current_vars_file, default_vars_file)
1321        else:
1322            print "Error: cannot find variables file %s or " \
1323                  "default file(s) %s" \
1324                  % (current_vars_file, ' or '.join(default_vars_files))
1325            Exit(1)
1326
1327    # Apply current variable settings to env
1328    sticky_vars.Update(env)
1329
1330    help_texts["local_vars"] += \
1331        "Build variables for %s:\n" % variant_dir \
1332                 + sticky_vars.GenerateHelpText(env)
1333
1334    # Process variable settings.
1335
1336    if not have_fenv and env['USE_FENV']:
1337        print "Warning: <fenv.h> not available; " \
1338              "forcing USE_FENV to False in", variant_dir + "."
1339        env['USE_FENV'] = False
1340
1341    if not env['USE_FENV']:
1342        print "Warning: No IEEE FP rounding mode control in", variant_dir + "."
1343        print "         FP results may deviate slightly from other platforms."
1344
1345    if env['EFENCE']:
1346        env.Append(LIBS=['efence'])
1347
1348    if env['USE_KVM']:
1349        if not have_kvm:
1350            print "Warning: Can not enable KVM, host seems to lack KVM support"
1351            env['USE_KVM'] = False
1352        elif not have_posix_timers:
1353            print "Warning: Can not enable KVM, host seems to lack support " \
1354                "for POSIX timers"
1355            env['USE_KVM'] = False
1356        elif not is_isa_kvm_compatible(env['TARGET_ISA']):
1357            print "Info: KVM support disabled due to unsupported host and " \
1358                "target ISA combination"
1359            env['USE_KVM'] = False
1360
1361    # Warn about missing optional functionality
1362    if env['USE_KVM']:
1363        if not main['HAVE_PERF_ATTR_EXCLUDE_HOST']:
1364            print "Warning: perf_event headers lack support for the " \
1365                "exclude_host attribute. KVM instruction counts will " \
1366                "be inaccurate."
1367
1368    # Save sticky variable settings back to current variables file
1369    sticky_vars.Save(current_vars_file, env)
1370
1371    if env['USE_SSE2']:
1372        env.Append(CCFLAGS=['-msse2'])
1373
1374    # The src/SConscript file sets up the build rules in 'env' according
1375    # to the configured variables.  It returns a list of environments,
1376    # one for each variant build (debug, opt, etc.)
1377    SConscript('src/SConscript', variant_dir = variant_path, exports = 'env')
1378
1379def pairwise(iterable):
1380    "s -> (s0,s1), (s1,s2), (s2, s3), ..."
1381    a, b = itertools.tee(iterable)
1382    b.next()
1383    return itertools.izip(a, b)
1384
1385# Create false dependencies so SCons will parse ISAs, establish
1386# dependencies, and setup the build Environments serially. Either
1387# SCons (likely) and/or our SConscripts (possibly) cannot cope with -j
1388# greater than 1. It appears to be standard race condition stuff; it
1389# doesn't always fail, but usually, and the behaviors are different.
1390# Every time I tried to remove this, builds would fail in some
1391# creative new way. So, don't do that. You'll want to, though, because
1392# tests/SConscript takes a long time to make its Environments.
1393for t1, t2 in pairwise(sorted(all_isa_deps.iterkeys())):
1394    main.Depends('#%s-deps'     % t2, '#%s-deps'     % t1)
1395    main.Depends('#%s-environs' % t2, '#%s-environs' % t1)
1396
1397# base help text
1398Help('''
1399Usage: scons [scons options] [build variables] [target(s)]
1400
1401Extra scons options:
1402%(options)s
1403
1404Global build variables:
1405%(global_vars)s
1406
1407%(local_vars)s
1408''' % help_texts)
1409