SConstruct revision 11293
1955SN/A# -*- mode:python -*-
2955SN/A
310841Sandreas.sandberg@arm.com# Copyright (c) 2013, 2015 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('--with-cxx-config', dest='with_cxx_config',
17710458Sandreas.hansson@arm.com               action='store_true',
17810458Sandreas.hansson@arm.com               help="Build with support for C++-based configuration")
1798879Ssteve.reinhardt@amd.comAddLocalOption('--default', dest='default', type='string', action='store',
1808879Ssteve.reinhardt@amd.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')
1839227Sandreas.hansson@arm.comAddLocalOption('--no-lto', dest='no_lto', action='store_true',
1849227Sandreas.hansson@arm.com               help='Disable Link-Time Optimization for fast')
1858879Ssteve.reinhardt@amd.comAddLocalOption('--update-ref', dest='update_ref', action='store_true',
1868879Ssteve.reinhardt@amd.com               help='Update test reference outputs')
1878879Ssteve.reinhardt@amd.comAddLocalOption('--verbose', dest='verbose', action='store_true',
1888879Ssteve.reinhardt@amd.com               help='Print full tool command lines')
18910453SAndrew.Bardsley@arm.comAddLocalOption('--without-python', dest='without_python',
19010453SAndrew.Bardsley@arm.com               action='store_true',
19110453SAndrew.Bardsley@arm.com               help='Build without Python configuration support')
19210456SCurtis.Dunham@arm.comAddLocalOption('--without-tcmalloc', dest='without_tcmalloc',
19310456SCurtis.Dunham@arm.com               action='store_true',
19410456SCurtis.Dunham@arm.com               help='Disable linking against tcmalloc')
19510457Sandreas.hansson@arm.comAddLocalOption('--with-ubsan', dest='with_ubsan', action='store_true',
19610457Sandreas.hansson@arm.com               help='Build with Undefined Behavior Sanitizer if available')
1978120Sgblack@eecs.umich.edu
1988947Sandreas.hansson@arm.comtermcap = get_termcap(GetOption('use_colors'))
1997816Ssteve.reinhardt@amd.com
2005871Snate@binkert.org########################################################################
2015871Snate@binkert.org#
2026121Snate@binkert.org# Set up the main build environment.
2035871Snate@binkert.org#
2045871Snate@binkert.org########################################################################
2059926Sstan.czerniawski@arm.com
2069926Sstan.czerniawski@arm.com# export TERM so that clang reports errors in color
2079119Sandreas.hansson@arm.comuse_vars = set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH',
20810068Sandreas.hansson@arm.com                 'LIBRARY_PATH', 'PATH', 'PKG_CONFIG_PATH', 'PROTOC',
20910068Sandreas.hansson@arm.com                 'PYTHONPATH', 'RANLIB', 'SWIG', 'TERM' ])
210955SN/A
2119416SAndreas.Sandberg@ARM.comuse_prefixes = [
21211212Sjoseph.gross@amd.com    "CCACHE_",         # ccache (caching compiler wrapper) configuration
21311212Sjoseph.gross@amd.com    "CCC_",            # clang static analyzer configuration
21411212Sjoseph.gross@amd.com    "DISTCC_",         # distcc (distributed compiler wrapper) configuration
21511212Sjoseph.gross@amd.com    "INCLUDE_SERVER_", # distcc pump server settings
21611212Sjoseph.gross@amd.com    "M5",              # M5 configuration (e.g., path to kernels)
2179416SAndreas.Sandberg@ARM.com    ]
2189416SAndreas.Sandberg@ARM.com
2195871Snate@binkert.orguse_env = {}
22010584Sandreas.hansson@arm.comfor key,val in sorted(os.environ.iteritems()):
2219416SAndreas.Sandberg@ARM.com    if key in use_vars or \
2229416SAndreas.Sandberg@ARM.com            any([key.startswith(prefix) for prefix in use_prefixes]):
2235871Snate@binkert.org        use_env[key] = val
224955SN/A
22510671Sandreas.hansson@arm.com# Tell scons to avoid implicit command dependencies to avoid issues
22610671Sandreas.hansson@arm.com# with the param wrappes being compiled twice (see
22710671Sandreas.hansson@arm.com# http://scons.tigris.org/issues/show_bug.cgi?id=2811)
22810671Sandreas.hansson@arm.commain = Environment(ENV=use_env, IMPLICIT_COMMAND_DEPENDENCIES=0)
2298881Smarc.orr@gmail.commain.Decider('MD5-timestamp')
2306121Snate@binkert.orgmain.root = Dir(".")         # The current directory (where this file lives).
2316121Snate@binkert.orgmain.srcdir = Dir("src")     # The source directory
2321533SN/A
2339239Sandreas.hansson@arm.commain_dict_keys = main.Dictionary().keys()
2349239Sandreas.hansson@arm.com
2359239Sandreas.hansson@arm.com# Check that we have a C/C++ compiler
2369239Sandreas.hansson@arm.comif not ('CC' in main_dict_keys and 'CXX' in main_dict_keys):
2379239Sandreas.hansson@arm.com    print "No C++ compiler installed (package g++ on Ubuntu and RedHat)"
2389239Sandreas.hansson@arm.com    Exit(1)
2399239Sandreas.hansson@arm.com
2409239Sandreas.hansson@arm.com# Check that swig is present
2419239Sandreas.hansson@arm.comif not 'SWIG' in main_dict_keys:
2429239Sandreas.hansson@arm.com    print "swig is not installed (package swig on Ubuntu and RedHat)"
2439239Sandreas.hansson@arm.com    Exit(1)
2449239Sandreas.hansson@arm.com
2456655Snate@binkert.org# add useful python code PYTHONPATH so it can be used by subprocesses
2466655Snate@binkert.org# as well
2476655Snate@binkert.orgmain.AppendENVPath('PYTHONPATH', extra_python_paths)
2486655Snate@binkert.org
2495871Snate@binkert.org########################################################################
2505871Snate@binkert.org#
2515863Snate@binkert.org# Mercurial Stuff.
2525871Snate@binkert.org#
2538878Ssteve.reinhardt@amd.com# If the gem5 directory is a mercurial repository, we should do some
2545871Snate@binkert.org# extra things.
2555871Snate@binkert.org#
2565871Snate@binkert.org########################################################################
2575863Snate@binkert.org
2586121Snate@binkert.orghgdir = main.root.Dir(".hg")
2595863Snate@binkert.org
2605871Snate@binkert.orgmercurial_style_message = """
2618336Ssteve.reinhardt@amd.comYou're missing the gem5 style hook, which automatically checks your code
2628336Ssteve.reinhardt@amd.comagainst the gem5 style rules on hg commit and qrefresh commands.  This
2638336Ssteve.reinhardt@amd.comscript will now install the hook in your .hg/hgrc file.
2648336Ssteve.reinhardt@amd.comPress enter to continue, or ctrl-c to abort: """
2654678Snate@binkert.org
2668336Ssteve.reinhardt@amd.commercurial_style_hook = """
2678336Ssteve.reinhardt@amd.com# The following lines were automatically added by gem5/SConstruct
2688336Ssteve.reinhardt@amd.com# to provide the gem5 style-checking hooks
2694678Snate@binkert.org[extensions]
2704678Snate@binkert.orgstyle = %s/util/style.py
2714678Snate@binkert.org
2724678Snate@binkert.org[hooks]
2737827Snate@binkert.orgpretxncommit.style = python:style.check_style
2747827Snate@binkert.orgpre-qrefresh.style = python:style.check_style
2758336Ssteve.reinhardt@amd.com# End of SConstruct additions
2764678Snate@binkert.org
2778336Ssteve.reinhardt@amd.com""" % (main.root.abspath)
2788336Ssteve.reinhardt@amd.com
2798336Ssteve.reinhardt@amd.commercurial_lib_not_found = """
2808336Ssteve.reinhardt@amd.comMercurial libraries cannot be found, ignoring style hook.  If
2818336Ssteve.reinhardt@amd.comyou are a gem5 developer, please fix this and run the style
2828336Ssteve.reinhardt@amd.comhook. It is important.
2835871Snate@binkert.org"""
2845871Snate@binkert.org
2858336Ssteve.reinhardt@amd.com# Check for style hook and prompt for installation if it's not there.
2868336Ssteve.reinhardt@amd.com# Skip this if --ignore-style was specified, there's no .hg dir to
2878336Ssteve.reinhardt@amd.com# install a hook in, or there's no interactive terminal to prompt.
2888336Ssteve.reinhardt@amd.comif not GetOption('ignore_style') and hgdir.exists() and sys.stdin.isatty():
2898336Ssteve.reinhardt@amd.com    style_hook = True
2905871Snate@binkert.org    try:
2918336Ssteve.reinhardt@amd.com        from mercurial import ui
2928336Ssteve.reinhardt@amd.com        ui = ui.ui()
2938336Ssteve.reinhardt@amd.com        ui.readconfig(hgdir.File('hgrc').abspath)
2948336Ssteve.reinhardt@amd.com        style_hook = ui.config('hooks', 'pretxncommit.style', None) and \
2958336Ssteve.reinhardt@amd.com                     ui.config('hooks', 'pre-qrefresh.style', None)
2964678Snate@binkert.org    except ImportError:
2975871Snate@binkert.org        print mercurial_lib_not_found
2984678Snate@binkert.org
2998336Ssteve.reinhardt@amd.com    if not style_hook:
3008336Ssteve.reinhardt@amd.com        print mercurial_style_message,
3018336Ssteve.reinhardt@amd.com        # continue unless user does ctrl-c/ctrl-d etc.
3028336Ssteve.reinhardt@amd.com        try:
3038336Ssteve.reinhardt@amd.com            raw_input()
3048336Ssteve.reinhardt@amd.com        except:
3058336Ssteve.reinhardt@amd.com            print "Input exception, exiting scons.\n"
3068336Ssteve.reinhardt@amd.com            sys.exit(1)
3078336Ssteve.reinhardt@amd.com        hgrc_path = '%s/.hg/hgrc' % main.root.abspath
3088336Ssteve.reinhardt@amd.com        print "Adding style hook to", hgrc_path, "\n"
3098336Ssteve.reinhardt@amd.com        try:
3108336Ssteve.reinhardt@amd.com            hgrc = open(hgrc_path, 'a')
3118336Ssteve.reinhardt@amd.com            hgrc.write(mercurial_style_hook)
3128336Ssteve.reinhardt@amd.com            hgrc.close()
3138336Ssteve.reinhardt@amd.com        except:
3148336Ssteve.reinhardt@amd.com            print "Error updating", hgrc_path
3158336Ssteve.reinhardt@amd.com            sys.exit(1)
3165871Snate@binkert.org
3176121Snate@binkert.org
318955SN/A###################################################
319955SN/A#
3202632Sstever@eecs.umich.edu# Figure out which configurations to set up based on the path(s) of
3212632Sstever@eecs.umich.edu# the target(s).
322955SN/A#
323955SN/A###################################################
324955SN/A
325955SN/A# Find default configuration & binary.
3268878Ssteve.reinhardt@amd.comDefault(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug'))
327955SN/A
3282632Sstever@eecs.umich.edu# helper function: find last occurrence of element in list
3292632Sstever@eecs.umich.edudef rfind(l, elt, offs = -1):
3302632Sstever@eecs.umich.edu    for i in range(len(l)+offs, 0, -1):
3312632Sstever@eecs.umich.edu        if l[i] == elt:
3322632Sstever@eecs.umich.edu            return i
3332632Sstever@eecs.umich.edu    raise ValueError, "element not found"
3342632Sstever@eecs.umich.edu
3358268Ssteve.reinhardt@amd.com# Take a list of paths (or SCons Nodes) and return a list with all
3368268Ssteve.reinhardt@amd.com# paths made absolute and ~-expanded.  Paths will be interpreted
3378268Ssteve.reinhardt@amd.com# relative to the launch directory unless a different root is provided
3388268Ssteve.reinhardt@amd.comdef makePathListAbsolute(path_list, root=GetLaunchDir()):
3398268Ssteve.reinhardt@amd.com    return [abspath(joinpath(root, expanduser(str(p))))
3408268Ssteve.reinhardt@amd.com            for p in path_list]
3418268Ssteve.reinhardt@amd.com
3422632Sstever@eecs.umich.edu# Each target must have 'build' in the interior of the path; the
3432632Sstever@eecs.umich.edu# directory below this will determine the build parameters.  For
3442632Sstever@eecs.umich.edu# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
3452632Sstever@eecs.umich.edu# recognize that ALPHA_SE specifies the configuration because it
3468268Ssteve.reinhardt@amd.com# follow 'build' in the build path.
3472632Sstever@eecs.umich.edu
3488268Ssteve.reinhardt@amd.com# The funky assignment to "[:]" is needed to replace the list contents
3498268Ssteve.reinhardt@amd.com# in place rather than reassign the symbol to a new list, which
3508268Ssteve.reinhardt@amd.com# doesn't work (obviously!).
3518268Ssteve.reinhardt@amd.comBUILD_TARGETS[:] = makePathListAbsolute(BUILD_TARGETS)
3523718Sstever@eecs.umich.edu
3532634Sstever@eecs.umich.edu# Generate a list of the unique build roots and configs that the
3542634Sstever@eecs.umich.edu# collected targets reference.
3555863Snate@binkert.orgvariant_paths = []
3562638Sstever@eecs.umich.edubuild_root = None
3578268Ssteve.reinhardt@amd.comfor t in BUILD_TARGETS:
3582632Sstever@eecs.umich.edu    path_dirs = t.split('/')
3592632Sstever@eecs.umich.edu    try:
3602632Sstever@eecs.umich.edu        build_top = rfind(path_dirs, 'build', -2)
3612632Sstever@eecs.umich.edu    except:
3622632Sstever@eecs.umich.edu        print "Error: no non-leaf 'build' dir found on target path", t
3631858SN/A        Exit(1)
3643716Sstever@eecs.umich.edu    this_build_root = joinpath('/',*path_dirs[:build_top+1])
3652638Sstever@eecs.umich.edu    if not build_root:
3662638Sstever@eecs.umich.edu        build_root = this_build_root
3672638Sstever@eecs.umich.edu    else:
3682638Sstever@eecs.umich.edu        if this_build_root != build_root:
3692638Sstever@eecs.umich.edu            print "Error: build targets not under same build root\n"\
3702638Sstever@eecs.umich.edu                  "  %s\n  %s" % (build_root, this_build_root)
3712638Sstever@eecs.umich.edu            Exit(1)
3725863Snate@binkert.org    variant_path = joinpath('/',*path_dirs[:build_top+2])
3735863Snate@binkert.org    if variant_path not in variant_paths:
3745863Snate@binkert.org        variant_paths.append(variant_path)
375955SN/A
3765341Sstever@gmail.com# Make sure build_root exists (might not if this is the first build there)
3775341Sstever@gmail.comif not isdir(build_root):
3785863Snate@binkert.org    mkdir(build_root)
3797756SAli.Saidi@ARM.commain['BUILDROOT'] = build_root
3805341Sstever@gmail.com
3816121Snate@binkert.orgExport('main')
3824494Ssaidi@eecs.umich.edu
3836121Snate@binkert.orgmain.SConsignFile(joinpath(build_root, "sconsign"))
3841105SN/A
3852667Sstever@eecs.umich.edu# Default duplicate option is to use hard links, but this messes up
3862667Sstever@eecs.umich.edu# when you use emacs to edit a file in the target dir, as emacs moves
3872667Sstever@eecs.umich.edu# file to file~ then copies to file, breaking the link.  Symbolic
3882667Sstever@eecs.umich.edu# (soft) links work better.
3896121Snate@binkert.orgmain.SetOption('duplicate', 'soft-copy')
3902667Sstever@eecs.umich.edu
3915341Sstever@gmail.com#
3925863Snate@binkert.org# Set up global sticky variables... these are common to an entire build
3935341Sstever@gmail.com# tree (not specific to a particular build like ALPHA_SE)
3945341Sstever@gmail.com#
3955341Sstever@gmail.com
3968120Sgblack@eecs.umich.eduglobal_vars_file = joinpath(build_root, 'variables.global')
3975341Sstever@gmail.com
3988120Sgblack@eecs.umich.eduglobal_vars = Variables(global_vars_file, args=ARGUMENTS)
3995341Sstever@gmail.com
4008120Sgblack@eecs.umich.eduglobal_vars.AddVariables(
4016121Snate@binkert.org    ('CC', 'C compiler', environ.get('CC', main['CC'])),
4026121Snate@binkert.org    ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])),
4038980Ssteve.reinhardt@amd.com    ('SWIG', 'SWIG tool', environ.get('SWIG', main['SWIG'])),
4049396Sandreas.hansson@arm.com    ('PROTOC', 'protoc tool', environ.get('PROTOC', 'protoc')),
4055397Ssaidi@eecs.umich.edu    ('BATCH', 'Use batch pool for build and tests', False),
4065397Ssaidi@eecs.umich.edu    ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
4077727SAli.Saidi@ARM.com    ('M5_BUILD_CACHE', 'Cache built objects in this directory', False),
4088268Ssteve.reinhardt@amd.com    ('EXTRAS', 'Add extra directories to the compilation', '')
4096168Snate@binkert.org    )
4105341Sstever@gmail.com
4118120Sgblack@eecs.umich.edu# Update main environment with values from ARGUMENTS & global_vars_file
4128120Sgblack@eecs.umich.eduglobal_vars.Update(main)
4138120Sgblack@eecs.umich.eduhelp_texts["global_vars"] += global_vars.GenerateHelpText(main)
4146814Sgblack@eecs.umich.edu
4155863Snate@binkert.org# Save sticky variable settings back to current variables file
4168120Sgblack@eecs.umich.eduglobal_vars.Save(global_vars_file, main)
4175341Sstever@gmail.com
4185863Snate@binkert.org# Parse EXTRAS variable to build list of all directories where we're
4198268Ssteve.reinhardt@amd.com# look for sources etc.  This list is exported as extras_dir_list.
4206121Snate@binkert.orgbase_dir = main.srcdir.abspath
4216121Snate@binkert.orgif main['EXTRAS']:
4228268Ssteve.reinhardt@amd.com    extras_dir_list = makePathListAbsolute(main['EXTRAS'].split(':'))
4235742Snate@binkert.orgelse:
4245742Snate@binkert.org    extras_dir_list = []
4255341Sstever@gmail.com
4265742Snate@binkert.orgExport('base_dir')
4275742Snate@binkert.orgExport('extras_dir_list')
4285341Sstever@gmail.com
4296017Snate@binkert.org# the ext directory should be on the #includes path
4306121Snate@binkert.orgmain.Append(CPPPATH=[Dir('ext')])
4316017Snate@binkert.org
4327816Ssteve.reinhardt@amd.comdef strip_build_path(path, env):
4337756SAli.Saidi@ARM.com    path = str(path)
4347756SAli.Saidi@ARM.com    variant_base = env['BUILDROOT'] + os.path.sep
4357756SAli.Saidi@ARM.com    if path.startswith(variant_base):
4367756SAli.Saidi@ARM.com        path = path[len(variant_base):]
4377756SAli.Saidi@ARM.com    elif path.startswith('build/'):
4387756SAli.Saidi@ARM.com        path = path[6:]
4397756SAli.Saidi@ARM.com    return path
4407756SAli.Saidi@ARM.com
4417816Ssteve.reinhardt@amd.com# Generate a string of the form:
4427816Ssteve.reinhardt@amd.com#   common/path/prefix/src1, src2 -> tgt1, tgt2
4437816Ssteve.reinhardt@amd.com# to print while building.
4447816Ssteve.reinhardt@amd.comclass Transform(object):
4457816Ssteve.reinhardt@amd.com    # all specific color settings should be here and nowhere else
4467816Ssteve.reinhardt@amd.com    tool_color = termcap.Normal
4477816Ssteve.reinhardt@amd.com    pfx_color = termcap.Yellow
4487816Ssteve.reinhardt@amd.com    srcs_color = termcap.Yellow + termcap.Bold
4497816Ssteve.reinhardt@amd.com    arrow_color = termcap.Blue + termcap.Bold
4507816Ssteve.reinhardt@amd.com    tgts_color = termcap.Yellow + termcap.Bold
4517756SAli.Saidi@ARM.com
4527816Ssteve.reinhardt@amd.com    def __init__(self, tool, max_sources=99):
4537816Ssteve.reinhardt@amd.com        self.format = self.tool_color + (" [%8s] " % tool) \
4547816Ssteve.reinhardt@amd.com                      + self.pfx_color + "%s" \
4557816Ssteve.reinhardt@amd.com                      + self.srcs_color + "%s" \
4567816Ssteve.reinhardt@amd.com                      + self.arrow_color + " -> " \
4577816Ssteve.reinhardt@amd.com                      + self.tgts_color + "%s" \
4587816Ssteve.reinhardt@amd.com                      + termcap.Normal
4597816Ssteve.reinhardt@amd.com        self.max_sources = max_sources
4607816Ssteve.reinhardt@amd.com
4617816Ssteve.reinhardt@amd.com    def __call__(self, target, source, env, for_signature=None):
4627816Ssteve.reinhardt@amd.com        # truncate source list according to max_sources param
4637816Ssteve.reinhardt@amd.com        source = source[0:self.max_sources]
4647816Ssteve.reinhardt@amd.com        def strip(f):
4657816Ssteve.reinhardt@amd.com            return strip_build_path(str(f), env)
4667816Ssteve.reinhardt@amd.com        if len(source) > 0:
4677816Ssteve.reinhardt@amd.com            srcs = map(strip, source)
4687816Ssteve.reinhardt@amd.com        else:
4697816Ssteve.reinhardt@amd.com            srcs = ['']
4707816Ssteve.reinhardt@amd.com        tgts = map(strip, target)
4717816Ssteve.reinhardt@amd.com        # surprisingly, os.path.commonprefix is a dumb char-by-char string
4727816Ssteve.reinhardt@amd.com        # operation that has nothing to do with paths.
4737816Ssteve.reinhardt@amd.com        com_pfx = os.path.commonprefix(srcs + tgts)
4747816Ssteve.reinhardt@amd.com        com_pfx_len = len(com_pfx)
4757816Ssteve.reinhardt@amd.com        if com_pfx:
4767816Ssteve.reinhardt@amd.com            # do some cleanup and sanity checking on common prefix
4777816Ssteve.reinhardt@amd.com            if com_pfx[-1] == ".":
4787816Ssteve.reinhardt@amd.com                # prefix matches all but file extension: ok
4797816Ssteve.reinhardt@amd.com                # back up one to change 'foo.cc -> o' to 'foo.cc -> .o'
4807816Ssteve.reinhardt@amd.com                com_pfx = com_pfx[0:-1]
4817816Ssteve.reinhardt@amd.com            elif com_pfx[-1] == "/":
4827816Ssteve.reinhardt@amd.com                # common prefix is directory path: OK
4837816Ssteve.reinhardt@amd.com                pass
4847816Ssteve.reinhardt@amd.com            else:
4857816Ssteve.reinhardt@amd.com                src0_len = len(srcs[0])
4867816Ssteve.reinhardt@amd.com                tgt0_len = len(tgts[0])
4877816Ssteve.reinhardt@amd.com                if src0_len == com_pfx_len:
4887816Ssteve.reinhardt@amd.com                    # source is a substring of target, OK
4897816Ssteve.reinhardt@amd.com                    pass
4907816Ssteve.reinhardt@amd.com                elif tgt0_len == com_pfx_len:
4917816Ssteve.reinhardt@amd.com                    # target is a substring of source, need to back up to
4927816Ssteve.reinhardt@amd.com                    # avoid empty string on RHS of arrow
4937816Ssteve.reinhardt@amd.com                    sep_idx = com_pfx.rfind(".")
4947816Ssteve.reinhardt@amd.com                    if sep_idx != -1:
4957816Ssteve.reinhardt@amd.com                        com_pfx = com_pfx[0:sep_idx]
4967816Ssteve.reinhardt@amd.com                    else:
4977816Ssteve.reinhardt@amd.com                        com_pfx = ''
4987816Ssteve.reinhardt@amd.com                elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".":
4997816Ssteve.reinhardt@amd.com                    # still splitting at file extension: ok
5007816Ssteve.reinhardt@amd.com                    pass
5017816Ssteve.reinhardt@amd.com                else:
5027816Ssteve.reinhardt@amd.com                    # probably a fluke; ignore it
5037816Ssteve.reinhardt@amd.com                    com_pfx = ''
5047816Ssteve.reinhardt@amd.com        # recalculate length in case com_pfx was modified
5057816Ssteve.reinhardt@amd.com        com_pfx_len = len(com_pfx)
5067816Ssteve.reinhardt@amd.com        def fmt(files):
5077816Ssteve.reinhardt@amd.com            f = map(lambda s: s[com_pfx_len:], files)
5087816Ssteve.reinhardt@amd.com            return ', '.join(f)
5097816Ssteve.reinhardt@amd.com        return self.format % (com_pfx, fmt(srcs), fmt(tgts))
5107816Ssteve.reinhardt@amd.com
5117816Ssteve.reinhardt@amd.comExport('Transform')
5127816Ssteve.reinhardt@amd.com
5138947Sandreas.hansson@arm.com# enable the regression script to use the termcap
5148947Sandreas.hansson@arm.commain['TERMCAP'] = termcap
5157756SAli.Saidi@ARM.com
5168120Sgblack@eecs.umich.eduif GetOption('verbose'):
5177756SAli.Saidi@ARM.com    def MakeAction(action, string, *args, **kwargs):
5187756SAli.Saidi@ARM.com        return Action(action, *args, **kwargs)
5197756SAli.Saidi@ARM.comelse:
5207756SAli.Saidi@ARM.com    MakeAction = Action
5217816Ssteve.reinhardt@amd.com    main['CCCOMSTR']        = Transform("CC")
5227816Ssteve.reinhardt@amd.com    main['CXXCOMSTR']       = Transform("CXX")
5237816Ssteve.reinhardt@amd.com    main['ASCOMSTR']        = Transform("AS")
5247816Ssteve.reinhardt@amd.com    main['SWIGCOMSTR']      = Transform("SWIG")
5257816Ssteve.reinhardt@amd.com    main['ARCOMSTR']        = Transform("AR", 0)
5267816Ssteve.reinhardt@amd.com    main['LINKCOMSTR']      = Transform("LINK", 0)
5277816Ssteve.reinhardt@amd.com    main['RANLIBCOMSTR']    = Transform("RANLIB", 0)
5287816Ssteve.reinhardt@amd.com    main['M4COMSTR']        = Transform("M4")
5297816Ssteve.reinhardt@amd.com    main['SHCCCOMSTR']      = Transform("SHCC")
5307816Ssteve.reinhardt@amd.com    main['SHCXXCOMSTR']     = Transform("SHCXX")
5317756SAli.Saidi@ARM.comExport('MakeAction')
5327756SAli.Saidi@ARM.com
5339227Sandreas.hansson@arm.com# Initialize the Link-Time Optimization (LTO) flags
5349227Sandreas.hansson@arm.commain['LTO_CCFLAGS'] = []
5359227Sandreas.hansson@arm.commain['LTO_LDFLAGS'] = []
5369227Sandreas.hansson@arm.com
5379590Sandreas@sandberg.pp.se# According to the readme, tcmalloc works best if the compiler doesn't
5389590Sandreas@sandberg.pp.se# assume that we're using the builtin malloc and friends. These flags
5399590Sandreas@sandberg.pp.se# are compiler-specific, so we need to set them after we detect which
5409590Sandreas@sandberg.pp.se# compiler we're using.
5419590Sandreas@sandberg.pp.semain['TCMALLOC_CCFLAGS'] = []
5429590Sandreas@sandberg.pp.se
5436654Snate@binkert.orgCXX_version = readCommand([main['CXX'],'--version'], exception=False)
5446654Snate@binkert.orgCXX_V = readCommand([main['CXX'],'-V'], exception=False)
5455871Snate@binkert.org
5466121Snate@binkert.orgmain['GCC'] = CXX_version and CXX_version.find('g++') >= 0
5478946Sandreas.hansson@arm.commain['CLANG'] = CXX_version and CXX_version.find('clang') >= 0
5489419Sandreas.hansson@arm.comif main['GCC'] + main['CLANG'] > 1:
5493940Ssaidi@eecs.umich.edu    print 'Error: How can we have two at the same time?'
5503918Ssaidi@eecs.umich.edu    Exit(1)
5513918Ssaidi@eecs.umich.edu
5521858SN/A# Set up default C++ compiler flags
5539556Sandreas.hansson@arm.comif main['GCC'] or main['CLANG']:
5549556Sandreas.hansson@arm.com    # As gcc and clang share many flags, do the common parts here
5559556Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-pipe'])
5569556Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-fno-strict-aliasing'])
5579556Sandreas.hansson@arm.com    # Enable -Wall and then disable the few warnings that we
5589556Sandreas.hansson@arm.com    # consistently violate
5599556Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef'])
56010878Sandreas.hansson@arm.com    # We always compile using C++11
56110878Sandreas.hansson@arm.com    main.Append(CXXFLAGS=['-std=c++11'])
5629556Sandreas.hansson@arm.com    # Add selected sanity checks from -Wextra
5639556Sandreas.hansson@arm.com    main.Append(CXXFLAGS=['-Wmissing-field-initializers',
5649556Sandreas.hansson@arm.com                          '-Woverloaded-virtual'])
5659556Sandreas.hansson@arm.comelse:
5669556Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal,
5679556Sandreas.hansson@arm.com    print "Don't know what compiler options to use for your compiler."
5689556Sandreas.hansson@arm.com    print termcap.Yellow + '       compiler:' + termcap.Normal, main['CXX']
5699556Sandreas.hansson@arm.com    print termcap.Yellow + '       version:' + termcap.Normal,
5709556Sandreas.hansson@arm.com    if not CXX_version:
5719556Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\
5729556Sandreas.hansson@arm.com               termcap.Normal
5739556Sandreas.hansson@arm.com    else:
5749556Sandreas.hansson@arm.com        print CXX_version.replace('\n', '<nl>')
5759556Sandreas.hansson@arm.com    print "       If you're trying to use a compiler other than GCC"
5769556Sandreas.hansson@arm.com    print "       or clang, there appears to be something wrong with your"
5779556Sandreas.hansson@arm.com    print "       environment."
5789556Sandreas.hansson@arm.com    print "       "
5799556Sandreas.hansson@arm.com    print "       If you are trying to use a compiler other than those listed"
5809556Sandreas.hansson@arm.com    print "       above you will need to ease fix SConstruct and "
5819556Sandreas.hansson@arm.com    print "       src/SConscript to support that compiler."
5829556Sandreas.hansson@arm.com    Exit(1)
5839556Sandreas.hansson@arm.com
5846121Snate@binkert.orgif main['GCC']:
58510878Sandreas.hansson@arm.com    # Check for a supported version of gcc. >= 4.7 is chosen for its
58610238Sandreas.hansson@arm.com    # level of c++11 support. See
58710878Sandreas.hansson@arm.com    # http://gcc.gnu.org/projects/cxx0x.html for details.
5889420Sandreas.hansson@arm.com    gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False)
58910878Sandreas.hansson@arm.com    if compareVersions(gcc_version, "4.7") < 0:
59010878Sandreas.hansson@arm.com        print 'Error: gcc version 4.7 or newer required.'
5919420Sandreas.hansson@arm.com        print '       Installed version:', gcc_version
5929420Sandreas.hansson@arm.com        Exit(1)
5939420Sandreas.hansson@arm.com
5949420Sandreas.hansson@arm.com    main['GCC_VERSION'] = gcc_version
5959420Sandreas.hansson@arm.com
59610264Sandreas.hansson@arm.com    # gcc from version 4.8 and above generates "rep; ret" instructions
59710264Sandreas.hansson@arm.com    # to avoid performance penalties on certain AMD chips. Older
59810264Sandreas.hansson@arm.com    # assemblers detect this as an error, "Error: expecting string
59910264Sandreas.hansson@arm.com    # instruction after `rep'"
60010264Sandreas.hansson@arm.com    if compareVersions(gcc_version, "4.8") > 0:
60110866Sandreas.hansson@arm.com        as_version_raw = readCommand([main['AS'], '-v', '/dev/null'],
60210866Sandreas.hansson@arm.com                                     exception=False).split()
60310264Sandreas.hansson@arm.com
60410866Sandreas.hansson@arm.com        # version strings may contain extra distro-specific
60510866Sandreas.hansson@arm.com        # qualifiers, so play it safe and keep only what comes before
60610866Sandreas.hansson@arm.com        # the first hyphen
60710866Sandreas.hansson@arm.com        as_version = as_version_raw[-1].split('-')[0] if as_version_raw \
60810866Sandreas.hansson@arm.com            else None
60910866Sandreas.hansson@arm.com
61010866Sandreas.hansson@arm.com        if not as_version or compareVersions(as_version, "2.23") < 0:
61110264Sandreas.hansson@arm.com            print termcap.Yellow + termcap.Bold + \
61210264Sandreas.hansson@arm.com                'Warning: This combination of gcc and binutils have' + \
61310264Sandreas.hansson@arm.com                ' known incompatibilities.\n' + \
61410264Sandreas.hansson@arm.com                '         If you encounter build problems, please update ' + \
61510264Sandreas.hansson@arm.com                'binutils to 2.23.' + \
61610264Sandreas.hansson@arm.com                termcap.Normal
61710264Sandreas.hansson@arm.com
61810457Sandreas.hansson@arm.com    # Make sure we warn if the user has requested to compile with the
61910457Sandreas.hansson@arm.com    # Undefined Benahvior Sanitizer and this version of gcc does not
62010457Sandreas.hansson@arm.com    # support it.
62110457Sandreas.hansson@arm.com    if GetOption('with_ubsan') and \
62210457Sandreas.hansson@arm.com            compareVersions(gcc_version, '4.9') < 0:
62310457Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + \
62410457Sandreas.hansson@arm.com            'Warning: UBSan is only supported using gcc 4.9 and later.' + \
62510457Sandreas.hansson@arm.com            termcap.Normal
62610457Sandreas.hansson@arm.com
62710238Sandreas.hansson@arm.com    # Add the appropriate Link-Time Optimization (LTO) flags
62810238Sandreas.hansson@arm.com    # unless LTO is explicitly turned off. Note that these flags
62910238Sandreas.hansson@arm.com    # are only used by the fast target.
63010238Sandreas.hansson@arm.com    if not GetOption('no_lto'):
63110238Sandreas.hansson@arm.com        # Pass the LTO flag when compiling to produce GIMPLE
63210238Sandreas.hansson@arm.com        # output, we merely create the flags here and only append
63310416Sandreas.hansson@arm.com        # them later
63410238Sandreas.hansson@arm.com        main['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
6359227Sandreas.hansson@arm.com
63610238Sandreas.hansson@arm.com        # Use the same amount of jobs for LTO as we are running
63710416Sandreas.hansson@arm.com        # scons with
63810416Sandreas.hansson@arm.com        main['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
6399227Sandreas.hansson@arm.com
6409590Sandreas@sandberg.pp.se    main.Append(TCMALLOC_CCFLAGS=['-fno-builtin-malloc', '-fno-builtin-calloc',
6419590Sandreas@sandberg.pp.se                                  '-fno-builtin-realloc', '-fno-builtin-free'])
6429590Sandreas@sandberg.pp.se
6438737Skoansin.tan@gmail.comelif main['CLANG']:
64410878Sandreas.hansson@arm.com    # Check for a supported version of clang, >= 3.1 is needed to
64510878Sandreas.hansson@arm.com    # support similar features as gcc 4.7. See
6469420Sandreas.hansson@arm.com    # http://clang.llvm.org/cxx_status.html for details
6478737Skoansin.tan@gmail.com    clang_version_re = re.compile(".* version (\d+\.\d+)")
64810106SMitch.Hayenga@arm.com    clang_version_match = clang_version_re.search(CXX_version)
6498737Skoansin.tan@gmail.com    if (clang_version_match):
6508737Skoansin.tan@gmail.com        clang_version = clang_version_match.groups()[0]
65110878Sandreas.hansson@arm.com        if compareVersions(clang_version, "3.1") < 0:
65210878Sandreas.hansson@arm.com            print 'Error: clang version 3.1 or newer required.'
6538737Skoansin.tan@gmail.com            print '       Installed version:', clang_version
6548737Skoansin.tan@gmail.com            Exit(1)
6558737Skoansin.tan@gmail.com    else:
6568737Skoansin.tan@gmail.com        print 'Error: Unable to determine clang version.'
6578737Skoansin.tan@gmail.com        Exit(1)
6588737Skoansin.tan@gmail.com
6599556Sandreas.hansson@arm.com    # clang has a few additional warnings that we disable,
6609556Sandreas.hansson@arm.com    # tautological comparisons are allowed due to unsigned integers
6619556Sandreas.hansson@arm.com    # being compared to constants that happen to be 0, and extraneous
6629556Sandreas.hansson@arm.com    # parantheses are allowed due to Ruby's printing of the AST,
6639556Sandreas.hansson@arm.com    # finally self assignments are allowed as the generated CPU code
6649556Sandreas.hansson@arm.com    # is relying on this
6659556Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-Wno-tautological-compare',
6669556Sandreas.hansson@arm.com                         '-Wno-parentheses',
66710278SAndreas.Sandberg@ARM.com                         '-Wno-self-assign',
66810278SAndreas.Sandberg@ARM.com                         # Some versions of libstdc++ (4.8?) seem to
66910278SAndreas.Sandberg@ARM.com                         # use struct hash and class hash
67010278SAndreas.Sandberg@ARM.com                         # interchangeably.
67110278SAndreas.Sandberg@ARM.com                         '-Wno-mismatched-tags',
67210278SAndreas.Sandberg@ARM.com                         ])
6739556Sandreas.hansson@arm.com
6749590Sandreas@sandberg.pp.se    main.Append(TCMALLOC_CCFLAGS=['-fno-builtin'])
6759590Sandreas@sandberg.pp.se
6769420Sandreas.hansson@arm.com    # On Mac OS X/Darwin we need to also use libc++ (part of XCode) as
6779846Sandreas.hansson@arm.com    # opposed to libstdc++, as the later is dated.
6789846Sandreas.hansson@arm.com    if sys.platform == "darwin":
6799846Sandreas.hansson@arm.com        main.Append(CXXFLAGS=['-stdlib=libc++'])
6809846Sandreas.hansson@arm.com        main.Append(LIBS=['c++'])
6818946Sandreas.hansson@arm.com
6823918Ssaidi@eecs.umich.eduelse:
6839068SAli.Saidi@ARM.com    print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal,
6849068SAli.Saidi@ARM.com    print "Don't know what compiler options to use for your compiler."
6859068SAli.Saidi@ARM.com    print termcap.Yellow + '       compiler:' + termcap.Normal, main['CXX']
6869068SAli.Saidi@ARM.com    print termcap.Yellow + '       version:' + termcap.Normal,
6879068SAli.Saidi@ARM.com    if not CXX_version:
6889068SAli.Saidi@ARM.com        print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\
6899068SAli.Saidi@ARM.com               termcap.Normal
6909068SAli.Saidi@ARM.com    else:
6919068SAli.Saidi@ARM.com        print CXX_version.replace('\n', '<nl>')
6929419Sandreas.hansson@arm.com    print "       If you're trying to use a compiler other than GCC"
6939068SAli.Saidi@ARM.com    print "       or clang, there appears to be something wrong with your"
6949068SAli.Saidi@ARM.com    print "       environment."
6959068SAli.Saidi@ARM.com    print "       "
6969068SAli.Saidi@ARM.com    print "       If you are trying to use a compiler other than those listed"
6979068SAli.Saidi@ARM.com    print "       above you will need to ease fix SConstruct and "
6989068SAli.Saidi@ARM.com    print "       src/SConscript to support that compiler."
6993918Ssaidi@eecs.umich.edu    Exit(1)
7003918Ssaidi@eecs.umich.edu
7016157Snate@binkert.org# Set up common yacc/bison flags (needed for Ruby)
7026157Snate@binkert.orgmain['YACCFLAGS'] = '-d'
7036157Snate@binkert.orgmain['YACCHXXFILESUFFIX'] = '.hh'
7046157Snate@binkert.org
7055397Ssaidi@eecs.umich.edu# Do this after we save setting back, or else we'll tack on an
7065397Ssaidi@eecs.umich.edu# extra 'qdo' every time we run scons.
7076121Snate@binkert.orgif main['BATCH']:
7086121Snate@binkert.org    main['CC']     = main['BATCH_CMD'] + ' ' + main['CC']
7096121Snate@binkert.org    main['CXX']    = main['BATCH_CMD'] + ' ' + main['CXX']
7106121Snate@binkert.org    main['AS']     = main['BATCH_CMD'] + ' ' + main['AS']
7116121Snate@binkert.org    main['AR']     = main['BATCH_CMD'] + ' ' + main['AR']
7126121Snate@binkert.org    main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB']
7135397Ssaidi@eecs.umich.edu
7141851SN/Aif sys.platform == 'cygwin':
7151851SN/A    # cygwin has some header file issues...
7167739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=["-Wno-uninitialized"])
717955SN/A
7189396Sandreas.hansson@arm.com# Check for the protobuf compiler
7199396Sandreas.hansson@arm.comprotoc_version = readCommand([main['PROTOC'], '--version'],
7209396Sandreas.hansson@arm.com                             exception='').split()
7219396Sandreas.hansson@arm.com
7229396Sandreas.hansson@arm.com# First two words should be "libprotoc x.y.z"
7239396Sandreas.hansson@arm.comif len(protoc_version) < 2 or protoc_version[0] != 'libprotoc':
7249396Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + \
7259396Sandreas.hansson@arm.com        'Warning: Protocol buffer compiler (protoc) not found.\n' + \
7269396Sandreas.hansson@arm.com        '         Please install protobuf-compiler for tracing support.' + \
7279396Sandreas.hansson@arm.com        termcap.Normal
7289396Sandreas.hansson@arm.com    main['PROTOC'] = False
7299396Sandreas.hansson@arm.comelse:
7309396Sandreas.hansson@arm.com    # Based on the availability of the compress stream wrappers,
7319396Sandreas.hansson@arm.com    # require 2.1.0
7329396Sandreas.hansson@arm.com    min_protoc_version = '2.1.0'
7339396Sandreas.hansson@arm.com    if compareVersions(protoc_version[1], min_protoc_version) < 0:
7349477Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + \
7359477Sandreas.hansson@arm.com            'Warning: protoc version', min_protoc_version, \
7369477Sandreas.hansson@arm.com            'or newer required.\n' + \
7379477Sandreas.hansson@arm.com            '         Installed version:', protoc_version[1], \
7389477Sandreas.hansson@arm.com            termcap.Normal
7399477Sandreas.hansson@arm.com        main['PROTOC'] = False
7409477Sandreas.hansson@arm.com    else:
7419477Sandreas.hansson@arm.com        # Attempt to determine the appropriate include path and
7429477Sandreas.hansson@arm.com        # library path using pkg-config, that means we also need to
7439477Sandreas.hansson@arm.com        # check for pkg-config. Note that it is possible to use
7449477Sandreas.hansson@arm.com        # protobuf without the involvement of pkg-config. Later on we
7459477Sandreas.hansson@arm.com        # check go a library config check and at that point the test
7469477Sandreas.hansson@arm.com        # will fail if libprotobuf cannot be found.
7479477Sandreas.hansson@arm.com        if readCommand(['pkg-config', '--version'], exception=''):
7489477Sandreas.hansson@arm.com            try:
7499477Sandreas.hansson@arm.com                # Attempt to establish what linking flags to add for protobuf
7509477Sandreas.hansson@arm.com                # using pkg-config
7519477Sandreas.hansson@arm.com                main.ParseConfig('pkg-config --cflags --libs-only-L protobuf')
7529477Sandreas.hansson@arm.com            except:
7539477Sandreas.hansson@arm.com                print termcap.Yellow + termcap.Bold + \
7549477Sandreas.hansson@arm.com                    'Warning: pkg-config could not get protobuf flags.' + \
7559477Sandreas.hansson@arm.com                    termcap.Normal
7569396Sandreas.hansson@arm.com
7573053Sstever@eecs.umich.edu# Check for SWIG
7586121Snate@binkert.orgif not main.has_key('SWIG'):
7593053Sstever@eecs.umich.edu    print 'Error: SWIG utility not found.'
7603053Sstever@eecs.umich.edu    print '       Please install (see http://www.swig.org) and retry.'
7613053Sstever@eecs.umich.edu    Exit(1)
7623053Sstever@eecs.umich.edu
7633053Sstever@eecs.umich.edu# Check for appropriate SWIG version
7649072Sandreas.hansson@arm.comswig_version = readCommand([main['SWIG'], '-version'], exception='').split()
7653053Sstever@eecs.umich.edu# First 3 words should be "SWIG Version x.y.z"
7664742Sstever@eecs.umich.eduif len(swig_version) < 3 or \
7674742Sstever@eecs.umich.edu        swig_version[0] != 'SWIG' or swig_version[1] != 'Version':
7683053Sstever@eecs.umich.edu    print 'Error determining SWIG version.'
7693053Sstever@eecs.umich.edu    Exit(1)
7703053Sstever@eecs.umich.edu
77110181SCurtis.Dunham@arm.commin_swig_version = '2.0.4'
7726654Snate@binkert.orgif compareVersions(swig_version[2], min_swig_version) < 0:
7733053Sstever@eecs.umich.edu    print 'Error: SWIG version', min_swig_version, 'or newer required.'
7743053Sstever@eecs.umich.edu    print '       Installed version:', swig_version[2]
7753053Sstever@eecs.umich.edu    Exit(1)
7763053Sstever@eecs.umich.edu
77710425Sandreas.hansson@arm.com# Check for known incompatibilities. The standard library shipped with
77810425Sandreas.hansson@arm.com# gcc >= 4.9 does not play well with swig versions prior to 3.0
77910425Sandreas.hansson@arm.comif main['GCC'] and compareVersions(gcc_version, '4.9') >= 0 and \
78010425Sandreas.hansson@arm.com        compareVersions(swig_version[2], '3.0') < 0:
78110425Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + \
78210425Sandreas.hansson@arm.com        'Warning: This combination of gcc and swig have' + \
78310425Sandreas.hansson@arm.com        ' known incompatibilities.\n' + \
78410425Sandreas.hansson@arm.com        '         If you encounter build problems, please update ' + \
78510425Sandreas.hansson@arm.com        'swig to 3.0 or later.' + \
78610425Sandreas.hansson@arm.com        termcap.Normal
78710425Sandreas.hansson@arm.com
7882667Sstever@eecs.umich.edu# Set up SWIG flags & scanner
7894554Sbinkertn@umich.eduswig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
7906121Snate@binkert.orgmain.Append(SWIGFLAGS=swig_flags)
7912667Sstever@eecs.umich.edu
79210710Sandreas.hansson@arm.com# Check for 'timeout' from GNU coreutils. If present, regressions will
79310710Sandreas.hansson@arm.com# be run with a time limit. We require version 8.13 since we rely on
79410710Sandreas.hansson@arm.com# support for the '--foreground' option.
79510710Sandreas.hansson@arm.comtimeout_lines = readCommand(['timeout', '--version'],
79610710Sandreas.hansson@arm.com                            exception='').splitlines()
79710710Sandreas.hansson@arm.com# Get the first line and tokenize it
79810710Sandreas.hansson@arm.comtimeout_version = timeout_lines[0].split() if timeout_lines else []
79910710Sandreas.hansson@arm.commain['TIMEOUT'] =  timeout_version and \
80010710Sandreas.hansson@arm.com    compareVersions(timeout_version[-1], '8.13') >= 0
80110384SCurtis.Dunham@arm.com
8024554Sbinkertn@umich.edu# filter out all existing swig scanners, they mess up the dependency
8034554Sbinkertn@umich.edu# stuff for some reason
8044554Sbinkertn@umich.eduscanners = []
8056121Snate@binkert.orgfor scanner in main['SCANNERS']:
8064554Sbinkertn@umich.edu    skeys = scanner.skeys
8074554Sbinkertn@umich.edu    if skeys == '.i':
8084554Sbinkertn@umich.edu        continue
8094781Snate@binkert.org
8104554Sbinkertn@umich.edu    if isinstance(skeys, (list, tuple)) and '.i' in skeys:
8114554Sbinkertn@umich.edu        continue
8122667Sstever@eecs.umich.edu
8134554Sbinkertn@umich.edu    scanners.append(scanner)
8144554Sbinkertn@umich.edu
8154554Sbinkertn@umich.edu# add the new swig scanner that we like better
8164554Sbinkertn@umich.edufrom SCons.Scanner import ClassicCPP as CPPScanner
8172667Sstever@eecs.umich.eduswig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
8184554Sbinkertn@umich.eduscanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re))
8192667Sstever@eecs.umich.edu
8204554Sbinkertn@umich.edu# replace the scanners list that has what we want
8216121Snate@binkert.orgmain['SCANNERS'] = scanners
8222667Sstever@eecs.umich.edu
8239986Sandreas@sandberg.pp.se# Add a custom Check function to test for structure members.
8249986Sandreas@sandberg.pp.sedef CheckMember(context, include, decl, member, include_quotes="<>"):
8259986Sandreas@sandberg.pp.se    context.Message("Checking for member %s in %s..." %
8269986Sandreas@sandberg.pp.se                    (member, decl))
8279986Sandreas@sandberg.pp.se    text = """
8289986Sandreas@sandberg.pp.se#include %(header)s
8299986Sandreas@sandberg.pp.seint main(){
8309986Sandreas@sandberg.pp.se  %(decl)s test;
8319986Sandreas@sandberg.pp.se  (void)test.%(member)s;
8329986Sandreas@sandberg.pp.se  return 0;
8339986Sandreas@sandberg.pp.se};
8349986Sandreas@sandberg.pp.se""" % { "header" : include_quotes[0] + include + include_quotes[1],
8359986Sandreas@sandberg.pp.se        "decl" : decl,
8369986Sandreas@sandberg.pp.se        "member" : member,
8379986Sandreas@sandberg.pp.se        }
8389986Sandreas@sandberg.pp.se
8399986Sandreas@sandberg.pp.se    ret = context.TryCompile(text, extension=".cc")
8409986Sandreas@sandberg.pp.se    context.Result(ret)
8419986Sandreas@sandberg.pp.se    return ret
8429986Sandreas@sandberg.pp.se
8432638Sstever@eecs.umich.edu# Platform-specific configuration.  Note again that we assume that all
8442638Sstever@eecs.umich.edu# builds under a given build root run on the same host platform.
8456121Snate@binkert.orgconf = Configure(main,
8463716Sstever@eecs.umich.edu                 conf_dir = joinpath(build_root, '.scons_config'),
8475522Snate@binkert.org                 log_file = joinpath(build_root, 'scons_config.log'),
8489986Sandreas@sandberg.pp.se                 custom_tests = {
8499986Sandreas@sandberg.pp.se        'CheckMember' : CheckMember,
8509986Sandreas@sandberg.pp.se        })
8515522Snate@binkert.org
8525227Ssaidi@eecs.umich.edu# Check if we should compile a 64 bit binary on Mac OS X/Darwin
8535227Ssaidi@eecs.umich.edutry:
8545227Ssaidi@eecs.umich.edu    import platform
8555227Ssaidi@eecs.umich.edu    uname = platform.uname()
8566654Snate@binkert.org    if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0:
8576654Snate@binkert.org        if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
8587769SAli.Saidi@ARM.com            main.Append(CCFLAGS=['-arch', 'x86_64'])
8597769SAli.Saidi@ARM.com            main.Append(CFLAGS=['-arch', 'x86_64'])
8607769SAli.Saidi@ARM.com            main.Append(LINKFLAGS=['-arch', 'x86_64'])
8617769SAli.Saidi@ARM.com            main.Append(ASFLAGS=['-arch', 'x86_64'])
8625227Ssaidi@eecs.umich.eduexcept:
8635227Ssaidi@eecs.umich.edu    pass
8645227Ssaidi@eecs.umich.edu
8655204Sstever@gmail.com# Recent versions of scons substitute a "Null" object for Configure()
8665204Sstever@gmail.com# when configuration isn't necessary, e.g., if the "--help" option is
8675204Sstever@gmail.com# present.  Unfortuantely this Null object always returns false,
8685204Sstever@gmail.com# breaking all our configuration checks.  We replace it with our own
8695204Sstever@gmail.com# more optimistic null object that returns True instead.
8705204Sstever@gmail.comif not conf:
8715204Sstever@gmail.com    def NullCheck(*args, **kwargs):
8725204Sstever@gmail.com        return True
8735204Sstever@gmail.com
8745204Sstever@gmail.com    class NullConf:
8755204Sstever@gmail.com        def __init__(self, env):
8765204Sstever@gmail.com            self.env = env
8775204Sstever@gmail.com        def Finish(self):
8785204Sstever@gmail.com            return self.env
8795204Sstever@gmail.com        def __getattr__(self, mname):
8805204Sstever@gmail.com            return NullCheck
8815204Sstever@gmail.com
8826121Snate@binkert.org    conf = NullConf(main)
8835204Sstever@gmail.com
8847727SAli.Saidi@ARM.com# Cache build files in the supplied directory.
8857727SAli.Saidi@ARM.comif main['M5_BUILD_CACHE']:
8867727SAli.Saidi@ARM.com    print 'Using build cache located at', main['M5_BUILD_CACHE']
8877727SAli.Saidi@ARM.com    CacheDir(main['M5_BUILD_CACHE'])
8887727SAli.Saidi@ARM.com
88910453SAndrew.Bardsley@arm.comif not GetOption('without_python'):
89010453SAndrew.Bardsley@arm.com    # Find Python include and library directories for embedding the
89110453SAndrew.Bardsley@arm.com    # interpreter. We rely on python-config to resolve the appropriate
89210453SAndrew.Bardsley@arm.com    # includes and linker flags. ParseConfig does not seem to understand
89310453SAndrew.Bardsley@arm.com    # the more exotic linker flags such as -Xlinker and -export-dynamic so
89410453SAndrew.Bardsley@arm.com    # we add them explicitly below. If you want to link in an alternate
89510453SAndrew.Bardsley@arm.com    # version of python, see above for instructions on how to invoke
89610453SAndrew.Bardsley@arm.com    # scons with the appropriate PATH set.
89710453SAndrew.Bardsley@arm.com    #
89810453SAndrew.Bardsley@arm.com    # First we check if python2-config exists, else we use python-config
89910453SAndrew.Bardsley@arm.com    python_config = readCommand(['which', 'python2-config'],
90010160Sandreas.hansson@arm.com                                exception='').strip()
90110453SAndrew.Bardsley@arm.com    if not os.path.exists(python_config):
90210453SAndrew.Bardsley@arm.com        python_config = readCommand(['which', 'python-config'],
90310453SAndrew.Bardsley@arm.com                                    exception='').strip()
90410453SAndrew.Bardsley@arm.com    py_includes = readCommand([python_config, '--includes'],
90510453SAndrew.Bardsley@arm.com                              exception='').split()
90610453SAndrew.Bardsley@arm.com    # Strip the -I from the include folders before adding them to the
90710453SAndrew.Bardsley@arm.com    # CPPPATH
90810453SAndrew.Bardsley@arm.com    main.Append(CPPPATH=map(lambda inc: inc[2:], py_includes))
9099812Sandreas.hansson@arm.com
91010453SAndrew.Bardsley@arm.com    # Read the linker flags and split them into libraries and other link
91110453SAndrew.Bardsley@arm.com    # flags. The libraries are added later through the call the CheckLib.
91210453SAndrew.Bardsley@arm.com    py_ld_flags = readCommand([python_config, '--ldflags'],
91310453SAndrew.Bardsley@arm.com        exception='').split()
91410453SAndrew.Bardsley@arm.com    py_libs = []
91510453SAndrew.Bardsley@arm.com    for lib in py_ld_flags:
91610453SAndrew.Bardsley@arm.com         if not lib.startswith('-l'):
91710453SAndrew.Bardsley@arm.com             main.Append(LINKFLAGS=[lib])
91810453SAndrew.Bardsley@arm.com         else:
91910453SAndrew.Bardsley@arm.com             lib = lib[2:]
92010453SAndrew.Bardsley@arm.com             if lib not in py_libs:
92110453SAndrew.Bardsley@arm.com                 py_libs.append(lib)
9227727SAli.Saidi@ARM.com
92310453SAndrew.Bardsley@arm.com    # verify that this stuff works
92410453SAndrew.Bardsley@arm.com    if not conf.CheckHeader('Python.h', '<>'):
92510453SAndrew.Bardsley@arm.com        print "Error: can't find Python.h header in", py_includes
92610453SAndrew.Bardsley@arm.com        print "Install Python headers (package python-dev on Ubuntu and RedHat)"
92710453SAndrew.Bardsley@arm.com        Exit(1)
9283118Sstever@eecs.umich.edu
92910453SAndrew.Bardsley@arm.com    for lib in py_libs:
93010453SAndrew.Bardsley@arm.com        if not conf.CheckLib(lib):
93110453SAndrew.Bardsley@arm.com            print "Error: can't find library %s required by python" % lib
93210453SAndrew.Bardsley@arm.com            Exit(1)
9333118Sstever@eecs.umich.edu
9343483Ssaidi@eecs.umich.edu# On Solaris you need to use libsocket for socket ops
9353494Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
9363494Ssaidi@eecs.umich.edu   if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
9373483Ssaidi@eecs.umich.edu       print "Can't find library with socket calls (e.g. accept())"
9383483Ssaidi@eecs.umich.edu       Exit(1)
9393483Ssaidi@eecs.umich.edu
9403053Sstever@eecs.umich.edu# Check for zlib.  If the check passes, libz will be automatically
9413053Sstever@eecs.umich.edu# added to the LIBS environment variable.
9423918Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
9433053Sstever@eecs.umich.edu    print 'Error: did not find needed zlib compression library '\
9443053Sstever@eecs.umich.edu          'and/or zlib.h header file.'
9453053Sstever@eecs.umich.edu    print '       Please install zlib and try again.'
9463053Sstever@eecs.umich.edu    Exit(1)
9473053Sstever@eecs.umich.edu
9489396Sandreas.hansson@arm.com# If we have the protobuf compiler, also make sure we have the
9499396Sandreas.hansson@arm.com# development libraries. If the check passes, libprotobuf will be
9509396Sandreas.hansson@arm.com# automatically added to the LIBS environment variable. After
9519396Sandreas.hansson@arm.com# this, we can use the HAVE_PROTOBUF flag to determine if we have
9529396Sandreas.hansson@arm.com# got both protoc and libprotobuf available.
9539396Sandreas.hansson@arm.commain['HAVE_PROTOBUF'] = main['PROTOC'] and \
9549396Sandreas.hansson@arm.com    conf.CheckLibWithHeader('protobuf', 'google/protobuf/message.h',
9559396Sandreas.hansson@arm.com                            'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;')
9569396Sandreas.hansson@arm.com
9579477Sandreas.hansson@arm.com# If we have the compiler but not the library, print another warning.
9589396Sandreas.hansson@arm.comif main['PROTOC'] and not main['HAVE_PROTOBUF']:
9599477Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + \
9609477Sandreas.hansson@arm.com        'Warning: did not find protocol buffer library and/or headers.\n' + \
9619477Sandreas.hansson@arm.com    '       Please install libprotobuf-dev for tracing support.' + \
9629477Sandreas.hansson@arm.com    termcap.Normal
9639396Sandreas.hansson@arm.com
9647840Snate@binkert.org# Check for librt.
9657865Sgblack@eecs.umich.eduhave_posix_clock = \
9667865Sgblack@eecs.umich.edu    conf.CheckLibWithHeader(None, 'time.h', 'C',
9677865Sgblack@eecs.umich.edu                            'clock_nanosleep(0,0,NULL,NULL);') or \
9687865Sgblack@eecs.umich.edu    conf.CheckLibWithHeader('rt', 'time.h', 'C',
9697865Sgblack@eecs.umich.edu                            'clock_nanosleep(0,0,NULL,NULL);')
9707840Snate@binkert.org
9719900Sandreas@sandberg.pp.sehave_posix_timers = \
9729900Sandreas@sandberg.pp.se    conf.CheckLibWithHeader([None, 'rt'], [ 'time.h', 'signal.h' ], 'C',
9739900Sandreas@sandberg.pp.se                            'timer_create(CLOCK_MONOTONIC, NULL, NULL);')
9749900Sandreas@sandberg.pp.se
97510456SCurtis.Dunham@arm.comif not GetOption('without_tcmalloc'):
97610456SCurtis.Dunham@arm.com    if conf.CheckLib('tcmalloc'):
97710456SCurtis.Dunham@arm.com        main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS'])
97810456SCurtis.Dunham@arm.com    elif conf.CheckLib('tcmalloc_minimal'):
97910456SCurtis.Dunham@arm.com        main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS'])
98010456SCurtis.Dunham@arm.com    else:
98110456SCurtis.Dunham@arm.com        print termcap.Yellow + termcap.Bold + \
98210456SCurtis.Dunham@arm.com              "You can get a 12% performance improvement by "\
98310456SCurtis.Dunham@arm.com              "installing tcmalloc (libgoogle-perftools-dev package "\
98410456SCurtis.Dunham@arm.com              "on Ubuntu or RedHat)." + termcap.Normal
9859045SAli.Saidi@ARM.com
98611235Sandreas.sandberg@arm.com
98711235Sandreas.sandberg@arm.com# Detect back trace implementations. The last implementation in the
98811235Sandreas.sandberg@arm.com# list will be used by default.
98911235Sandreas.sandberg@arm.combacktrace_impls = [ "none" ]
99011235Sandreas.sandberg@arm.com
99111235Sandreas.sandberg@arm.comif conf.CheckLibWithHeader(None, 'execinfo.h', 'C',
99211235Sandreas.sandberg@arm.com                           'backtrace_symbols_fd((void*)0, 0, 0);'):
99311235Sandreas.sandberg@arm.com    backtrace_impls.append("glibc")
99411235Sandreas.sandberg@arm.com
99511235Sandreas.sandberg@arm.comif backtrace_impls[-1] == "none":
99611235Sandreas.sandberg@arm.com    default_backtrace_impl = "none"
99711235Sandreas.sandberg@arm.com    print termcap.Yellow + termcap.Bold + \
99811235Sandreas.sandberg@arm.com        "No suitable back trace implementation found." + \
99911235Sandreas.sandberg@arm.com        termcap.Normal
100011235Sandreas.sandberg@arm.com
10017840Snate@binkert.orgif not have_posix_clock:
10027840Snate@binkert.org    print "Can't find library for POSIX clocks."
10037840Snate@binkert.org
10041858SN/A# Check for <fenv.h> (C99 FP environment control)
10051858SN/Ahave_fenv = conf.CheckHeader('fenv.h', '<>')
10061858SN/Aif not have_fenv:
10071858SN/A    print "Warning: Header file <fenv.h> not found."
10081858SN/A    print "         This host has no IEEE FP rounding mode control."
10091858SN/A
10109903Sandreas.hansson@arm.com# Check if we should enable KVM-based hardware virtualization. The API
10119903Sandreas.hansson@arm.com# we rely on exists since version 2.6.36 of the kernel, but somehow
10129903Sandreas.hansson@arm.com# the KVM_API_VERSION does not reflect the change. We test for one of
10139903Sandreas.hansson@arm.com# the types as a fall back.
101410841Sandreas.sandberg@arm.comhave_kvm = conf.CheckHeader('linux/kvm.h', '<>')
10159651SAndreas.Sandberg@ARM.comif not have_kvm:
10169903Sandreas.hansson@arm.com    print "Info: Compatible header file <linux/kvm.h> not found, " \
10179651SAndreas.Sandberg@ARM.com        "disabling KVM support."
10189651SAndreas.Sandberg@ARM.com
101910841Sandreas.sandberg@arm.com# x86 needs support for xsave. We test for the structure here since we
102010841Sandreas.sandberg@arm.com# won't be able to run new tests by the time we know which ISA we're
102110841Sandreas.sandberg@arm.com# targeting.
102210841Sandreas.sandberg@arm.comhave_kvm_xsave = conf.CheckTypeSize('struct kvm_xsave',
102310841Sandreas.sandberg@arm.com                                    '#include <linux/kvm.h>') != 0
102410841Sandreas.sandberg@arm.com
10259651SAndreas.Sandberg@ARM.com# Check if the requested target ISA is compatible with the host
10269651SAndreas.Sandberg@ARM.comdef is_isa_kvm_compatible(isa):
10279651SAndreas.Sandberg@ARM.com    try:
10289651SAndreas.Sandberg@ARM.com        import platform
10299651SAndreas.Sandberg@ARM.com        host_isa = platform.machine()
10309651SAndreas.Sandberg@ARM.com    except:
10319651SAndreas.Sandberg@ARM.com        print "Warning: Failed to determine host ISA."
10329651SAndreas.Sandberg@ARM.com        return False
10339651SAndreas.Sandberg@ARM.com
103410841Sandreas.sandberg@arm.com    if not have_posix_timers:
103510841Sandreas.sandberg@arm.com        print "Warning: Can not enable KVM, host seems to lack support " \
103610841Sandreas.sandberg@arm.com            "for POSIX timers"
103710841Sandreas.sandberg@arm.com        return False
103810841Sandreas.sandberg@arm.com
103910841Sandreas.sandberg@arm.com    if isa == "arm":
104010860Sandreas.sandberg@arm.com        return host_isa in ( "armv7l", "aarch64" )
104110841Sandreas.sandberg@arm.com    elif isa == "x86":
104210841Sandreas.sandberg@arm.com        if host_isa != "x86_64":
104310841Sandreas.sandberg@arm.com            return False
104410841Sandreas.sandberg@arm.com
104510841Sandreas.sandberg@arm.com        if not have_kvm_xsave:
104610841Sandreas.sandberg@arm.com            print "KVM on x86 requires xsave support in kernel headers."
104710841Sandreas.sandberg@arm.com            return False
104810841Sandreas.sandberg@arm.com
104910841Sandreas.sandberg@arm.com        return True
105010841Sandreas.sandberg@arm.com    else:
105110841Sandreas.sandberg@arm.com        return False
10529651SAndreas.Sandberg@ARM.com
10539651SAndreas.Sandberg@ARM.com
10549986Sandreas@sandberg.pp.se# Check if the exclude_host attribute is available. We want this to
10559986Sandreas@sandberg.pp.se# get accurate instruction counts in KVM.
10569986Sandreas@sandberg.pp.semain['HAVE_PERF_ATTR_EXCLUDE_HOST'] = conf.CheckMember(
10579986Sandreas@sandberg.pp.se    'linux/perf_event.h', 'struct perf_event_attr', 'exclude_host')
10589986Sandreas@sandberg.pp.se
10599986Sandreas@sandberg.pp.se
10605863Snate@binkert.org######################################################################
10615863Snate@binkert.org#
10625863Snate@binkert.org# Finish the configuration
10635863Snate@binkert.org#
10646121Snate@binkert.orgmain = conf.Finish()
10651858SN/A
10665863Snate@binkert.org######################################################################
10675863Snate@binkert.org#
10685863Snate@binkert.org# Collect all non-global variables
10695863Snate@binkert.org#
10705863Snate@binkert.org
10712139SN/A# Define the universe of supported ISAs
10724202Sbinkertn@umich.eduall_isa_list = [ ]
10734202Sbinkertn@umich.eduExport('all_isa_list')
10742139SN/A
10756994Snate@binkert.orgclass CpuModel(object):
10766994Snate@binkert.org    '''The CpuModel class encapsulates everything the ISA parser needs to
10776994Snate@binkert.org    know about a particular CPU model.'''
10786994Snate@binkert.org
10796994Snate@binkert.org    # Dict of available CPU model objects.  Accessible as CpuModel.dict.
10806994Snate@binkert.org    dict = {}
10816994Snate@binkert.org
10826994Snate@binkert.org    # Constructor.  Automatically adds models to CpuModel.dict.
108310319SAndreas.Sandberg@ARM.com    def __init__(self, name, default=False):
10846994Snate@binkert.org        self.name = name           # name of model
10856994Snate@binkert.org
10866994Snate@binkert.org        # This cpu is enabled by default
10876994Snate@binkert.org        self.default = default
10886994Snate@binkert.org
10896994Snate@binkert.org        # Add self to dict
10906994Snate@binkert.org        if name in CpuModel.dict:
10916994Snate@binkert.org            raise AttributeError, "CpuModel '%s' already registered" % name
10926994Snate@binkert.org        CpuModel.dict[name] = self
10936994Snate@binkert.org
10946994Snate@binkert.orgExport('CpuModel')
10952155SN/A
10965863Snate@binkert.org# Sticky variables get saved in the variables file so they persist from
10971869SN/A# one invocation to the next (unless overridden, in which case the new
10981869SN/A# value becomes sticky).
10995863Snate@binkert.orgsticky_vars = Variables(args=ARGUMENTS)
11005863Snate@binkert.orgExport('sticky_vars')
11014202Sbinkertn@umich.edu
11026108Snate@binkert.org# Sticky variables that should be exported
11036108Snate@binkert.orgexport_vars = []
11046108Snate@binkert.orgExport('export_vars')
11056108Snate@binkert.org
11069219Spower.jg@gmail.com# For Ruby
11079219Spower.jg@gmail.comall_protocols = []
11089219Spower.jg@gmail.comExport('all_protocols')
11099219Spower.jg@gmail.comprotocol_dirs = []
11109219Spower.jg@gmail.comExport('protocol_dirs')
11119219Spower.jg@gmail.comslicc_includes = []
11129219Spower.jg@gmail.comExport('slicc_includes')
11139219Spower.jg@gmail.com
11144202Sbinkertn@umich.edu# Walk the tree and execute all SConsopts scripts that wil add to the
11155863Snate@binkert.org# above variables
111610135SCurtis.Dunham@arm.comif GetOption('verbose'):
11178474Sgblack@eecs.umich.edu    print "Reading SConsopts"
11185742Snate@binkert.orgfor bdir in [ base_dir ] + extras_dir_list:
11198268Ssteve.reinhardt@amd.com    if not isdir(bdir):
11208268Ssteve.reinhardt@amd.com        print "Error: directory '%s' does not exist" % bdir
11218268Ssteve.reinhardt@amd.com        Exit(1)
11225742Snate@binkert.org    for root, dirs, files in os.walk(bdir):
11235341Sstever@gmail.com        if 'SConsopts' in files:
11248474Sgblack@eecs.umich.edu            if GetOption('verbose'):
11258474Sgblack@eecs.umich.edu                print "Reading", joinpath(root, 'SConsopts')
11265342Sstever@gmail.com            SConscript(joinpath(root, 'SConsopts'))
11274202Sbinkertn@umich.edu
11284202Sbinkertn@umich.eduall_isa_list.sort()
11294202Sbinkertn@umich.edu
11305863Snate@binkert.orgsticky_vars.AddVariables(
11315863Snate@binkert.org    EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list),
11326994Snate@binkert.org    ListVariable('CPU_MODELS', 'CPU models',
11336994Snate@binkert.org                 sorted(n for n,m in CpuModel.dict.iteritems() if m.default),
113410319SAndreas.Sandberg@ARM.com                 sorted(CpuModel.dict.keys())),
11355863Snate@binkert.org    BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
11365863Snate@binkert.org                 False),
11375863Snate@binkert.org    BoolVariable('SS_COMPATIBLE_FP',
11385863Snate@binkert.org                 'Make floating-point results compatible with SimpleScalar',
11395863Snate@binkert.org                 False),
11405863Snate@binkert.org    BoolVariable('USE_SSE2',
11415863Snate@binkert.org                 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
11425863Snate@binkert.org                 False),
11437840Snate@binkert.org    BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock),
11445863Snate@binkert.org    BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
11455952Ssaidi@eecs.umich.edu    BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False),
11469651SAndreas.Sandberg@ARM.com    BoolVariable('USE_KVM', 'Enable hardware virtualized (KVM) CPU models', have_kvm),
11479219Spower.jg@gmail.com    EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None',
11489219Spower.jg@gmail.com                  all_protocols),
114911235Sandreas.sandberg@arm.com    EnumVariable('BACKTRACE_IMPL', 'Post-mortem dump implementation',
115011235Sandreas.sandberg@arm.com                 backtrace_impls[-1], backtrace_impls)
11511869SN/A    )
11521858SN/A
11535863Snate@binkert.org# These variables get exported to #defines in config/*.hh (see src/SConscript).
11549420Sandreas.hansson@arm.comexport_vars += ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'CP_ANNOTATE',
115510607Sgabeblack@google.com                'USE_POSIX_CLOCK', 'USE_KVM', 'PROTOCOL', 'HAVE_PROTOBUF',
11569986Sandreas@sandberg.pp.se                'HAVE_PERF_ATTR_EXCLUDE_HOST']
11571858SN/A
1158955SN/A###################################################
1159955SN/A#
11601869SN/A# Define a SCons builder for configuration flag headers.
11611869SN/A#
11621869SN/A###################################################
11631869SN/A
11641869SN/A# This function generates a config header file that #defines the
11655863Snate@binkert.org# variable symbol to the current variable setting (0 or 1).  The source
11665863Snate@binkert.org# operands are the name of the variable and a Value node containing the
11675863Snate@binkert.org# value of the variable.
11681869SN/Adef build_config_file(target, source, env):
11695863Snate@binkert.org    (variable, value) = [s.get_contents() for s in source]
11701869SN/A    f = file(str(target[0]), 'w')
11715863Snate@binkert.org    print >> f, '#define', variable, value
11721869SN/A    f.close()
11731869SN/A    return None
11741869SN/A
11751869SN/A# Combine the two functions into a scons Action object.
11768483Sgblack@eecs.umich.educonfig_action = MakeAction(build_config_file, Transform("CONFIG H", 2))
11771869SN/A
11781869SN/A# The emitter munges the source & target node lists to reflect what
11791869SN/A# we're really doing.
11801869SN/Adef config_emitter(target, source, env):
11815863Snate@binkert.org    # extract variable name from Builder arg
11825863Snate@binkert.org    variable = str(target[0])
11831869SN/A    # True target is config header file
11845863Snate@binkert.org    target = joinpath('config', variable.lower() + '.hh')
11855863Snate@binkert.org    val = env[variable]
11863356Sbinkertn@umich.edu    if isinstance(val, bool):
11873356Sbinkertn@umich.edu        # Force value to 0/1
11883356Sbinkertn@umich.edu        val = int(val)
11893356Sbinkertn@umich.edu    elif isinstance(val, str):
11903356Sbinkertn@umich.edu        val = '"' + val + '"'
11914781Snate@binkert.org
11925863Snate@binkert.org    # Sources are variable name & value (packaged in SCons Value nodes)
11935863Snate@binkert.org    return ([target], [Value(variable), Value(val)])
11941869SN/A
11951869SN/Aconfig_builder = Builder(emitter = config_emitter, action = config_action)
11961869SN/A
11976121Snate@binkert.orgmain.Append(BUILDERS = { 'ConfigFile' : config_builder })
11981869SN/A
11992638Sstever@eecs.umich.edu# libelf build is shared across all configs in the build root.
12006121Snate@binkert.orgmain.SConscript('ext/libelf/SConscript',
12016121Snate@binkert.org                variant_dir = joinpath(build_root, 'libelf'))
12022638Sstever@eecs.umich.edu
120311293Sandreas.hansson@arm.com# iostream3 build is shared across all configs in the build root.
120411293Sandreas.hansson@arm.commain.SConscript('ext/iostream3/SConscript',
120511293Sandreas.hansson@arm.com                variant_dir = joinpath(build_root, 'iostream3'))
12065749Scws3k@cs.virginia.edu
12079537Satgutier@umich.edu# libfdt build is shared across all configs in the build root.
12089537Satgutier@umich.edumain.SConscript('ext/libfdt/SConscript',
12099537Satgutier@umich.edu                variant_dir = joinpath(build_root, 'libfdt'))
12109537Satgutier@umich.edu
12119888Sandreas@sandberg.pp.se# fputils build is shared across all configs in the build root.
12129888Sandreas@sandberg.pp.semain.SConscript('ext/fputils/SConscript',
12139888Sandreas@sandberg.pp.se                variant_dir = joinpath(build_root, 'fputils'))
12149888Sandreas@sandberg.pp.se
121510066Sandreas.hansson@arm.com# DRAMSim2 build is shared across all configs in the build root.
121610066Sandreas.hansson@arm.commain.SConscript('ext/dramsim2/SConscript',
121710066Sandreas.hansson@arm.com                variant_dir = joinpath(build_root, 'dramsim2'))
121810066Sandreas.hansson@arm.com
121910428Sandreas.hansson@arm.com# DRAMPower build is shared across all configs in the build root.
122010428Sandreas.hansson@arm.commain.SConscript('ext/drampower/SConscript',
122110428Sandreas.hansson@arm.com                variant_dir = joinpath(build_root, 'drampower'))
122210428Sandreas.hansson@arm.com
122310915Sandreas.sandberg@arm.com# nomali build is shared across all configs in the build root.
122410915Sandreas.sandberg@arm.commain.SConscript('ext/nomali/SConscript',
122510915Sandreas.sandberg@arm.com                variant_dir = joinpath(build_root, 'nomali'))
122610915Sandreas.sandberg@arm.com
12271869SN/A###################################################
12281869SN/A#
12293546Sgblack@eecs.umich.edu# This function is used to set up a directory with switching headers
12303546Sgblack@eecs.umich.edu#
12313546Sgblack@eecs.umich.edu###################################################
12323546Sgblack@eecs.umich.edu
12336121Snate@binkert.orgmain['ALL_ISA_LIST'] = all_isa_list
123410196SCurtis.Dunham@arm.comall_isa_deps = {}
12355863Snate@binkert.orgdef make_switching_dir(dname, switch_headers, env):
12363546Sgblack@eecs.umich.edu    # Generate the header.  target[0] is the full path of the output
12373546Sgblack@eecs.umich.edu    # header to generate.  'source' is a dummy variable, since we get the
12383546Sgblack@eecs.umich.edu    # list of ISAs from env['ALL_ISA_LIST'].
12393546Sgblack@eecs.umich.edu    def gen_switch_hdr(target, source, env):
12404781Snate@binkert.org        fname = str(target[0])
12416658Snate@binkert.org        isa = env['TARGET_ISA'].lower()
124210196SCurtis.Dunham@arm.com        try:
124310196SCurtis.Dunham@arm.com            f = open(fname, 'w')
124410196SCurtis.Dunham@arm.com            print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname))
124510196SCurtis.Dunham@arm.com            f.close()
124610196SCurtis.Dunham@arm.com        except IOError:
124710196SCurtis.Dunham@arm.com            print "Failed to create %s" % fname
124810196SCurtis.Dunham@arm.com            raise
12493546Sgblack@eecs.umich.edu
12503546Sgblack@eecs.umich.edu    # Build SCons Action object. 'varlist' specifies env vars that this
12513546Sgblack@eecs.umich.edu    # action depends on; when env['ALL_ISA_LIST'] changes these actions
12523546Sgblack@eecs.umich.edu    # should get re-executed.
12537756SAli.Saidi@ARM.com    switch_hdr_action = MakeAction(gen_switch_hdr,
12547816Ssteve.reinhardt@amd.com                          Transform("GENERATE"), varlist=['ALL_ISA_LIST'])
12553546Sgblack@eecs.umich.edu
12563546Sgblack@eecs.umich.edu    # Instantiate actions for each header
12573546Sgblack@eecs.umich.edu    for hdr in switch_headers:
12583546Sgblack@eecs.umich.edu        env.Command(hdr, [], switch_hdr_action)
125910196SCurtis.Dunham@arm.com
126010196SCurtis.Dunham@arm.com    isa_target = Dir('.').up().name.lower().replace('_', '-')
126110196SCurtis.Dunham@arm.com    env['PHONY_BASE'] = '#'+isa_target
126210196SCurtis.Dunham@arm.com    all_isa_deps[isa_target] = None
126310196SCurtis.Dunham@arm.com
12644202Sbinkertn@umich.eduExport('make_switching_dir')
12653546Sgblack@eecs.umich.edu
126610196SCurtis.Dunham@arm.com# all-isas -> all-deps -> all-environs -> all_targets
126710196SCurtis.Dunham@arm.commain.Alias('#all-isas', [])
126810196SCurtis.Dunham@arm.commain.Alias('#all-deps', '#all-isas')
126910196SCurtis.Dunham@arm.com
127010196SCurtis.Dunham@arm.com# Dummy target to ensure all environments are created before telling
127110196SCurtis.Dunham@arm.com# SCons what to actually make (the command line arguments).  We attach
127210196SCurtis.Dunham@arm.com# them to the dependence graph after the environments are complete.
127310196SCurtis.Dunham@arm.comORIG_BUILD_TARGETS = list(BUILD_TARGETS) # force a copy; gets closure to work.
127410196SCurtis.Dunham@arm.comdef environsComplete(target, source, env):
127510196SCurtis.Dunham@arm.com    for t in ORIG_BUILD_TARGETS:
127610196SCurtis.Dunham@arm.com        main.Depends('#all-targets', t)
127710196SCurtis.Dunham@arm.com
127810196SCurtis.Dunham@arm.com# Each build/* switching_dir attaches its *-environs target to #all-environs.
127910196SCurtis.Dunham@arm.commain.Append(BUILDERS = {'CompleteEnvirons' :
128010196SCurtis.Dunham@arm.com                        Builder(action=MakeAction(environsComplete, None))})
128110196SCurtis.Dunham@arm.commain.CompleteEnvirons('#all-environs', [])
128210196SCurtis.Dunham@arm.com
128310196SCurtis.Dunham@arm.comdef doNothing(**ignored): pass
128410196SCurtis.Dunham@arm.commain.Append(BUILDERS = {'Dummy': Builder(action=MakeAction(doNothing, None))})
128510196SCurtis.Dunham@arm.com
128610196SCurtis.Dunham@arm.com# The final target to which all the original targets ultimately get attached.
128710196SCurtis.Dunham@arm.commain.Dummy('#all-targets', '#all-environs')
128810196SCurtis.Dunham@arm.comBUILD_TARGETS[:] = ['#all-targets']
128910196SCurtis.Dunham@arm.com
12903546Sgblack@eecs.umich.edu###################################################
12913546Sgblack@eecs.umich.edu#
1292955SN/A# Define build environments for selected configurations.
1293955SN/A#
1294955SN/A###################################################
1295955SN/A
12965863Snate@binkert.orgfor variant_path in variant_paths:
129710135SCurtis.Dunham@arm.com    if not GetOption('silent'):
129810135SCurtis.Dunham@arm.com        print "Building in", variant_path
12995343Sstever@gmail.com
13005343Sstever@gmail.com    # Make a copy of the build-root environment to use for this config.
13016121Snate@binkert.org    env = main.Clone()
13025863Snate@binkert.org    env['BUILDDIR'] = variant_path
13034773Snate@binkert.org
13045863Snate@binkert.org    # variant_dir is the tail component of build path, and is used to
13052632Sstever@eecs.umich.edu    # determine the build parameters (e.g., 'ALPHA_SE')
13065863Snate@binkert.org    (build_root, variant_dir) = splitpath(variant_path)
13072023SN/A
13085863Snate@binkert.org    # Set env variables according to the build directory config.
13095863Snate@binkert.org    sticky_vars.files = []
13105863Snate@binkert.org    # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
13115863Snate@binkert.org    # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
13125863Snate@binkert.org    # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
13135863Snate@binkert.org    current_vars_file = joinpath(build_root, 'variables', variant_dir)
13145863Snate@binkert.org    if isfile(current_vars_file):
13155863Snate@binkert.org        sticky_vars.files.append(current_vars_file)
131610135SCurtis.Dunham@arm.com        if not GetOption('silent'):
131710135SCurtis.Dunham@arm.com            print "Using saved variables file %s" % current_vars_file
13182632Sstever@eecs.umich.edu    else:
13195863Snate@binkert.org        # Build dir-specific variables file doesn't exist.
13202023SN/A
13212632Sstever@eecs.umich.edu        # Make sure the directory is there so we can create it later
13225863Snate@binkert.org        opt_dir = dirname(current_vars_file)
13235342Sstever@gmail.com        if not isdir(opt_dir):
13245863Snate@binkert.org            mkdir(opt_dir)
13252632Sstever@eecs.umich.edu
13265863Snate@binkert.org        # Get default build variables from source tree.  Variables are
13275863Snate@binkert.org        # normally determined by name of $VARIANT_DIR, but can be
13288267Ssteve.reinhardt@amd.com        # overridden by '--default=' arg on command line.
13298120Sgblack@eecs.umich.edu        default = GetOption('default')
13308267Ssteve.reinhardt@amd.com        opts_dir = joinpath(main.root.abspath, 'build_opts')
13318267Ssteve.reinhardt@amd.com        if default:
13328267Ssteve.reinhardt@amd.com            default_vars_files = [joinpath(build_root, 'variables', default),
13338267Ssteve.reinhardt@amd.com                                  joinpath(opts_dir, default)]
13348267Ssteve.reinhardt@amd.com        else:
13358267Ssteve.reinhardt@amd.com            default_vars_files = [joinpath(opts_dir, variant_dir)]
13368267Ssteve.reinhardt@amd.com        existing_files = filter(isfile, default_vars_files)
13378267Ssteve.reinhardt@amd.com        if existing_files:
13388267Ssteve.reinhardt@amd.com            default_vars_file = existing_files[0]
13395863Snate@binkert.org            sticky_vars.files.append(default_vars_file)
13405863Snate@binkert.org            print "Variables file %s not found,\n  using defaults in %s" \
13415863Snate@binkert.org                  % (current_vars_file, default_vars_file)
13422632Sstever@eecs.umich.edu        else:
13438267Ssteve.reinhardt@amd.com            print "Error: cannot find variables file %s or " \
13448267Ssteve.reinhardt@amd.com                  "default file(s) %s" \
13458267Ssteve.reinhardt@amd.com                  % (current_vars_file, ' or '.join(default_vars_files))
13462632Sstever@eecs.umich.edu            Exit(1)
13471888SN/A
13485863Snate@binkert.org    # Apply current variable settings to env
13495863Snate@binkert.org    sticky_vars.Update(env)
13501858SN/A
13518120Sgblack@eecs.umich.edu    help_texts["local_vars"] += \
13528120Sgblack@eecs.umich.edu        "Build variables for %s:\n" % variant_dir \
13537756SAli.Saidi@ARM.com                 + sticky_vars.GenerateHelpText(env)
13542598SN/A
13555863Snate@binkert.org    # Process variable settings.
13561858SN/A
13571858SN/A    if not have_fenv and env['USE_FENV']:
13581858SN/A        print "Warning: <fenv.h> not available; " \
13595863Snate@binkert.org              "forcing USE_FENV to False in", variant_dir + "."
13601858SN/A        env['USE_FENV'] = False
13611858SN/A
13621858SN/A    if not env['USE_FENV']:
13635863Snate@binkert.org        print "Warning: No IEEE FP rounding mode control in", variant_dir + "."
13641871SN/A        print "         FP results may deviate slightly from other platforms."
13651858SN/A
13661858SN/A    if env['EFENCE']:
13671858SN/A        env.Append(LIBS=['efence'])
13681858SN/A
13699651SAndreas.Sandberg@ARM.com    if env['USE_KVM']:
13709651SAndreas.Sandberg@ARM.com        if not have_kvm:
13719651SAndreas.Sandberg@ARM.com            print "Warning: Can not enable KVM, host seems to lack KVM support"
13729651SAndreas.Sandberg@ARM.com            env['USE_KVM'] = False
13739651SAndreas.Sandberg@ARM.com        elif not is_isa_kvm_compatible(env['TARGET_ISA']):
13749651SAndreas.Sandberg@ARM.com            print "Info: KVM support disabled due to unsupported host and " \
13759651SAndreas.Sandberg@ARM.com                "target ISA combination"
13769651SAndreas.Sandberg@ARM.com            env['USE_KVM'] = False
13779651SAndreas.Sandberg@ARM.com
13789986Sandreas@sandberg.pp.se    # Warn about missing optional functionality
13799986Sandreas@sandberg.pp.se    if env['USE_KVM']:
13809986Sandreas@sandberg.pp.se        if not main['HAVE_PERF_ATTR_EXCLUDE_HOST']:
13819986Sandreas@sandberg.pp.se            print "Warning: perf_event headers lack support for the " \
13829986Sandreas@sandberg.pp.se                "exclude_host attribute. KVM instruction counts will " \
13839986Sandreas@sandberg.pp.se                "be inaccurate."
13849986Sandreas@sandberg.pp.se
13855863Snate@binkert.org    # Save sticky variable settings back to current variables file
13865863Snate@binkert.org    sticky_vars.Save(current_vars_file, env)
13871869SN/A
13881965SN/A    if env['USE_SSE2']:
13897739Sgblack@eecs.umich.edu        env.Append(CCFLAGS=['-msse2'])
13901965SN/A
13912761Sstever@eecs.umich.edu    # The src/SConscript file sets up the build rules in 'env' according
13925863Snate@binkert.org    # to the configured variables.  It returns a list of environments,
13931869SN/A    # one for each variant build (debug, opt, etc.)
139410196SCurtis.Dunham@arm.com    SConscript('src/SConscript', variant_dir = variant_path, exports = 'env')
13951869SN/A
139610196SCurtis.Dunham@arm.comdef pairwise(iterable):
139710196SCurtis.Dunham@arm.com    "s -> (s0,s1), (s1,s2), (s2, s3), ..."
139810196SCurtis.Dunham@arm.com    a, b = itertools.tee(iterable)
139910196SCurtis.Dunham@arm.com    b.next()
140010196SCurtis.Dunham@arm.com    return itertools.izip(a, b)
140110196SCurtis.Dunham@arm.com
140210196SCurtis.Dunham@arm.com# Create false dependencies so SCons will parse ISAs, establish
140310196SCurtis.Dunham@arm.com# dependencies, and setup the build Environments serially. Either
140410196SCurtis.Dunham@arm.com# SCons (likely) and/or our SConscripts (possibly) cannot cope with -j
140510196SCurtis.Dunham@arm.com# greater than 1. It appears to be standard race condition stuff; it
140610196SCurtis.Dunham@arm.com# doesn't always fail, but usually, and the behaviors are different.
140710196SCurtis.Dunham@arm.com# Every time I tried to remove this, builds would fail in some
140810196SCurtis.Dunham@arm.com# creative new way. So, don't do that. You'll want to, though, because
140910196SCurtis.Dunham@arm.com# tests/SConscript takes a long time to make its Environments.
141010196SCurtis.Dunham@arm.comfor t1, t2 in pairwise(sorted(all_isa_deps.iterkeys())):
141110196SCurtis.Dunham@arm.com    main.Depends('#%s-deps'     % t2, '#%s-deps'     % t1)
141210196SCurtis.Dunham@arm.com    main.Depends('#%s-environs' % t2, '#%s-environs' % t1)
1413955SN/A
14148120Sgblack@eecs.umich.edu# base help text
14158120Sgblack@eecs.umich.eduHelp('''
14168120Sgblack@eecs.umich.eduUsage: scons [scons options] [build variables] [target(s)]
14178120Sgblack@eecs.umich.edu
14188120Sgblack@eecs.umich.eduExtra scons options:
14198120Sgblack@eecs.umich.edu%(options)s
14208120Sgblack@eecs.umich.edu
14218120Sgblack@eecs.umich.eduGlobal build variables:
14228120Sgblack@eecs.umich.edu%(global_vars)s
14238120Sgblack@eecs.umich.edu
14248120Sgblack@eecs.umich.edu%(local_vars)s
14258120Sgblack@eecs.umich.edu''' % help_texts)
1426