SConstruct revision 10384
1955SN/A# -*- mode:python -*-
2955SN/A
310841Sandreas.sandberg@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
11210196SCurtis.Dunham@arm.comimport itertools
113955SN/Aimport os
1145396Ssaidi@eecs.umich.eduimport re
1155863Snate@binkert.orgimport subprocess
1165863Snate@binkert.orgimport sys
1174202Sbinkertn@umich.edu
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
1215863Snate@binkert.orgfrom os.path import join as joinpath, split as splitpath
122955SN/A
1236654Snate@binkert.org# SCons includes
1245273Sstever@gmail.comimport SCons
1255871Snate@binkert.orgimport SCons.Node
1265273Sstever@gmail.com
1276655Snate@binkert.orgextra_python_paths = [
1288878Ssteve.reinhardt@amd.com    Dir('src/python').srcnode().abspath, # gem5 includes
1296655Snate@binkert.org    Dir('ext/ply').srcnode().abspath, # ply is used by several files
1306655Snate@binkert.org    ]
1319219Spower.jg@gmail.com
1326655Snate@binkert.orgsys.path[1:1] = extra_python_paths
1335871Snate@binkert.org
1346654Snate@binkert.orgfrom m5.util import compareVersions, readCommand
1358947Sandreas.hansson@arm.comfrom m5.util.terminal import get_termcap
1365396Ssaidi@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")
1448120Sgblack@eecs.umich.edu
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.
1578879Ssteve.reinhardt@amd.comdef 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)
1718120Sgblack@eecs.umich.edu
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")
17610458Sandreas.hansson@arm.comAddLocalOption('--default', dest='default', type='string', action='store',
17710458Sandreas.hansson@arm.com               help='Override which build_opts file to use for defaults')
17810458Sandreas.hansson@arm.comAddLocalOption('--ignore-style', dest='ignore_style', action='store_true',
1798879Ssteve.reinhardt@amd.com               help='Disable style checking hooks')
1808879Ssteve.reinhardt@amd.comAddLocalOption('--no-lto', dest='no_lto', action='store_true',
1818879Ssteve.reinhardt@amd.com               help='Disable Link-Time Optimization for fast')
1828879Ssteve.reinhardt@amd.comAddLocalOption('--update-ref', dest='update_ref', action='store_true',
1839227Sandreas.hansson@arm.com               help='Update test reference outputs')
1849227Sandreas.hansson@arm.comAddLocalOption('--verbose', dest='verbose', action='store_true',
1858879Ssteve.reinhardt@amd.com               help='Print full tool command lines')
1868879Ssteve.reinhardt@amd.com
1878879Ssteve.reinhardt@amd.comtermcap = get_termcap(GetOption('use_colors'))
1888879Ssteve.reinhardt@amd.com
18910453SAndrew.Bardsley@arm.com########################################################################
19010453SAndrew.Bardsley@arm.com#
19110453SAndrew.Bardsley@arm.com# Set up the main build environment.
19210456SCurtis.Dunham@arm.com#
19310456SCurtis.Dunham@arm.com########################################################################
19410456SCurtis.Dunham@arm.com
19510457Sandreas.hansson@arm.com# export TERM so that clang reports errors in color
19610457Sandreas.hansson@arm.comuse_vars = set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH',
1978120Sgblack@eecs.umich.edu                 'LIBRARY_PATH', 'PATH', 'PKG_CONFIG_PATH', 'PROTOC',
1988947Sandreas.hansson@arm.com                 'PYTHONPATH', 'RANLIB', 'SWIG', 'TERM' ])
1997816Ssteve.reinhardt@amd.com
2005871Snate@binkert.orguse_prefixes = [
2015871Snate@binkert.org    "M5",           # M5 configuration (e.g., path to kernels)
2026121Snate@binkert.org    "DISTCC_",      # distcc (distributed compiler wrapper) configuration
2035871Snate@binkert.org    "CCACHE_",      # ccache (caching compiler wrapper) configuration
2045871Snate@binkert.org    "CCC_",         # clang static analyzer configuration
2059926Sstan.czerniawski@arm.com    ]
2069926Sstan.czerniawski@arm.com
2079119Sandreas.hansson@arm.comuse_env = {}
20810068Sandreas.hansson@arm.comfor key,val in os.environ.iteritems():
20910068Sandreas.hansson@arm.com    if key in use_vars or \
210955SN/A            any([key.startswith(prefix) for prefix in use_prefixes]):
2119416SAndreas.Sandberg@ARM.com        use_env[key] = val
2129416SAndreas.Sandberg@ARM.com
2139416SAndreas.Sandberg@ARM.commain = Environment(ENV=use_env)
2149416SAndreas.Sandberg@ARM.commain.Decider('MD5-timestamp')
2159416SAndreas.Sandberg@ARM.commain.root = Dir(".")         # The current directory (where this file lives).
2169416SAndreas.Sandberg@ARM.commain.srcdir = Dir("src")     # The source directory
2179416SAndreas.Sandberg@ARM.com
2185871Snate@binkert.orgmain_dict_keys = main.Dictionary().keys()
21910584Sandreas.hansson@arm.com
2209416SAndreas.Sandberg@ARM.com# Check that we have a C/C++ compiler
2219416SAndreas.Sandberg@ARM.comif not ('CC' in main_dict_keys and 'CXX' in main_dict_keys):
2225871Snate@binkert.org    print "No C++ compiler installed (package g++ on Ubuntu and RedHat)"
223955SN/A    Exit(1)
22410671Sandreas.hansson@arm.com
22510671Sandreas.hansson@arm.com# Check that swig is present
22610671Sandreas.hansson@arm.comif not 'SWIG' in main_dict_keys:
22710671Sandreas.hansson@arm.com    print "swig is not installed (package swig on Ubuntu and RedHat)"
2288881Smarc.orr@gmail.com    Exit(1)
2296121Snate@binkert.org
2306121Snate@binkert.org# add useful python code PYTHONPATH so it can be used by subprocesses
2311533SN/A# as well
2329239Sandreas.hansson@arm.commain.AppendENVPath('PYTHONPATH', extra_python_paths)
2339239Sandreas.hansson@arm.com
2349239Sandreas.hansson@arm.com########################################################################
2359239Sandreas.hansson@arm.com#
2369239Sandreas.hansson@arm.com# Mercurial Stuff.
2379239Sandreas.hansson@arm.com#
2389239Sandreas.hansson@arm.com# If the gem5 directory is a mercurial repository, we should do some
2399239Sandreas.hansson@arm.com# extra things.
2409239Sandreas.hansson@arm.com#
2419239Sandreas.hansson@arm.com########################################################################
2429239Sandreas.hansson@arm.com
2439239Sandreas.hansson@arm.comhgdir = main.root.Dir(".hg")
2446655Snate@binkert.org
2456655Snate@binkert.orgmercurial_style_message = """
2466655Snate@binkert.orgYou're missing the gem5 style hook, which automatically checks your code
2476655Snate@binkert.orgagainst the gem5 style rules on hg commit and qrefresh commands.  This
2485871Snate@binkert.orgscript will now install the hook in your .hg/hgrc file.
2495871Snate@binkert.orgPress enter to continue, or ctrl-c to abort: """
2505863Snate@binkert.org
2515871Snate@binkert.orgmercurial_style_hook = """
2528878Ssteve.reinhardt@amd.com# The following lines were automatically added by gem5/SConstruct
2535871Snate@binkert.org# to provide the gem5 style-checking hooks
2545871Snate@binkert.org[extensions]
2555871Snate@binkert.orgstyle = %s/util/style.py
2565863Snate@binkert.org
2576121Snate@binkert.org[hooks]
2585863Snate@binkert.orgpretxncommit.style = python:style.check_style
2595871Snate@binkert.orgpre-qrefresh.style = python:style.check_style
2608336Ssteve.reinhardt@amd.com# End of SConstruct additions
2618336Ssteve.reinhardt@amd.com
2628336Ssteve.reinhardt@amd.com""" % (main.root.abspath)
2638336Ssteve.reinhardt@amd.com
2644678Snate@binkert.orgmercurial_lib_not_found = """
2658336Ssteve.reinhardt@amd.comMercurial libraries cannot be found, ignoring style hook.  If
2668336Ssteve.reinhardt@amd.comyou are a gem5 developer, please fix this and run the style
2678336Ssteve.reinhardt@amd.comhook. It is important.
2684678Snate@binkert.org"""
2694678Snate@binkert.org
2704678Snate@binkert.org# Check for style hook and prompt for installation if it's not there.
2714678Snate@binkert.org# Skip this if --ignore-style was specified, there's no .hg dir to
2727827Snate@binkert.org# install a hook in, or there's no interactive terminal to prompt.
2737827Snate@binkert.orgif not GetOption('ignore_style') and hgdir.exists() and sys.stdin.isatty():
2748336Ssteve.reinhardt@amd.com    style_hook = True
2754678Snate@binkert.org    try:
2768336Ssteve.reinhardt@amd.com        from mercurial import ui
2778336Ssteve.reinhardt@amd.com        ui = ui.ui()
2788336Ssteve.reinhardt@amd.com        ui.readconfig(hgdir.File('hgrc').abspath)
2798336Ssteve.reinhardt@amd.com        style_hook = ui.config('hooks', 'pretxncommit.style', None) and \
2808336Ssteve.reinhardt@amd.com                     ui.config('hooks', 'pre-qrefresh.style', None)
2818336Ssteve.reinhardt@amd.com    except ImportError:
2825871Snate@binkert.org        print mercurial_lib_not_found
2835871Snate@binkert.org
2848336Ssteve.reinhardt@amd.com    if not style_hook:
2858336Ssteve.reinhardt@amd.com        print mercurial_style_message,
2868336Ssteve.reinhardt@amd.com        # continue unless user does ctrl-c/ctrl-d etc.
2878336Ssteve.reinhardt@amd.com        try:
2888336Ssteve.reinhardt@amd.com            raw_input()
2895871Snate@binkert.org        except:
2908336Ssteve.reinhardt@amd.com            print "Input exception, exiting scons.\n"
2918336Ssteve.reinhardt@amd.com            sys.exit(1)
2928336Ssteve.reinhardt@amd.com        hgrc_path = '%s/.hg/hgrc' % main.root.abspath
2938336Ssteve.reinhardt@amd.com        print "Adding style hook to", hgrc_path, "\n"
2948336Ssteve.reinhardt@amd.com        try:
2954678Snate@binkert.org            hgrc = open(hgrc_path, 'a')
2965871Snate@binkert.org            hgrc.write(mercurial_style_hook)
2974678Snate@binkert.org            hgrc.close()
2988336Ssteve.reinhardt@amd.com        except:
2998336Ssteve.reinhardt@amd.com            print "Error updating", hgrc_path
3008336Ssteve.reinhardt@amd.com            sys.exit(1)
3018336Ssteve.reinhardt@amd.com
3028336Ssteve.reinhardt@amd.com
3038336Ssteve.reinhardt@amd.com###################################################
3048336Ssteve.reinhardt@amd.com#
3058336Ssteve.reinhardt@amd.com# Figure out which configurations to set up based on the path(s) of
3068336Ssteve.reinhardt@amd.com# the target(s).
3078336Ssteve.reinhardt@amd.com#
3088336Ssteve.reinhardt@amd.com###################################################
3098336Ssteve.reinhardt@amd.com
3108336Ssteve.reinhardt@amd.com# Find default configuration & binary.
3118336Ssteve.reinhardt@amd.comDefault(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug'))
3128336Ssteve.reinhardt@amd.com
3138336Ssteve.reinhardt@amd.com# helper function: find last occurrence of element in list
3148336Ssteve.reinhardt@amd.comdef rfind(l, elt, offs = -1):
3155871Snate@binkert.org    for i in range(len(l)+offs, 0, -1):
3166121Snate@binkert.org        if l[i] == elt:
317955SN/A            return i
318955SN/A    raise ValueError, "element not found"
3192632Sstever@eecs.umich.edu
3202632Sstever@eecs.umich.edu# Take a list of paths (or SCons Nodes) and return a list with all
321955SN/A# paths made absolute and ~-expanded.  Paths will be interpreted
322955SN/A# relative to the launch directory unless a different root is provided
323955SN/Adef makePathListAbsolute(path_list, root=GetLaunchDir()):
324955SN/A    return [abspath(joinpath(root, expanduser(str(p))))
3258878Ssteve.reinhardt@amd.com            for p in path_list]
326955SN/A
3272632Sstever@eecs.umich.edu# Each target must have 'build' in the interior of the path; the
3282632Sstever@eecs.umich.edu# directory below this will determine the build parameters.  For
3292632Sstever@eecs.umich.edu# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
3302632Sstever@eecs.umich.edu# recognize that ALPHA_SE specifies the configuration because it
3312632Sstever@eecs.umich.edu# follow 'build' in the build path.
3322632Sstever@eecs.umich.edu
3332632Sstever@eecs.umich.edu# The funky assignment to "[:]" is needed to replace the list contents
3348268Ssteve.reinhardt@amd.com# in place rather than reassign the symbol to a new list, which
3358268Ssteve.reinhardt@amd.com# doesn't work (obviously!).
3368268Ssteve.reinhardt@amd.comBUILD_TARGETS[:] = makePathListAbsolute(BUILD_TARGETS)
3378268Ssteve.reinhardt@amd.com
3388268Ssteve.reinhardt@amd.com# Generate a list of the unique build roots and configs that the
3398268Ssteve.reinhardt@amd.com# collected targets reference.
3408268Ssteve.reinhardt@amd.comvariant_paths = []
3412632Sstever@eecs.umich.edubuild_root = None
3422632Sstever@eecs.umich.edufor t in BUILD_TARGETS:
3432632Sstever@eecs.umich.edu    path_dirs = t.split('/')
3442632Sstever@eecs.umich.edu    try:
3458268Ssteve.reinhardt@amd.com        build_top = rfind(path_dirs, 'build', -2)
3462632Sstever@eecs.umich.edu    except:
3478268Ssteve.reinhardt@amd.com        print "Error: no non-leaf 'build' dir found on target path", t
3488268Ssteve.reinhardt@amd.com        Exit(1)
3498268Ssteve.reinhardt@amd.com    this_build_root = joinpath('/',*path_dirs[:build_top+1])
3508268Ssteve.reinhardt@amd.com    if not build_root:
3513718Sstever@eecs.umich.edu        build_root = this_build_root
3522634Sstever@eecs.umich.edu    else:
3532634Sstever@eecs.umich.edu        if this_build_root != build_root:
3545863Snate@binkert.org            print "Error: build targets not under same build root\n"\
3552638Sstever@eecs.umich.edu                  "  %s\n  %s" % (build_root, this_build_root)
3568268Ssteve.reinhardt@amd.com            Exit(1)
3572632Sstever@eecs.umich.edu    variant_path = joinpath('/',*path_dirs[:build_top+2])
3582632Sstever@eecs.umich.edu    if variant_path not in variant_paths:
3592632Sstever@eecs.umich.edu        variant_paths.append(variant_path)
3602632Sstever@eecs.umich.edu
3612632Sstever@eecs.umich.edu# Make sure build_root exists (might not if this is the first build there)
3621858SN/Aif not isdir(build_root):
3633716Sstever@eecs.umich.edu    mkdir(build_root)
3642638Sstever@eecs.umich.edumain['BUILDROOT'] = build_root
3652638Sstever@eecs.umich.edu
3662638Sstever@eecs.umich.eduExport('main')
3672638Sstever@eecs.umich.edu
3682638Sstever@eecs.umich.edumain.SConsignFile(joinpath(build_root, "sconsign"))
3692638Sstever@eecs.umich.edu
3702638Sstever@eecs.umich.edu# Default duplicate option is to use hard links, but this messes up
3715863Snate@binkert.org# when you use emacs to edit a file in the target dir, as emacs moves
3725863Snate@binkert.org# file to file~ then copies to file, breaking the link.  Symbolic
3735863Snate@binkert.org# (soft) links work better.
374955SN/Amain.SetOption('duplicate', 'soft-copy')
3755341Sstever@gmail.com
3765341Sstever@gmail.com#
3775863Snate@binkert.org# Set up global sticky variables... these are common to an entire build
3787756SAli.Saidi@ARM.com# tree (not specific to a particular build like ALPHA_SE)
3795341Sstever@gmail.com#
3806121Snate@binkert.org
3814494Ssaidi@eecs.umich.eduglobal_vars_file = joinpath(build_root, 'variables.global')
3826121Snate@binkert.org
3831105SN/Aglobal_vars = Variables(global_vars_file, args=ARGUMENTS)
3842667Sstever@eecs.umich.edu
3852667Sstever@eecs.umich.eduglobal_vars.AddVariables(
3862667Sstever@eecs.umich.edu    ('CC', 'C compiler', environ.get('CC', main['CC'])),
3872667Sstever@eecs.umich.edu    ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])),
3886121Snate@binkert.org    ('SWIG', 'SWIG tool', environ.get('SWIG', main['SWIG'])),
3892667Sstever@eecs.umich.edu    ('PROTOC', 'protoc tool', environ.get('PROTOC', 'protoc')),
3905341Sstever@gmail.com    ('BATCH', 'Use batch pool for build and tests', False),
3915863Snate@binkert.org    ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
3925341Sstever@gmail.com    ('M5_BUILD_CACHE', 'Cache built objects in this directory', False),
3935341Sstever@gmail.com    ('EXTRAS', 'Add extra directories to the compilation', '')
3945341Sstever@gmail.com    )
3958120Sgblack@eecs.umich.edu
3965341Sstever@gmail.com# Update main environment with values from ARGUMENTS & global_vars_file
3978120Sgblack@eecs.umich.eduglobal_vars.Update(main)
3985341Sstever@gmail.comhelp_texts["global_vars"] += global_vars.GenerateHelpText(main)
3998120Sgblack@eecs.umich.edu
4006121Snate@binkert.org# Save sticky variable settings back to current variables file
4016121Snate@binkert.orgglobal_vars.Save(global_vars_file, main)
4028980Ssteve.reinhardt@amd.com
4039396Sandreas.hansson@arm.com# Parse EXTRAS variable to build list of all directories where we're
4045397Ssaidi@eecs.umich.edu# look for sources etc.  This list is exported as extras_dir_list.
4055397Ssaidi@eecs.umich.edubase_dir = main.srcdir.abspath
4067727SAli.Saidi@ARM.comif main['EXTRAS']:
4078268Ssteve.reinhardt@amd.com    extras_dir_list = makePathListAbsolute(main['EXTRAS'].split(':'))
4086168Snate@binkert.orgelse:
4095341Sstever@gmail.com    extras_dir_list = []
4108120Sgblack@eecs.umich.edu
4118120Sgblack@eecs.umich.eduExport('base_dir')
4128120Sgblack@eecs.umich.eduExport('extras_dir_list')
4136814Sgblack@eecs.umich.edu
4145863Snate@binkert.org# the ext directory should be on the #includes path
4158120Sgblack@eecs.umich.edumain.Append(CPPPATH=[Dir('ext')])
4165341Sstever@gmail.com
4175863Snate@binkert.orgdef strip_build_path(path, env):
4188268Ssteve.reinhardt@amd.com    path = str(path)
4196121Snate@binkert.org    variant_base = env['BUILDROOT'] + os.path.sep
4206121Snate@binkert.org    if path.startswith(variant_base):
4218268Ssteve.reinhardt@amd.com        path = path[len(variant_base):]
4225742Snate@binkert.org    elif path.startswith('build/'):
4235742Snate@binkert.org        path = path[6:]
4245341Sstever@gmail.com    return path
4255742Snate@binkert.org
4265742Snate@binkert.org# Generate a string of the form:
4275341Sstever@gmail.com#   common/path/prefix/src1, src2 -> tgt1, tgt2
4286017Snate@binkert.org# to print while building.
4296121Snate@binkert.orgclass Transform(object):
4306017Snate@binkert.org    # all specific color settings should be here and nowhere else
4317816Ssteve.reinhardt@amd.com    tool_color = termcap.Normal
4327756SAli.Saidi@ARM.com    pfx_color = termcap.Yellow
4337756SAli.Saidi@ARM.com    srcs_color = termcap.Yellow + termcap.Bold
4347756SAli.Saidi@ARM.com    arrow_color = termcap.Blue + termcap.Bold
4357756SAli.Saidi@ARM.com    tgts_color = termcap.Yellow + termcap.Bold
4367756SAli.Saidi@ARM.com
4377756SAli.Saidi@ARM.com    def __init__(self, tool, max_sources=99):
4387756SAli.Saidi@ARM.com        self.format = self.tool_color + (" [%8s] " % tool) \
4397756SAli.Saidi@ARM.com                      + self.pfx_color + "%s" \
4407816Ssteve.reinhardt@amd.com                      + self.srcs_color + "%s" \
4417816Ssteve.reinhardt@amd.com                      + self.arrow_color + " -> " \
4427816Ssteve.reinhardt@amd.com                      + self.tgts_color + "%s" \
4437816Ssteve.reinhardt@amd.com                      + termcap.Normal
4447816Ssteve.reinhardt@amd.com        self.max_sources = max_sources
4457816Ssteve.reinhardt@amd.com
4467816Ssteve.reinhardt@amd.com    def __call__(self, target, source, env, for_signature=None):
4477816Ssteve.reinhardt@amd.com        # truncate source list according to max_sources param
4487816Ssteve.reinhardt@amd.com        source = source[0:self.max_sources]
4497816Ssteve.reinhardt@amd.com        def strip(f):
4507756SAli.Saidi@ARM.com            return strip_build_path(str(f), env)
4517816Ssteve.reinhardt@amd.com        if len(source) > 0:
4527816Ssteve.reinhardt@amd.com            srcs = map(strip, source)
4537816Ssteve.reinhardt@amd.com        else:
4547816Ssteve.reinhardt@amd.com            srcs = ['']
4557816Ssteve.reinhardt@amd.com        tgts = map(strip, target)
4567816Ssteve.reinhardt@amd.com        # surprisingly, os.path.commonprefix is a dumb char-by-char string
4577816Ssteve.reinhardt@amd.com        # operation that has nothing to do with paths.
4587816Ssteve.reinhardt@amd.com        com_pfx = os.path.commonprefix(srcs + tgts)
4597816Ssteve.reinhardt@amd.com        com_pfx_len = len(com_pfx)
4607816Ssteve.reinhardt@amd.com        if com_pfx:
4617816Ssteve.reinhardt@amd.com            # do some cleanup and sanity checking on common prefix
4627816Ssteve.reinhardt@amd.com            if com_pfx[-1] == ".":
4637816Ssteve.reinhardt@amd.com                # prefix matches all but file extension: ok
4647816Ssteve.reinhardt@amd.com                # back up one to change 'foo.cc -> o' to 'foo.cc -> .o'
4657816Ssteve.reinhardt@amd.com                com_pfx = com_pfx[0:-1]
4667816Ssteve.reinhardt@amd.com            elif com_pfx[-1] == "/":
4677816Ssteve.reinhardt@amd.com                # common prefix is directory path: OK
4687816Ssteve.reinhardt@amd.com                pass
4697816Ssteve.reinhardt@amd.com            else:
4707816Ssteve.reinhardt@amd.com                src0_len = len(srcs[0])
4717816Ssteve.reinhardt@amd.com                tgt0_len = len(tgts[0])
4727816Ssteve.reinhardt@amd.com                if src0_len == com_pfx_len:
4737816Ssteve.reinhardt@amd.com                    # source is a substring of target, OK
4747816Ssteve.reinhardt@amd.com                    pass
4757816Ssteve.reinhardt@amd.com                elif tgt0_len == com_pfx_len:
4767816Ssteve.reinhardt@amd.com                    # target is a substring of source, need to back up to
4777816Ssteve.reinhardt@amd.com                    # avoid empty string on RHS of arrow
4787816Ssteve.reinhardt@amd.com                    sep_idx = com_pfx.rfind(".")
4797816Ssteve.reinhardt@amd.com                    if sep_idx != -1:
4807816Ssteve.reinhardt@amd.com                        com_pfx = com_pfx[0:sep_idx]
4817816Ssteve.reinhardt@amd.com                    else:
4827816Ssteve.reinhardt@amd.com                        com_pfx = ''
4837816Ssteve.reinhardt@amd.com                elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".":
4847816Ssteve.reinhardt@amd.com                    # still splitting at file extension: ok
4857816Ssteve.reinhardt@amd.com                    pass
4867816Ssteve.reinhardt@amd.com                else:
4877816Ssteve.reinhardt@amd.com                    # probably a fluke; ignore it
4887816Ssteve.reinhardt@amd.com                    com_pfx = ''
4897816Ssteve.reinhardt@amd.com        # recalculate length in case com_pfx was modified
4907816Ssteve.reinhardt@amd.com        com_pfx_len = len(com_pfx)
4917816Ssteve.reinhardt@amd.com        def fmt(files):
4927816Ssteve.reinhardt@amd.com            f = map(lambda s: s[com_pfx_len:], files)
4937816Ssteve.reinhardt@amd.com            return ', '.join(f)
4947816Ssteve.reinhardt@amd.com        return self.format % (com_pfx, fmt(srcs), fmt(tgts))
4957816Ssteve.reinhardt@amd.com
4967816Ssteve.reinhardt@amd.comExport('Transform')
4977816Ssteve.reinhardt@amd.com
4987816Ssteve.reinhardt@amd.com# enable the regression script to use the termcap
4997816Ssteve.reinhardt@amd.commain['TERMCAP'] = termcap
5007816Ssteve.reinhardt@amd.com
5017816Ssteve.reinhardt@amd.comif GetOption('verbose'):
5027816Ssteve.reinhardt@amd.com    def MakeAction(action, string, *args, **kwargs):
5037816Ssteve.reinhardt@amd.com        return Action(action, *args, **kwargs)
5047816Ssteve.reinhardt@amd.comelse:
5057816Ssteve.reinhardt@amd.com    MakeAction = Action
5067816Ssteve.reinhardt@amd.com    main['CCCOMSTR']        = Transform("CC")
5077816Ssteve.reinhardt@amd.com    main['CXXCOMSTR']       = Transform("CXX")
5087816Ssteve.reinhardt@amd.com    main['ASCOMSTR']        = Transform("AS")
5097816Ssteve.reinhardt@amd.com    main['SWIGCOMSTR']      = Transform("SWIG")
5107816Ssteve.reinhardt@amd.com    main['ARCOMSTR']        = Transform("AR", 0)
5117816Ssteve.reinhardt@amd.com    main['LINKCOMSTR']      = Transform("LINK", 0)
5128947Sandreas.hansson@arm.com    main['RANLIBCOMSTR']    = Transform("RANLIB", 0)
5138947Sandreas.hansson@arm.com    main['M4COMSTR']        = Transform("M4")
5147756SAli.Saidi@ARM.com    main['SHCCCOMSTR']      = Transform("SHCC")
5158120Sgblack@eecs.umich.edu    main['SHCXXCOMSTR']     = Transform("SHCXX")
5167756SAli.Saidi@ARM.comExport('MakeAction')
5177756SAli.Saidi@ARM.com
5187756SAli.Saidi@ARM.com# Initialize the Link-Time Optimization (LTO) flags
5197756SAli.Saidi@ARM.commain['LTO_CCFLAGS'] = []
5207816Ssteve.reinhardt@amd.commain['LTO_LDFLAGS'] = []
5217816Ssteve.reinhardt@amd.com
5227816Ssteve.reinhardt@amd.com# According to the readme, tcmalloc works best if the compiler doesn't
5237816Ssteve.reinhardt@amd.com# assume that we're using the builtin malloc and friends. These flags
5247816Ssteve.reinhardt@amd.com# are compiler-specific, so we need to set them after we detect which
5257816Ssteve.reinhardt@amd.com# compiler we're using.
5267816Ssteve.reinhardt@amd.commain['TCMALLOC_CCFLAGS'] = []
5277816Ssteve.reinhardt@amd.com
5287816Ssteve.reinhardt@amd.comCXX_version = readCommand([main['CXX'],'--version'], exception=False)
5297816Ssteve.reinhardt@amd.comCXX_V = readCommand([main['CXX'],'-V'], exception=False)
5307756SAli.Saidi@ARM.com
5317756SAli.Saidi@ARM.commain['GCC'] = CXX_version and CXX_version.find('g++') >= 0
5329227Sandreas.hansson@arm.commain['CLANG'] = CXX_version and CXX_version.find('clang') >= 0
5339227Sandreas.hansson@arm.comif main['GCC'] + main['CLANG'] > 1:
5349227Sandreas.hansson@arm.com    print 'Error: How can we have two at the same time?'
5359227Sandreas.hansson@arm.com    Exit(1)
5369590Sandreas@sandberg.pp.se
5379590Sandreas@sandberg.pp.se# Set up default C++ compiler flags
5389590Sandreas@sandberg.pp.seif main['GCC'] or main['CLANG']:
5399590Sandreas@sandberg.pp.se    # As gcc and clang share many flags, do the common parts here
5409590Sandreas@sandberg.pp.se    main.Append(CCFLAGS=['-pipe'])
5419590Sandreas@sandberg.pp.se    main.Append(CCFLAGS=['-fno-strict-aliasing'])
5426654Snate@binkert.org    # Enable -Wall and then disable the few warnings that we
5436654Snate@binkert.org    # consistently violate
5445871Snate@binkert.org    main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef'])
5456121Snate@binkert.org    # We always compile using C++11, but only gcc >= 4.7 and clang 3.1
5468946Sandreas.hansson@arm.com    # actually use that name, so we stick with c++0x
5479419Sandreas.hansson@arm.com    main.Append(CXXFLAGS=['-std=c++0x'])
5483940Ssaidi@eecs.umich.edu    # Add selected sanity checks from -Wextra
5493918Ssaidi@eecs.umich.edu    main.Append(CXXFLAGS=['-Wmissing-field-initializers',
5503918Ssaidi@eecs.umich.edu                          '-Woverloaded-virtual'])
5511858SN/Aelse:
5529556Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal,
5539556Sandreas.hansson@arm.com    print "Don't know what compiler options to use for your compiler."
5549556Sandreas.hansson@arm.com    print termcap.Yellow + '       compiler:' + termcap.Normal, main['CXX']
5559556Sandreas.hansson@arm.com    print termcap.Yellow + '       version:' + termcap.Normal,
5569556Sandreas.hansson@arm.com    if not CXX_version:
5579556Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\
5589556Sandreas.hansson@arm.com               termcap.Normal
5599556Sandreas.hansson@arm.com    else:
5609556Sandreas.hansson@arm.com        print CXX_version.replace('\n', '<nl>')
5619556Sandreas.hansson@arm.com    print "       If you're trying to use a compiler other than GCC"
5629556Sandreas.hansson@arm.com    print "       or clang, there appears to be something wrong with your"
5639556Sandreas.hansson@arm.com    print "       environment."
5649556Sandreas.hansson@arm.com    print "       "
5659556Sandreas.hansson@arm.com    print "       If you are trying to use a compiler other than those listed"
5669556Sandreas.hansson@arm.com    print "       above you will need to ease fix SConstruct and "
5679556Sandreas.hansson@arm.com    print "       src/SConscript to support that compiler."
5689556Sandreas.hansson@arm.com    Exit(1)
5699556Sandreas.hansson@arm.com
5709556Sandreas.hansson@arm.comif main['GCC']:
5719556Sandreas.hansson@arm.com    # Check for a supported version of gcc. >= 4.6 is chosen for its
5729556Sandreas.hansson@arm.com    # level of c++11 support. See
5739556Sandreas.hansson@arm.com    # http://gcc.gnu.org/projects/cxx0x.html for details. 4.6 is also
5749556Sandreas.hansson@arm.com    # the first version with proper LTO support.
5759556Sandreas.hansson@arm.com    gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False)
5769556Sandreas.hansson@arm.com    if compareVersions(gcc_version, "4.6") < 0:
5779556Sandreas.hansson@arm.com        print 'Error: gcc version 4.6 or newer required.'
5789556Sandreas.hansson@arm.com        print '       Installed version:', gcc_version
5799556Sandreas.hansson@arm.com        Exit(1)
5809556Sandreas.hansson@arm.com
5819556Sandreas.hansson@arm.com    main['GCC_VERSION'] = gcc_version
5829556Sandreas.hansson@arm.com
5839556Sandreas.hansson@arm.com    # gcc from version 4.8 and above generates "rep; ret" instructions
5846121Snate@binkert.org    # to avoid performance penalties on certain AMD chips. Older
58510238Sandreas.hansson@arm.com    # assemblers detect this as an error, "Error: expecting string
58610238Sandreas.hansson@arm.com    # instruction after `rep'"
58710238Sandreas.hansson@arm.com    if compareVersions(gcc_version, "4.8") > 0:
58810238Sandreas.hansson@arm.com        as_version = readCommand([main['AS'], '-v', '/dev/null'],
5899420Sandreas.hansson@arm.com                                 exception=False).split()
59010238Sandreas.hansson@arm.com
59110238Sandreas.hansson@arm.com        if not as_version or compareVersions(as_version[-1], "2.23") < 0:
5929420Sandreas.hansson@arm.com            print termcap.Yellow + termcap.Bold + \
5939420Sandreas.hansson@arm.com                'Warning: This combination of gcc and binutils have' + \
5949420Sandreas.hansson@arm.com                ' known incompatibilities.\n' + \
5959420Sandreas.hansson@arm.com                '         If you encounter build problems, please update ' + \
5969420Sandreas.hansson@arm.com                'binutils to 2.23.' + \
59710264Sandreas.hansson@arm.com                termcap.Normal
59810264Sandreas.hansson@arm.com
59910264Sandreas.hansson@arm.com    # Add the appropriate Link-Time Optimization (LTO) flags
60010264Sandreas.hansson@arm.com    # unless LTO is explicitly turned off. Note that these flags
60110264Sandreas.hansson@arm.com    # are only used by the fast target.
60210264Sandreas.hansson@arm.com    if not GetOption('no_lto'):
60310264Sandreas.hansson@arm.com        # Pass the LTO flag when compiling to produce GIMPLE
60410264Sandreas.hansson@arm.com        # output, we merely create the flags here and only append
60510264Sandreas.hansson@arm.com        # them later/
60610264Sandreas.hansson@arm.com        main['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
60710264Sandreas.hansson@arm.com
60810264Sandreas.hansson@arm.com        # Use the same amount of jobs for LTO as we are running
60910264Sandreas.hansson@arm.com        # scons with, we hardcode the use of the linker plugin
61010264Sandreas.hansson@arm.com        # which requires either gold or GNU ld >= 2.21
61110264Sandreas.hansson@arm.com        main['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs'),
61210264Sandreas.hansson@arm.com                               '-fuse-linker-plugin']
61310457Sandreas.hansson@arm.com
61410457Sandreas.hansson@arm.com    main.Append(TCMALLOC_CCFLAGS=['-fno-builtin-malloc', '-fno-builtin-calloc',
61510457Sandreas.hansson@arm.com                                  '-fno-builtin-realloc', '-fno-builtin-free'])
61610457Sandreas.hansson@arm.com
61710457Sandreas.hansson@arm.comelif main['CLANG']:
61810457Sandreas.hansson@arm.com    # Check for a supported version of clang, >= 3.0 is needed to
61910457Sandreas.hansson@arm.com    # support similar features as gcc 4.6. See
62010457Sandreas.hansson@arm.com    # http://clang.llvm.org/cxx_status.html for details
62110457Sandreas.hansson@arm.com    clang_version_re = re.compile(".* version (\d+\.\d+)")
62210238Sandreas.hansson@arm.com    clang_version_match = clang_version_re.search(CXX_version)
62310238Sandreas.hansson@arm.com    if (clang_version_match):
62410238Sandreas.hansson@arm.com        clang_version = clang_version_match.groups()[0]
62510238Sandreas.hansson@arm.com        if compareVersions(clang_version, "3.0") < 0:
62610238Sandreas.hansson@arm.com            print 'Error: clang version 3.0 or newer required.'
62710238Sandreas.hansson@arm.com            print '       Installed version:', clang_version
62810416Sandreas.hansson@arm.com            Exit(1)
62910238Sandreas.hansson@arm.com    else:
6309227Sandreas.hansson@arm.com        print 'Error: Unable to determine clang version.'
63110238Sandreas.hansson@arm.com        Exit(1)
63210416Sandreas.hansson@arm.com
63310416Sandreas.hansson@arm.com    # clang has a few additional warnings that we disable,
6349227Sandreas.hansson@arm.com    # tautological comparisons are allowed due to unsigned integers
6359590Sandreas@sandberg.pp.se    # being compared to constants that happen to be 0, and extraneous
6369590Sandreas@sandberg.pp.se    # parantheses are allowed due to Ruby's printing of the AST,
6379590Sandreas@sandberg.pp.se    # finally self assignments are allowed as the generated CPU code
6388737Skoansin.tan@gmail.com    # is relying on this
63910238Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-Wno-tautological-compare',
64010238Sandreas.hansson@arm.com                         '-Wno-parentheses',
6419420Sandreas.hansson@arm.com                         '-Wno-self-assign',
6428737Skoansin.tan@gmail.com                         # Some versions of libstdc++ (4.8?) seem to
64310106SMitch.Hayenga@arm.com                         # use struct hash and class hash
6448737Skoansin.tan@gmail.com                         # interchangeably.
6458737Skoansin.tan@gmail.com                         '-Wno-mismatched-tags',
64610238Sandreas.hansson@arm.com                         ])
64710238Sandreas.hansson@arm.com
6488737Skoansin.tan@gmail.com    main.Append(TCMALLOC_CCFLAGS=['-fno-builtin'])
6498737Skoansin.tan@gmail.com
6508737Skoansin.tan@gmail.com    # On Mac OS X/Darwin we need to also use libc++ (part of XCode) as
6518737Skoansin.tan@gmail.com    # opposed to libstdc++, as the later is dated.
6528737Skoansin.tan@gmail.com    if sys.platform == "darwin":
6538737Skoansin.tan@gmail.com        main.Append(CXXFLAGS=['-stdlib=libc++'])
6549556Sandreas.hansson@arm.com        main.Append(LIBS=['c++'])
6559556Sandreas.hansson@arm.com
6569556Sandreas.hansson@arm.comelse:
6579556Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal,
6589556Sandreas.hansson@arm.com    print "Don't know what compiler options to use for your compiler."
6599556Sandreas.hansson@arm.com    print termcap.Yellow + '       compiler:' + termcap.Normal, main['CXX']
6609556Sandreas.hansson@arm.com    print termcap.Yellow + '       version:' + termcap.Normal,
6619556Sandreas.hansson@arm.com    if not CXX_version:
66210278SAndreas.Sandberg@ARM.com        print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\
66310278SAndreas.Sandberg@ARM.com               termcap.Normal
66410278SAndreas.Sandberg@ARM.com    else:
66510278SAndreas.Sandberg@ARM.com        print CXX_version.replace('\n', '<nl>')
66610278SAndreas.Sandberg@ARM.com    print "       If you're trying to use a compiler other than GCC"
66710278SAndreas.Sandberg@ARM.com    print "       or clang, there appears to be something wrong with your"
6689556Sandreas.hansson@arm.com    print "       environment."
6699590Sandreas@sandberg.pp.se    print "       "
6709590Sandreas@sandberg.pp.se    print "       If you are trying to use a compiler other than those listed"
6719420Sandreas.hansson@arm.com    print "       above you will need to ease fix SConstruct and "
6729846Sandreas.hansson@arm.com    print "       src/SConscript to support that compiler."
6739846Sandreas.hansson@arm.com    Exit(1)
6749846Sandreas.hansson@arm.com
6759846Sandreas.hansson@arm.com# Set up common yacc/bison flags (needed for Ruby)
6768946Sandreas.hansson@arm.commain['YACCFLAGS'] = '-d'
6773918Ssaidi@eecs.umich.edumain['YACCHXXFILESUFFIX'] = '.hh'
6789068SAli.Saidi@ARM.com
6799068SAli.Saidi@ARM.com# Do this after we save setting back, or else we'll tack on an
6809068SAli.Saidi@ARM.com# extra 'qdo' every time we run scons.
6819068SAli.Saidi@ARM.comif main['BATCH']:
6829068SAli.Saidi@ARM.com    main['CC']     = main['BATCH_CMD'] + ' ' + main['CC']
6839068SAli.Saidi@ARM.com    main['CXX']    = main['BATCH_CMD'] + ' ' + main['CXX']
6849068SAli.Saidi@ARM.com    main['AS']     = main['BATCH_CMD'] + ' ' + main['AS']
6859068SAli.Saidi@ARM.com    main['AR']     = main['BATCH_CMD'] + ' ' + main['AR']
6869068SAli.Saidi@ARM.com    main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB']
6879419Sandreas.hansson@arm.com
6889068SAli.Saidi@ARM.comif sys.platform == 'cygwin':
6899068SAli.Saidi@ARM.com    # cygwin has some header file issues...
6909068SAli.Saidi@ARM.com    main.Append(CCFLAGS=["-Wno-uninitialized"])
6919068SAli.Saidi@ARM.com
6929068SAli.Saidi@ARM.com# Check for the protobuf compiler
6939068SAli.Saidi@ARM.comprotoc_version = readCommand([main['PROTOC'], '--version'],
6943918Ssaidi@eecs.umich.edu                             exception='').split()
6953918Ssaidi@eecs.umich.edu
6966157Snate@binkert.org# First two words should be "libprotoc x.y.z"
6976157Snate@binkert.orgif len(protoc_version) < 2 or protoc_version[0] != 'libprotoc':
6986157Snate@binkert.org    print termcap.Yellow + termcap.Bold + \
6996157Snate@binkert.org        'Warning: Protocol buffer compiler (protoc) not found.\n' + \
7005397Ssaidi@eecs.umich.edu        '         Please install protobuf-compiler for tracing support.' + \
7015397Ssaidi@eecs.umich.edu        termcap.Normal
7026121Snate@binkert.org    main['PROTOC'] = False
7036121Snate@binkert.orgelse:
7046121Snate@binkert.org    # Based on the availability of the compress stream wrappers,
7056121Snate@binkert.org    # require 2.1.0
7066121Snate@binkert.org    min_protoc_version = '2.1.0'
7076121Snate@binkert.org    if compareVersions(protoc_version[1], min_protoc_version) < 0:
7085397Ssaidi@eecs.umich.edu        print termcap.Yellow + termcap.Bold + \
7091851SN/A            'Warning: protoc version', min_protoc_version, \
7101851SN/A            'or newer required.\n' + \
7117739Sgblack@eecs.umich.edu            '         Installed version:', protoc_version[1], \
712955SN/A            termcap.Normal
7139396Sandreas.hansson@arm.com        main['PROTOC'] = False
7149396Sandreas.hansson@arm.com    else:
7159396Sandreas.hansson@arm.com        # Attempt to determine the appropriate include path and
7169396Sandreas.hansson@arm.com        # library path using pkg-config, that means we also need to
7179396Sandreas.hansson@arm.com        # check for pkg-config. Note that it is possible to use
7189396Sandreas.hansson@arm.com        # protobuf without the involvement of pkg-config. Later on we
7199396Sandreas.hansson@arm.com        # check go a library config check and at that point the test
7209396Sandreas.hansson@arm.com        # will fail if libprotobuf cannot be found.
7219396Sandreas.hansson@arm.com        if readCommand(['pkg-config', '--version'], exception=''):
7229396Sandreas.hansson@arm.com            try:
7239396Sandreas.hansson@arm.com                # Attempt to establish what linking flags to add for protobuf
7249396Sandreas.hansson@arm.com                # using pkg-config
7259396Sandreas.hansson@arm.com                main.ParseConfig('pkg-config --cflags --libs-only-L protobuf')
7269396Sandreas.hansson@arm.com            except:
7279396Sandreas.hansson@arm.com                print termcap.Yellow + termcap.Bold + \
7289396Sandreas.hansson@arm.com                    'Warning: pkg-config could not get protobuf flags.' + \
7299477Sandreas.hansson@arm.com                    termcap.Normal
7309477Sandreas.hansson@arm.com
7319477Sandreas.hansson@arm.com# Check for SWIG
7329477Sandreas.hansson@arm.comif not main.has_key('SWIG'):
7339477Sandreas.hansson@arm.com    print 'Error: SWIG utility not found.'
7349477Sandreas.hansson@arm.com    print '       Please install (see http://www.swig.org) and retry.'
7359477Sandreas.hansson@arm.com    Exit(1)
7369477Sandreas.hansson@arm.com
7379477Sandreas.hansson@arm.com# Check for appropriate SWIG version
7389477Sandreas.hansson@arm.comswig_version = readCommand([main['SWIG'], '-version'], exception='').split()
7399477Sandreas.hansson@arm.com# First 3 words should be "SWIG Version x.y.z"
7409477Sandreas.hansson@arm.comif len(swig_version) < 3 or \
7419477Sandreas.hansson@arm.com        swig_version[0] != 'SWIG' or swig_version[1] != 'Version':
7429477Sandreas.hansson@arm.com    print 'Error determining SWIG version.'
7439477Sandreas.hansson@arm.com    Exit(1)
7449477Sandreas.hansson@arm.com
7459477Sandreas.hansson@arm.commin_swig_version = '2.0.4'
7469477Sandreas.hansson@arm.comif compareVersions(swig_version[2], min_swig_version) < 0:
7479477Sandreas.hansson@arm.com    print 'Error: SWIG version', min_swig_version, 'or newer required.'
7489477Sandreas.hansson@arm.com    print '       Installed version:', swig_version[2]
7499477Sandreas.hansson@arm.com    Exit(1)
7509477Sandreas.hansson@arm.com
7519396Sandreas.hansson@arm.com# Set up SWIG flags & scanner
7523053Sstever@eecs.umich.eduswig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
7536121Snate@binkert.orgmain.Append(SWIGFLAGS=swig_flags)
7543053Sstever@eecs.umich.edu
7553053Sstever@eecs.umich.edu# Check for 'timeout' from GNU coreutils.  If present, regressions
7563053Sstever@eecs.umich.edu# will be run with a time limit.
7573053Sstever@eecs.umich.eduTIMEOUT_version = readCommand(['timeout', '--version'], exception=False)
7583053Sstever@eecs.umich.edumain['TIMEOUT'] = TIMEOUT_version and TIMEOUT_version.find('timeout') == 0
7599072Sandreas.hansson@arm.com
7603053Sstever@eecs.umich.edu# filter out all existing swig scanners, they mess up the dependency
7614742Sstever@eecs.umich.edu# stuff for some reason
7624742Sstever@eecs.umich.eduscanners = []
7633053Sstever@eecs.umich.edufor scanner in main['SCANNERS']:
7643053Sstever@eecs.umich.edu    skeys = scanner.skeys
7653053Sstever@eecs.umich.edu    if skeys == '.i':
76610181SCurtis.Dunham@arm.com        continue
7676654Snate@binkert.org
7683053Sstever@eecs.umich.edu    if isinstance(skeys, (list, tuple)) and '.i' in skeys:
7693053Sstever@eecs.umich.edu        continue
7703053Sstever@eecs.umich.edu
7713053Sstever@eecs.umich.edu    scanners.append(scanner)
77210425Sandreas.hansson@arm.com
77310425Sandreas.hansson@arm.com# add the new swig scanner that we like better
77410425Sandreas.hansson@arm.comfrom SCons.Scanner import ClassicCPP as CPPScanner
77510425Sandreas.hansson@arm.comswig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
77610425Sandreas.hansson@arm.comscanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re))
77710425Sandreas.hansson@arm.com
77810425Sandreas.hansson@arm.com# replace the scanners list that has what we want
77910425Sandreas.hansson@arm.commain['SCANNERS'] = scanners
78010425Sandreas.hansson@arm.com
78110425Sandreas.hansson@arm.com# Add a custom Check function to the Configure context so that we can
78210425Sandreas.hansson@arm.com# figure out if the compiler adds leading underscores to global
7832667Sstever@eecs.umich.edu# variables.  This is needed for the autogenerated asm files that we
7844554Sbinkertn@umich.edu# use for embedding the python code.
7856121Snate@binkert.orgdef CheckLeading(context):
7862667Sstever@eecs.umich.edu    context.Message("Checking for leading underscore in global variables...")
78710710Sandreas.hansson@arm.com    # 1) Define a global variable called x from asm so the C compiler
78810710Sandreas.hansson@arm.com    #    won't change the symbol at all.
78910710Sandreas.hansson@arm.com    # 2) Declare that variable.
79010710Sandreas.hansson@arm.com    # 3) Use the variable
79110710Sandreas.hansson@arm.com    #
79210710Sandreas.hansson@arm.com    # If the compiler prepends an underscore, this will successfully
79310710Sandreas.hansson@arm.com    # link because the external symbol 'x' will be called '_x' which
79410710Sandreas.hansson@arm.com    # was defined by the asm statement.  If the compiler does not
79510710Sandreas.hansson@arm.com    # prepend an underscore, this will not successfully link because
79610384SCurtis.Dunham@arm.com    # '_x' will have been defined by assembly, while the C portion of
7974554Sbinkertn@umich.edu    # the code will be trying to use 'x'
7984554Sbinkertn@umich.edu    ret = context.TryLink('''
7994554Sbinkertn@umich.edu        asm(".globl _x; _x: .byte 0");
8006121Snate@binkert.org        extern int x;
8014554Sbinkertn@umich.edu        int main() { return x; }
8024554Sbinkertn@umich.edu        ''', extension=".c")
8034554Sbinkertn@umich.edu    context.env.Append(LEADING_UNDERSCORE=ret)
8044781Snate@binkert.org    context.Result(ret)
8054554Sbinkertn@umich.edu    return ret
8064554Sbinkertn@umich.edu
8072667Sstever@eecs.umich.edu# Add a custom Check function to test for structure members.
8084554Sbinkertn@umich.edudef CheckMember(context, include, decl, member, include_quotes="<>"):
8094554Sbinkertn@umich.edu    context.Message("Checking for member %s in %s..." %
8104554Sbinkertn@umich.edu                    (member, decl))
8114554Sbinkertn@umich.edu    text = """
8122667Sstever@eecs.umich.edu#include %(header)s
8134554Sbinkertn@umich.eduint main(){
8142667Sstever@eecs.umich.edu  %(decl)s test;
8154554Sbinkertn@umich.edu  (void)test.%(member)s;
8166121Snate@binkert.org  return 0;
8172667Sstever@eecs.umich.edu};
8185522Snate@binkert.org""" % { "header" : include_quotes[0] + include + include_quotes[1],
8195522Snate@binkert.org        "decl" : decl,
8205522Snate@binkert.org        "member" : member,
8215522Snate@binkert.org        }
8225522Snate@binkert.org
8235522Snate@binkert.org    ret = context.TryCompile(text, extension=".cc")
8245522Snate@binkert.org    context.Result(ret)
8255522Snate@binkert.org    return ret
8265522Snate@binkert.org
8275522Snate@binkert.org# Platform-specific configuration.  Note again that we assume that all
8285522Snate@binkert.org# builds under a given build root run on the same host platform.
8295522Snate@binkert.orgconf = Configure(main,
8305522Snate@binkert.org                 conf_dir = joinpath(build_root, '.scons_config'),
8315522Snate@binkert.org                 log_file = joinpath(build_root, 'scons_config.log'),
8325522Snate@binkert.org                 custom_tests = {
8335522Snate@binkert.org        'CheckLeading' : CheckLeading,
8345522Snate@binkert.org        'CheckMember' : CheckMember,
8355522Snate@binkert.org        })
8365522Snate@binkert.org
8375522Snate@binkert.org# Check for leading underscores.  Don't really need to worry either
8385522Snate@binkert.org# way so don't need to check the return code.
8395522Snate@binkert.orgconf.CheckLeading()
8405522Snate@binkert.org
8415522Snate@binkert.org# Check if we should compile a 64 bit binary on Mac OS X/Darwin
8425522Snate@binkert.orgtry:
8435522Snate@binkert.org    import platform
8449986Sandreas@sandberg.pp.se    uname = platform.uname()
8459986Sandreas@sandberg.pp.se    if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0:
8469986Sandreas@sandberg.pp.se        if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
8479986Sandreas@sandberg.pp.se            main.Append(CCFLAGS=['-arch', 'x86_64'])
8489986Sandreas@sandberg.pp.se            main.Append(CFLAGS=['-arch', 'x86_64'])
8499986Sandreas@sandberg.pp.se            main.Append(LINKFLAGS=['-arch', 'x86_64'])
8509986Sandreas@sandberg.pp.se            main.Append(ASFLAGS=['-arch', 'x86_64'])
8519986Sandreas@sandberg.pp.seexcept:
8529986Sandreas@sandberg.pp.se    pass
8539986Sandreas@sandberg.pp.se
8549986Sandreas@sandberg.pp.se# Recent versions of scons substitute a "Null" object for Configure()
8559986Sandreas@sandberg.pp.se# when configuration isn't necessary, e.g., if the "--help" option is
8569986Sandreas@sandberg.pp.se# present.  Unfortuantely this Null object always returns false,
8579986Sandreas@sandberg.pp.se# breaking all our configuration checks.  We replace it with our own
8589986Sandreas@sandberg.pp.se# more optimistic null object that returns True instead.
8599986Sandreas@sandberg.pp.seif not conf:
8609986Sandreas@sandberg.pp.se    def NullCheck(*args, **kwargs):
8619986Sandreas@sandberg.pp.se        return True
8629986Sandreas@sandberg.pp.se
8639986Sandreas@sandberg.pp.se    class NullConf:
8642638Sstever@eecs.umich.edu        def __init__(self, env):
8652638Sstever@eecs.umich.edu            self.env = env
8666121Snate@binkert.org        def Finish(self):
8673716Sstever@eecs.umich.edu            return self.env
8685522Snate@binkert.org        def __getattr__(self, mname):
8699986Sandreas@sandberg.pp.se            return NullCheck
8709986Sandreas@sandberg.pp.se
8719986Sandreas@sandberg.pp.se    conf = NullConf(main)
8729986Sandreas@sandberg.pp.se
8735522Snate@binkert.org# Cache build files in the supplied directory.
8745522Snate@binkert.orgif main['M5_BUILD_CACHE']:
8755522Snate@binkert.org    print 'Using build cache located at', main['M5_BUILD_CACHE']
8765522Snate@binkert.org    CacheDir(main['M5_BUILD_CACHE'])
8771858SN/A
8785227Ssaidi@eecs.umich.edu# Find Python include and library directories for embedding the
8795227Ssaidi@eecs.umich.edu# interpreter. We rely on python-config to resolve the appropriate
8805227Ssaidi@eecs.umich.edu# includes and linker flags. ParseConfig does not seem to understand
8815227Ssaidi@eecs.umich.edu# the more exotic linker flags such as -Xlinker and -export-dynamic so
8826654Snate@binkert.org# we add them explicitly below. If you want to link in an alternate
8836654Snate@binkert.org# version of python, see above for instructions on how to invoke
8847769SAli.Saidi@ARM.com# scons with the appropriate PATH set.
8857769SAli.Saidi@ARM.com#
8867769SAli.Saidi@ARM.com# First we check if python2-config exists, else we use python-config
8877769SAli.Saidi@ARM.compython_config = readCommand(['which', 'python2-config'], exception='').strip()
8885227Ssaidi@eecs.umich.eduif not os.path.exists(python_config):
8895227Ssaidi@eecs.umich.edu    python_config = readCommand(['which', 'python-config'],
8905227Ssaidi@eecs.umich.edu                                exception='').strip()
8915204Sstever@gmail.compy_includes = readCommand([python_config, '--includes'],
8925204Sstever@gmail.com                          exception='').split()
8935204Sstever@gmail.com# Strip the -I from the include folders before adding them to the
8945204Sstever@gmail.com# CPPPATH
8955204Sstever@gmail.commain.Append(CPPPATH=map(lambda inc: inc[2:], py_includes))
8965204Sstever@gmail.com
8975204Sstever@gmail.com# Read the linker flags and split them into libraries and other link
8985204Sstever@gmail.com# flags. The libraries are added later through the call the CheckLib.
8995204Sstever@gmail.compy_ld_flags = readCommand([python_config, '--ldflags'], exception='').split()
9005204Sstever@gmail.compy_libs = []
9015204Sstever@gmail.comfor lib in py_ld_flags:
9025204Sstever@gmail.com     if not lib.startswith('-l'):
9035204Sstever@gmail.com         main.Append(LINKFLAGS=[lib])
9045204Sstever@gmail.com     else:
9055204Sstever@gmail.com         lib = lib[2:]
9065204Sstever@gmail.com         if lib not in py_libs:
9075204Sstever@gmail.com             py_libs.append(lib)
9086121Snate@binkert.org
9095204Sstever@gmail.com# verify that this stuff works
9107727SAli.Saidi@ARM.comif not conf.CheckHeader('Python.h', '<>'):
9117727SAli.Saidi@ARM.com    print "Error: can't find Python.h header in", py_includes
9127727SAli.Saidi@ARM.com    print "Install Python headers (package python-dev on Ubuntu and RedHat)"
9137727SAli.Saidi@ARM.com    Exit(1)
9147727SAli.Saidi@ARM.com
91510453SAndrew.Bardsley@arm.comfor lib in py_libs:
91610453SAndrew.Bardsley@arm.com    if not conf.CheckLib(lib):
91710453SAndrew.Bardsley@arm.com        print "Error: can't find library %s required by python" % lib
91810453SAndrew.Bardsley@arm.com        Exit(1)
91910453SAndrew.Bardsley@arm.com
92010453SAndrew.Bardsley@arm.com# On Solaris you need to use libsocket for socket ops
92110453SAndrew.Bardsley@arm.comif not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
92210453SAndrew.Bardsley@arm.com   if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
92310453SAndrew.Bardsley@arm.com       print "Can't find library with socket calls (e.g. accept())"
92410453SAndrew.Bardsley@arm.com       Exit(1)
92510453SAndrew.Bardsley@arm.com
92610160Sandreas.hansson@arm.com# Check for zlib.  If the check passes, libz will be automatically
92710453SAndrew.Bardsley@arm.com# added to the LIBS environment variable.
92810453SAndrew.Bardsley@arm.comif not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
92910453SAndrew.Bardsley@arm.com    print 'Error: did not find needed zlib compression library '\
93010453SAndrew.Bardsley@arm.com          'and/or zlib.h header file.'
93110453SAndrew.Bardsley@arm.com    print '       Please install zlib and try again.'
93210453SAndrew.Bardsley@arm.com    Exit(1)
93310453SAndrew.Bardsley@arm.com
93410453SAndrew.Bardsley@arm.com# If we have the protobuf compiler, also make sure we have the
9359812Sandreas.hansson@arm.com# development libraries. If the check passes, libprotobuf will be
93610453SAndrew.Bardsley@arm.com# automatically added to the LIBS environment variable. After
93710453SAndrew.Bardsley@arm.com# this, we can use the HAVE_PROTOBUF flag to determine if we have
93810453SAndrew.Bardsley@arm.com# got both protoc and libprotobuf available.
93910453SAndrew.Bardsley@arm.commain['HAVE_PROTOBUF'] = main['PROTOC'] and \
94010453SAndrew.Bardsley@arm.com    conf.CheckLibWithHeader('protobuf', 'google/protobuf/message.h',
94110453SAndrew.Bardsley@arm.com                            'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;')
94210453SAndrew.Bardsley@arm.com
94310453SAndrew.Bardsley@arm.com# If we have the compiler but not the library, print another warning.
94410453SAndrew.Bardsley@arm.comif main['PROTOC'] and not main['HAVE_PROTOBUF']:
94510453SAndrew.Bardsley@arm.com    print termcap.Yellow + termcap.Bold + \
94610453SAndrew.Bardsley@arm.com        'Warning: did not find protocol buffer library and/or headers.\n' + \
94710453SAndrew.Bardsley@arm.com    '       Please install libprotobuf-dev for tracing support.' + \
9487727SAli.Saidi@ARM.com    termcap.Normal
94910453SAndrew.Bardsley@arm.com
95010453SAndrew.Bardsley@arm.com# Check for librt.
95110453SAndrew.Bardsley@arm.comhave_posix_clock = \
95210453SAndrew.Bardsley@arm.com    conf.CheckLibWithHeader(None, 'time.h', 'C',
95310453SAndrew.Bardsley@arm.com                            'clock_nanosleep(0,0,NULL,NULL);') or \
9543118Sstever@eecs.umich.edu    conf.CheckLibWithHeader('rt', 'time.h', 'C',
95510453SAndrew.Bardsley@arm.com                            'clock_nanosleep(0,0,NULL,NULL);')
95610453SAndrew.Bardsley@arm.com
95710453SAndrew.Bardsley@arm.comhave_posix_timers = \
95810453SAndrew.Bardsley@arm.com    conf.CheckLibWithHeader([None, 'rt'], [ 'time.h', 'signal.h' ], 'C',
9593118Sstever@eecs.umich.edu                            'timer_create(CLOCK_MONOTONIC, NULL, NULL);')
9603483Ssaidi@eecs.umich.edu
9613494Ssaidi@eecs.umich.eduif conf.CheckLib('tcmalloc'):
9623494Ssaidi@eecs.umich.edu    main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS'])
9633483Ssaidi@eecs.umich.eduelif conf.CheckLib('tcmalloc_minimal'):
9643483Ssaidi@eecs.umich.edu    main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS'])
9653483Ssaidi@eecs.umich.eduelse:
9663053Sstever@eecs.umich.edu    print termcap.Yellow + termcap.Bold + \
9673053Sstever@eecs.umich.edu          "You can get a 12% performance improvement by installing tcmalloc "\
9683918Ssaidi@eecs.umich.edu          "(libgoogle-perftools-dev package on Ubuntu or RedHat)." + \
9693053Sstever@eecs.umich.edu          termcap.Normal
9703053Sstever@eecs.umich.edu
9713053Sstever@eecs.umich.eduif not have_posix_clock:
9723053Sstever@eecs.umich.edu    print "Can't find library for POSIX clocks."
9733053Sstever@eecs.umich.edu
9749396Sandreas.hansson@arm.com# Check for <fenv.h> (C99 FP environment control)
9759396Sandreas.hansson@arm.comhave_fenv = conf.CheckHeader('fenv.h', '<>')
9769396Sandreas.hansson@arm.comif not have_fenv:
9779396Sandreas.hansson@arm.com    print "Warning: Header file <fenv.h> not found."
9789396Sandreas.hansson@arm.com    print "         This host has no IEEE FP rounding mode control."
9799396Sandreas.hansson@arm.com
9809396Sandreas.hansson@arm.com# Check if we should enable KVM-based hardware virtualization. The API
9819396Sandreas.hansson@arm.com# we rely on exists since version 2.6.36 of the kernel, but somehow
9829396Sandreas.hansson@arm.com# the KVM_API_VERSION does not reflect the change. We test for one of
9839477Sandreas.hansson@arm.com# the types as a fall back.
9849396Sandreas.hansson@arm.comhave_kvm = conf.CheckHeader('linux/kvm.h', '<>') and \
9859477Sandreas.hansson@arm.com    conf.CheckTypeSize('struct kvm_xsave', '#include <linux/kvm.h>') != 0
9869477Sandreas.hansson@arm.comif not have_kvm:
9879477Sandreas.hansson@arm.com    print "Info: Compatible header file <linux/kvm.h> not found, " \
9889477Sandreas.hansson@arm.com        "disabling KVM support."
9899396Sandreas.hansson@arm.com
9907840Snate@binkert.org# Check if the requested target ISA is compatible with the host
9917865Sgblack@eecs.umich.edudef is_isa_kvm_compatible(isa):
9927865Sgblack@eecs.umich.edu    isa_comp_table = {
9937865Sgblack@eecs.umich.edu        "arm" : ( "armv7l" ),
9947865Sgblack@eecs.umich.edu        "x86" : ( "x86_64" ),
9957865Sgblack@eecs.umich.edu        }
9967840Snate@binkert.org    try:
9979900Sandreas@sandberg.pp.se        import platform
9989900Sandreas@sandberg.pp.se        host_isa = platform.machine()
9999900Sandreas@sandberg.pp.se    except:
10009900Sandreas@sandberg.pp.se        print "Warning: Failed to determine host ISA."
100110456SCurtis.Dunham@arm.com        return False
100210456SCurtis.Dunham@arm.com
100310456SCurtis.Dunham@arm.com    return host_isa in isa_comp_table.get(isa, [])
100410456SCurtis.Dunham@arm.com
100510456SCurtis.Dunham@arm.com
100610456SCurtis.Dunham@arm.com# Check if the exclude_host attribute is available. We want this to
100710456SCurtis.Dunham@arm.com# get accurate instruction counts in KVM.
100810456SCurtis.Dunham@arm.commain['HAVE_PERF_ATTR_EXCLUDE_HOST'] = conf.CheckMember(
100910456SCurtis.Dunham@arm.com    'linux/perf_event.h', 'struct perf_event_attr', 'exclude_host')
101010456SCurtis.Dunham@arm.com
10119045SAli.Saidi@ARM.com
10127840Snate@binkert.org######################################################################
10137840Snate@binkert.org#
10147840Snate@binkert.org# Finish the configuration
10151858SN/A#
10161858SN/Amain = conf.Finish()
10171858SN/A
10181858SN/A######################################################################
10191858SN/A#
10201858SN/A# Collect all non-global variables
10219903Sandreas.hansson@arm.com#
10229903Sandreas.hansson@arm.com
10239903Sandreas.hansson@arm.com# Define the universe of supported ISAs
10249903Sandreas.hansson@arm.comall_isa_list = [ ]
102510841Sandreas.sandberg@arm.comExport('all_isa_list')
10269651SAndreas.Sandberg@ARM.com
10279903Sandreas.hansson@arm.comclass CpuModel(object):
10289651SAndreas.Sandberg@ARM.com    '''The CpuModel class encapsulates everything the ISA parser needs to
10299651SAndreas.Sandberg@ARM.com    know about a particular CPU model.'''
103010841Sandreas.sandberg@arm.com
103110841Sandreas.sandberg@arm.com    # Dict of available CPU model objects.  Accessible as CpuModel.dict.
103210841Sandreas.sandberg@arm.com    dict = {}
103310841Sandreas.sandberg@arm.com
103410841Sandreas.sandberg@arm.com    # Constructor.  Automatically adds models to CpuModel.dict.
103510841Sandreas.sandberg@arm.com    def __init__(self, name, default=False):
10369651SAndreas.Sandberg@ARM.com        self.name = name           # name of model
10379651SAndreas.Sandberg@ARM.com
10389651SAndreas.Sandberg@ARM.com        # This cpu is enabled by default
10399651SAndreas.Sandberg@ARM.com        self.default = default
10409651SAndreas.Sandberg@ARM.com
10419651SAndreas.Sandberg@ARM.com        # Add self to dict
10429651SAndreas.Sandberg@ARM.com        if name in CpuModel.dict:
10439651SAndreas.Sandberg@ARM.com            raise AttributeError, "CpuModel '%s' already registered" % name
10449651SAndreas.Sandberg@ARM.com        CpuModel.dict[name] = self
104510841Sandreas.sandberg@arm.com
104610841Sandreas.sandberg@arm.comExport('CpuModel')
104710841Sandreas.sandberg@arm.com
104810841Sandreas.sandberg@arm.com# Sticky variables get saved in the variables file so they persist from
104910841Sandreas.sandberg@arm.com# one invocation to the next (unless overridden, in which case the new
105010841Sandreas.sandberg@arm.com# value becomes sticky).
105110841Sandreas.sandberg@arm.comsticky_vars = Variables(args=ARGUMENTS)
105210841Sandreas.sandberg@arm.comExport('sticky_vars')
105310841Sandreas.sandberg@arm.com
105410841Sandreas.sandberg@arm.com# Sticky variables that should be exported
105510841Sandreas.sandberg@arm.comexport_vars = []
105610841Sandreas.sandberg@arm.comExport('export_vars')
105710841Sandreas.sandberg@arm.com
105810841Sandreas.sandberg@arm.com# For Ruby
105910841Sandreas.sandberg@arm.comall_protocols = []
106010841Sandreas.sandberg@arm.comExport('all_protocols')
106110841Sandreas.sandberg@arm.comprotocol_dirs = []
106210841Sandreas.sandberg@arm.comExport('protocol_dirs')
10639651SAndreas.Sandberg@ARM.comslicc_includes = []
10649651SAndreas.Sandberg@ARM.comExport('slicc_includes')
10659986Sandreas@sandberg.pp.se
10669986Sandreas@sandberg.pp.se# Walk the tree and execute all SConsopts scripts that wil add to the
10679986Sandreas@sandberg.pp.se# above variables
10689986Sandreas@sandberg.pp.seif GetOption('verbose'):
10699986Sandreas@sandberg.pp.se    print "Reading SConsopts"
10709986Sandreas@sandberg.pp.sefor bdir in [ base_dir ] + extras_dir_list:
10715863Snate@binkert.org    if not isdir(bdir):
10725863Snate@binkert.org        print "Error: directory '%s' does not exist" % bdir
10735863Snate@binkert.org        Exit(1)
10745863Snate@binkert.org    for root, dirs, files in os.walk(bdir):
10756121Snate@binkert.org        if 'SConsopts' in files:
10761858SN/A            if GetOption('verbose'):
10775863Snate@binkert.org                print "Reading", joinpath(root, 'SConsopts')
10785863Snate@binkert.org            SConscript(joinpath(root, 'SConsopts'))
10795863Snate@binkert.org
10805863Snate@binkert.orgall_isa_list.sort()
10815863Snate@binkert.org
10822139SN/Asticky_vars.AddVariables(
10834202Sbinkertn@umich.edu    EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list),
10844202Sbinkertn@umich.edu    ListVariable('CPU_MODELS', 'CPU models',
10852139SN/A                 sorted(n for n,m in CpuModel.dict.iteritems() if m.default),
10866994Snate@binkert.org                 sorted(CpuModel.dict.keys())),
10876994Snate@binkert.org    BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
10886994Snate@binkert.org                 False),
10896994Snate@binkert.org    BoolVariable('SS_COMPATIBLE_FP',
10906994Snate@binkert.org                 'Make floating-point results compatible with SimpleScalar',
10916994Snate@binkert.org                 False),
10926994Snate@binkert.org    BoolVariable('USE_SSE2',
10936994Snate@binkert.org                 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
109410319SAndreas.Sandberg@ARM.com                 False),
10956994Snate@binkert.org    BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock),
10966994Snate@binkert.org    BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
10976994Snate@binkert.org    BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False),
10986994Snate@binkert.org    BoolVariable('USE_KVM', 'Enable hardware virtualized (KVM) CPU models', have_kvm),
10996994Snate@binkert.org    EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None',
11006994Snate@binkert.org                  all_protocols),
11016994Snate@binkert.org    )
11026994Snate@binkert.org
11036994Snate@binkert.org# These variables get exported to #defines in config/*.hh (see src/SConscript).
11046994Snate@binkert.orgexport_vars += ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'CP_ANNOTATE',
11056994Snate@binkert.org                'USE_POSIX_CLOCK', 'PROTOCOL', 'HAVE_PROTOBUF',
11062155SN/A                'HAVE_PERF_ATTR_EXCLUDE_HOST']
11075863Snate@binkert.org
11081869SN/A###################################################
11091869SN/A#
11105863Snate@binkert.org# Define a SCons builder for configuration flag headers.
11115863Snate@binkert.org#
11124202Sbinkertn@umich.edu###################################################
11136108Snate@binkert.org
11146108Snate@binkert.org# This function generates a config header file that #defines the
11156108Snate@binkert.org# variable symbol to the current variable setting (0 or 1).  The source
11166108Snate@binkert.org# operands are the name of the variable and a Value node containing the
11179219Spower.jg@gmail.com# value of the variable.
11189219Spower.jg@gmail.comdef build_config_file(target, source, env):
11199219Spower.jg@gmail.com    (variable, value) = [s.get_contents() for s in source]
11209219Spower.jg@gmail.com    f = file(str(target[0]), 'w')
11219219Spower.jg@gmail.com    print >> f, '#define', variable, value
11229219Spower.jg@gmail.com    f.close()
11239219Spower.jg@gmail.com    return None
11249219Spower.jg@gmail.com
11254202Sbinkertn@umich.edu# Combine the two functions into a scons Action object.
11265863Snate@binkert.orgconfig_action = MakeAction(build_config_file, Transform("CONFIG H", 2))
112710135SCurtis.Dunham@arm.com
11288474Sgblack@eecs.umich.edu# The emitter munges the source & target node lists to reflect what
11295742Snate@binkert.org# we're really doing.
11308268Ssteve.reinhardt@amd.comdef config_emitter(target, source, env):
11318268Ssteve.reinhardt@amd.com    # extract variable name from Builder arg
11328268Ssteve.reinhardt@amd.com    variable = str(target[0])
11335742Snate@binkert.org    # True target is config header file
11345341Sstever@gmail.com    target = joinpath('config', variable.lower() + '.hh')
11358474Sgblack@eecs.umich.edu    val = env[variable]
11368474Sgblack@eecs.umich.edu    if isinstance(val, bool):
11375342Sstever@gmail.com        # Force value to 0/1
11384202Sbinkertn@umich.edu        val = int(val)
11394202Sbinkertn@umich.edu    elif isinstance(val, str):
11404202Sbinkertn@umich.edu        val = '"' + val + '"'
11415863Snate@binkert.org
11425863Snate@binkert.org    # Sources are variable name & value (packaged in SCons Value nodes)
11436994Snate@binkert.org    return ([target], [Value(variable), Value(val)])
11446994Snate@binkert.org
114510319SAndreas.Sandberg@ARM.comconfig_builder = Builder(emitter = config_emitter, action = config_action)
11465863Snate@binkert.org
11475863Snate@binkert.orgmain.Append(BUILDERS = { 'ConfigFile' : config_builder })
11485863Snate@binkert.org
11495863Snate@binkert.org# libelf build is shared across all configs in the build root.
11505863Snate@binkert.orgmain.SConscript('ext/libelf/SConscript',
11515863Snate@binkert.org                variant_dir = joinpath(build_root, 'libelf'))
11525863Snate@binkert.org
11535863Snate@binkert.org# gzstream build is shared across all configs in the build root.
11547840Snate@binkert.orgmain.SConscript('ext/gzstream/SConscript',
11555863Snate@binkert.org                variant_dir = joinpath(build_root, 'gzstream'))
11565952Ssaidi@eecs.umich.edu
11579651SAndreas.Sandberg@ARM.com# libfdt build is shared across all configs in the build root.
11589219Spower.jg@gmail.commain.SConscript('ext/libfdt/SConscript',
11599219Spower.jg@gmail.com                variant_dir = joinpath(build_root, 'libfdt'))
11601869SN/A
11611858SN/A# fputils build is shared across all configs in the build root.
11625863Snate@binkert.orgmain.SConscript('ext/fputils/SConscript',
11639420Sandreas.hansson@arm.com                variant_dir = joinpath(build_root, 'fputils'))
116410607Sgabeblack@google.com
11659986Sandreas@sandberg.pp.se# DRAMSim2 build is shared across all configs in the build root.
11661858SN/Amain.SConscript('ext/dramsim2/SConscript',
1167955SN/A                variant_dir = joinpath(build_root, 'dramsim2'))
1168955SN/A
11691869SN/A###################################################
11701869SN/A#
11711869SN/A# This function is used to set up a directory with switching headers
11721869SN/A#
11731869SN/A###################################################
11745863Snate@binkert.org
11755863Snate@binkert.orgmain['ALL_ISA_LIST'] = all_isa_list
11765863Snate@binkert.orgall_isa_deps = {}
11771869SN/Adef make_switching_dir(dname, switch_headers, env):
11785863Snate@binkert.org    # Generate the header.  target[0] is the full path of the output
11791869SN/A    # header to generate.  'source' is a dummy variable, since we get the
11805863Snate@binkert.org    # list of ISAs from env['ALL_ISA_LIST'].
11811869SN/A    def gen_switch_hdr(target, source, env):
11821869SN/A        fname = str(target[0])
11831869SN/A        isa = env['TARGET_ISA'].lower()
11841869SN/A        try:
11858483Sgblack@eecs.umich.edu            f = open(fname, 'w')
11861869SN/A            print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname))
11871869SN/A            f.close()
11881869SN/A        except IOError:
11891869SN/A            print "Failed to create %s" % fname
11905863Snate@binkert.org            raise
11915863Snate@binkert.org
11921869SN/A    # Build SCons Action object. 'varlist' specifies env vars that this
11935863Snate@binkert.org    # action depends on; when env['ALL_ISA_LIST'] changes these actions
11945863Snate@binkert.org    # should get re-executed.
11953356Sbinkertn@umich.edu    switch_hdr_action = MakeAction(gen_switch_hdr,
11963356Sbinkertn@umich.edu                          Transform("GENERATE"), varlist=['ALL_ISA_LIST'])
11973356Sbinkertn@umich.edu
11983356Sbinkertn@umich.edu    # Instantiate actions for each header
11993356Sbinkertn@umich.edu    for hdr in switch_headers:
12004781Snate@binkert.org        env.Command(hdr, [], switch_hdr_action)
12015863Snate@binkert.org
12025863Snate@binkert.org    isa_target = Dir('.').up().name.lower().replace('_', '-')
12031869SN/A    env['PHONY_BASE'] = '#'+isa_target
12041869SN/A    all_isa_deps[isa_target] = None
12051869SN/A
12066121Snate@binkert.orgExport('make_switching_dir')
12071869SN/A
12082638Sstever@eecs.umich.edu# all-isas -> all-deps -> all-environs -> all_targets
12096121Snate@binkert.orgmain.Alias('#all-isas', [])
12106121Snate@binkert.orgmain.Alias('#all-deps', '#all-isas')
12112638Sstever@eecs.umich.edu
12125749Scws3k@cs.virginia.edu# Dummy target to ensure all environments are created before telling
12136121Snate@binkert.org# SCons what to actually make (the command line arguments).  We attach
12146121Snate@binkert.org# them to the dependence graph after the environments are complete.
12155749Scws3k@cs.virginia.eduORIG_BUILD_TARGETS = list(BUILD_TARGETS) # force a copy; gets closure to work.
12169537Satgutier@umich.edudef environsComplete(target, source, env):
12179537Satgutier@umich.edu    for t in ORIG_BUILD_TARGETS:
12189537Satgutier@umich.edu        main.Depends('#all-targets', t)
12199537Satgutier@umich.edu
12209888Sandreas@sandberg.pp.se# Each build/* switching_dir attaches its *-environs target to #all-environs.
12219888Sandreas@sandberg.pp.semain.Append(BUILDERS = {'CompleteEnvirons' :
12229888Sandreas@sandberg.pp.se                        Builder(action=MakeAction(environsComplete, None))})
12239888Sandreas@sandberg.pp.semain.CompleteEnvirons('#all-environs', [])
122410066Sandreas.hansson@arm.com
122510066Sandreas.hansson@arm.comdef doNothing(**ignored): pass
122610066Sandreas.hansson@arm.commain.Append(BUILDERS = {'Dummy': Builder(action=MakeAction(doNothing, None))})
122710066Sandreas.hansson@arm.com
122810428Sandreas.hansson@arm.com# The final target to which all the original targets ultimately get attached.
122910428Sandreas.hansson@arm.commain.Dummy('#all-targets', '#all-environs')
123010428Sandreas.hansson@arm.comBUILD_TARGETS[:] = ['#all-targets']
123110428Sandreas.hansson@arm.com
12321869SN/A###################################################
12331869SN/A#
12343546Sgblack@eecs.umich.edu# Define build environments for selected configurations.
12353546Sgblack@eecs.umich.edu#
12363546Sgblack@eecs.umich.edu###################################################
12373546Sgblack@eecs.umich.edu
12386121Snate@binkert.orgfor variant_path in variant_paths:
123910196SCurtis.Dunham@arm.com    if not GetOption('silent'):
12405863Snate@binkert.org        print "Building in", variant_path
12413546Sgblack@eecs.umich.edu
12423546Sgblack@eecs.umich.edu    # Make a copy of the build-root environment to use for this config.
12433546Sgblack@eecs.umich.edu    env = main.Clone()
12443546Sgblack@eecs.umich.edu    env['BUILDDIR'] = variant_path
12454781Snate@binkert.org
12466658Snate@binkert.org    # variant_dir is the tail component of build path, and is used to
124710196SCurtis.Dunham@arm.com    # determine the build parameters (e.g., 'ALPHA_SE')
124810196SCurtis.Dunham@arm.com    (build_root, variant_dir) = splitpath(variant_path)
124910196SCurtis.Dunham@arm.com
125010196SCurtis.Dunham@arm.com    # Set env variables according to the build directory config.
125110196SCurtis.Dunham@arm.com    sticky_vars.files = []
125210196SCurtis.Dunham@arm.com    # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
125310196SCurtis.Dunham@arm.com    # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
12543546Sgblack@eecs.umich.edu    # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
12553546Sgblack@eecs.umich.edu    current_vars_file = joinpath(build_root, 'variables', variant_dir)
12563546Sgblack@eecs.umich.edu    if isfile(current_vars_file):
12573546Sgblack@eecs.umich.edu        sticky_vars.files.append(current_vars_file)
12587756SAli.Saidi@ARM.com        if not GetOption('silent'):
12597816Ssteve.reinhardt@amd.com            print "Using saved variables file %s" % current_vars_file
12603546Sgblack@eecs.umich.edu    else:
12613546Sgblack@eecs.umich.edu        # Build dir-specific variables file doesn't exist.
12623546Sgblack@eecs.umich.edu
12633546Sgblack@eecs.umich.edu        # Make sure the directory is there so we can create it later
126410196SCurtis.Dunham@arm.com        opt_dir = dirname(current_vars_file)
126510196SCurtis.Dunham@arm.com        if not isdir(opt_dir):
126610196SCurtis.Dunham@arm.com            mkdir(opt_dir)
126710196SCurtis.Dunham@arm.com
126810196SCurtis.Dunham@arm.com        # Get default build variables from source tree.  Variables are
12694202Sbinkertn@umich.edu        # normally determined by name of $VARIANT_DIR, but can be
12703546Sgblack@eecs.umich.edu        # overridden by '--default=' arg on command line.
127110196SCurtis.Dunham@arm.com        default = GetOption('default')
127210196SCurtis.Dunham@arm.com        opts_dir = joinpath(main.root.abspath, 'build_opts')
127310196SCurtis.Dunham@arm.com        if default:
127410196SCurtis.Dunham@arm.com            default_vars_files = [joinpath(build_root, 'variables', default),
127510196SCurtis.Dunham@arm.com                                  joinpath(opts_dir, default)]
127610196SCurtis.Dunham@arm.com        else:
127710196SCurtis.Dunham@arm.com            default_vars_files = [joinpath(opts_dir, variant_dir)]
127810196SCurtis.Dunham@arm.com        existing_files = filter(isfile, default_vars_files)
127910196SCurtis.Dunham@arm.com        if existing_files:
128010196SCurtis.Dunham@arm.com            default_vars_file = existing_files[0]
128110196SCurtis.Dunham@arm.com            sticky_vars.files.append(default_vars_file)
128210196SCurtis.Dunham@arm.com            print "Variables file %s not found,\n  using defaults in %s" \
128310196SCurtis.Dunham@arm.com                  % (current_vars_file, default_vars_file)
128410196SCurtis.Dunham@arm.com        else:
128510196SCurtis.Dunham@arm.com            print "Error: cannot find variables file %s or " \
128610196SCurtis.Dunham@arm.com                  "default file(s) %s" \
128710196SCurtis.Dunham@arm.com                  % (current_vars_file, ' or '.join(default_vars_files))
128810196SCurtis.Dunham@arm.com            Exit(1)
128910196SCurtis.Dunham@arm.com
129010196SCurtis.Dunham@arm.com    # Apply current variable settings to env
129110196SCurtis.Dunham@arm.com    sticky_vars.Update(env)
129210196SCurtis.Dunham@arm.com
129310196SCurtis.Dunham@arm.com    help_texts["local_vars"] += \
129410196SCurtis.Dunham@arm.com        "Build variables for %s:\n" % variant_dir \
12953546Sgblack@eecs.umich.edu                 + sticky_vars.GenerateHelpText(env)
12963546Sgblack@eecs.umich.edu
1297955SN/A    # Process variable settings.
1298955SN/A
1299955SN/A    if not have_fenv and env['USE_FENV']:
1300955SN/A        print "Warning: <fenv.h> not available; " \
13015863Snate@binkert.org              "forcing USE_FENV to False in", variant_dir + "."
130210135SCurtis.Dunham@arm.com        env['USE_FENV'] = False
130310135SCurtis.Dunham@arm.com
13045343Sstever@gmail.com    if not env['USE_FENV']:
13055343Sstever@gmail.com        print "Warning: No IEEE FP rounding mode control in", variant_dir + "."
13066121Snate@binkert.org        print "         FP results may deviate slightly from other platforms."
13075863Snate@binkert.org
13084773Snate@binkert.org    if env['EFENCE']:
13095863Snate@binkert.org        env.Append(LIBS=['efence'])
13102632Sstever@eecs.umich.edu
13115863Snate@binkert.org    if env['USE_KVM']:
13122023SN/A        if not have_kvm:
13135863Snate@binkert.org            print "Warning: Can not enable KVM, host seems to lack KVM support"
13145863Snate@binkert.org            env['USE_KVM'] = False
13155863Snate@binkert.org        elif not have_posix_timers:
13165863Snate@binkert.org            print "Warning: Can not enable KVM, host seems to lack support " \
13175863Snate@binkert.org                "for POSIX timers"
13185863Snate@binkert.org            env['USE_KVM'] = False
13195863Snate@binkert.org        elif not is_isa_kvm_compatible(env['TARGET_ISA']):
13205863Snate@binkert.org            print "Info: KVM support disabled due to unsupported host and " \
132110135SCurtis.Dunham@arm.com                "target ISA combination"
132210135SCurtis.Dunham@arm.com            env['USE_KVM'] = False
13232632Sstever@eecs.umich.edu
13245863Snate@binkert.org    # Warn about missing optional functionality
13252023SN/A    if env['USE_KVM']:
13262632Sstever@eecs.umich.edu        if not main['HAVE_PERF_ATTR_EXCLUDE_HOST']:
13275863Snate@binkert.org            print "Warning: perf_event headers lack support for the " \
13285342Sstever@gmail.com                "exclude_host attribute. KVM instruction counts will " \
13295863Snate@binkert.org                "be inaccurate."
13302632Sstever@eecs.umich.edu
13315863Snate@binkert.org    # Save sticky variable settings back to current variables file
13325863Snate@binkert.org    sticky_vars.Save(current_vars_file, env)
13338267Ssteve.reinhardt@amd.com
13348120Sgblack@eecs.umich.edu    if env['USE_SSE2']:
13358267Ssteve.reinhardt@amd.com        env.Append(CCFLAGS=['-msse2'])
13368267Ssteve.reinhardt@amd.com
13378267Ssteve.reinhardt@amd.com    # The src/SConscript file sets up the build rules in 'env' according
13388267Ssteve.reinhardt@amd.com    # to the configured variables.  It returns a list of environments,
13398267Ssteve.reinhardt@amd.com    # one for each variant build (debug, opt, etc.)
13408267Ssteve.reinhardt@amd.com    SConscript('src/SConscript', variant_dir = variant_path, exports = 'env')
13418267Ssteve.reinhardt@amd.com
13428267Ssteve.reinhardt@amd.comdef pairwise(iterable):
13438267Ssteve.reinhardt@amd.com    "s -> (s0,s1), (s1,s2), (s2, s3), ..."
13445863Snate@binkert.org    a, b = itertools.tee(iterable)
13455863Snate@binkert.org    b.next()
13465863Snate@binkert.org    return itertools.izip(a, b)
13472632Sstever@eecs.umich.edu
13488267Ssteve.reinhardt@amd.com# Create false dependencies so SCons will parse ISAs, establish
13498267Ssteve.reinhardt@amd.com# dependencies, and setup the build Environments serially. Either
13508267Ssteve.reinhardt@amd.com# SCons (likely) and/or our SConscripts (possibly) cannot cope with -j
13512632Sstever@eecs.umich.edu# greater than 1. It appears to be standard race condition stuff; it
13521888SN/A# doesn't always fail, but usually, and the behaviors are different.
13535863Snate@binkert.org# Every time I tried to remove this, builds would fail in some
13545863Snate@binkert.org# creative new way. So, don't do that. You'll want to, though, because
13551858SN/A# tests/SConscript takes a long time to make its Environments.
13568120Sgblack@eecs.umich.edufor t1, t2 in pairwise(sorted(all_isa_deps.iterkeys())):
13578120Sgblack@eecs.umich.edu    main.Depends('#%s-deps'     % t2, '#%s-deps'     % t1)
13587756SAli.Saidi@ARM.com    main.Depends('#%s-environs' % t2, '#%s-environs' % t1)
13592598SN/A
13605863Snate@binkert.org# base help text
13611858SN/AHelp('''
13621858SN/AUsage: scons [scons options] [build variables] [target(s)]
13631858SN/A
13645863Snate@binkert.orgExtra scons options:
13651858SN/A%(options)s
13661858SN/A
13671858SN/AGlobal build variables:
13685863Snate@binkert.org%(global_vars)s
13691871SN/A
13701858SN/A%(local_vars)s
13711858SN/A''' % help_texts)
13721858SN/A