SConstruct revision 10841
1955SN/A# -*- mode:python -*-
2955SN/A
39812Sandreas.hansson@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")
1768879Ssteve.reinhardt@amd.comAddLocalOption('--with-cxx-config', dest='with_cxx_config',
1778879Ssteve.reinhardt@amd.com               action='store_true',
1788879Ssteve.reinhardt@amd.com               help="Build with support for C++-based configuration")
1798879Ssteve.reinhardt@amd.comAddLocalOption('--default', dest='default', type='string', action='store',
1809227Sandreas.hansson@arm.com               help='Override which build_opts file to use for defaults')
1819227Sandreas.hansson@arm.comAddLocalOption('--ignore-style', dest='ignore_style', action='store_true',
1828879Ssteve.reinhardt@amd.com               help='Disable style checking hooks')
1838879Ssteve.reinhardt@amd.comAddLocalOption('--no-lto', dest='no_lto', action='store_true',
1848879Ssteve.reinhardt@amd.com               help='Disable Link-Time Optimization for fast')
1858879Ssteve.reinhardt@amd.comAddLocalOption('--update-ref', dest='update_ref', action='store_true',
1868120Sgblack@eecs.umich.edu               help='Update test reference outputs')
1878947Sandreas.hansson@arm.comAddLocalOption('--verbose', dest='verbose', action='store_true',
1887816Ssteve.reinhardt@amd.com               help='Print full tool command lines')
1895871Snate@binkert.orgAddLocalOption('--without-python', dest='without_python',
1905871Snate@binkert.org               action='store_true',
1916121Snate@binkert.org               help='Build without Python configuration support')
1925871Snate@binkert.orgAddLocalOption('--without-tcmalloc', dest='without_tcmalloc',
1935871Snate@binkert.org               action='store_true',
1949926Sstan.czerniawski@arm.com               help='Disable linking against tcmalloc')
1959926Sstan.czerniawski@arm.comAddLocalOption('--with-ubsan', dest='with_ubsan', action='store_true',
1969119Sandreas.hansson@arm.com               help='Build with Undefined Behavior Sanitizer if available')
19710068Sandreas.hansson@arm.com
19810068Sandreas.hansson@arm.comtermcap = get_termcap(GetOption('use_colors'))
199955SN/A
2009416SAndreas.Sandberg@ARM.com########################################################################
2019416SAndreas.Sandberg@ARM.com#
2029416SAndreas.Sandberg@ARM.com# Set up the main build environment.
2039416SAndreas.Sandberg@ARM.com#
2049416SAndreas.Sandberg@ARM.com########################################################################
2059416SAndreas.Sandberg@ARM.com
2069416SAndreas.Sandberg@ARM.com# export TERM so that clang reports errors in color
2075871Snate@binkert.orguse_vars = set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH',
2085871Snate@binkert.org                 'LIBRARY_PATH', 'PATH', 'PKG_CONFIG_PATH', 'PROTOC',
2099416SAndreas.Sandberg@ARM.com                 'PYTHONPATH', 'RANLIB', 'SWIG', 'TERM' ])
2109416SAndreas.Sandberg@ARM.com
2115871Snate@binkert.orguse_prefixes = [
212955SN/A    "M5",           # M5 configuration (e.g., path to kernels)
2136121Snate@binkert.org    "DISTCC_",      # distcc (distributed compiler wrapper) configuration
2148881Smarc.orr@gmail.com    "CCACHE_",      # ccache (caching compiler wrapper) configuration
2156121Snate@binkert.org    "CCC_",         # clang static analyzer configuration
2166121Snate@binkert.org    ]
2171533SN/A
2189239Sandreas.hansson@arm.comuse_env = {}
2199239Sandreas.hansson@arm.comfor key,val in sorted(os.environ.iteritems()):
2209239Sandreas.hansson@arm.com    if key in use_vars or \
2219239Sandreas.hansson@arm.com            any([key.startswith(prefix) for prefix in use_prefixes]):
2229239Sandreas.hansson@arm.com        use_env[key] = val
2239239Sandreas.hansson@arm.com
2249239Sandreas.hansson@arm.com# Tell scons to avoid implicit command dependencies to avoid issues
2259239Sandreas.hansson@arm.com# with the param wrappes being compiled twice (see
2269239Sandreas.hansson@arm.com# http://scons.tigris.org/issues/show_bug.cgi?id=2811)
2279239Sandreas.hansson@arm.commain = Environment(ENV=use_env, IMPLICIT_COMMAND_DEPENDENCIES=0)
2289239Sandreas.hansson@arm.commain.Decider('MD5-timestamp')
2299239Sandreas.hansson@arm.commain.root = Dir(".")         # The current directory (where this file lives).
2306655Snate@binkert.orgmain.srcdir = Dir("src")     # The source directory
2316655Snate@binkert.org
2326655Snate@binkert.orgmain_dict_keys = main.Dictionary().keys()
2336655Snate@binkert.org
2345871Snate@binkert.org# Check that we have a C/C++ compiler
2355871Snate@binkert.orgif not ('CC' in main_dict_keys and 'CXX' in main_dict_keys):
2365863Snate@binkert.org    print "No C++ compiler installed (package g++ on Ubuntu and RedHat)"
2375871Snate@binkert.org    Exit(1)
2388878Ssteve.reinhardt@amd.com
2395871Snate@binkert.org# Check that swig is present
2405871Snate@binkert.orgif not 'SWIG' in main_dict_keys:
2415871Snate@binkert.org    print "swig is not installed (package swig on Ubuntu and RedHat)"
2425863Snate@binkert.org    Exit(1)
2436121Snate@binkert.org
2445863Snate@binkert.org# add useful python code PYTHONPATH so it can be used by subprocesses
2455871Snate@binkert.org# as well
2468336Ssteve.reinhardt@amd.commain.AppendENVPath('PYTHONPATH', extra_python_paths)
2478336Ssteve.reinhardt@amd.com
2488336Ssteve.reinhardt@amd.com########################################################################
2498336Ssteve.reinhardt@amd.com#
2504678Snate@binkert.org# Mercurial Stuff.
2518336Ssteve.reinhardt@amd.com#
2528336Ssteve.reinhardt@amd.com# If the gem5 directory is a mercurial repository, we should do some
2538336Ssteve.reinhardt@amd.com# extra things.
2544678Snate@binkert.org#
2554678Snate@binkert.org########################################################################
2564678Snate@binkert.org
2574678Snate@binkert.orghgdir = main.root.Dir(".hg")
2587827Snate@binkert.org
2597827Snate@binkert.orgmercurial_style_message = """
2608336Ssteve.reinhardt@amd.comYou're missing the gem5 style hook, which automatically checks your code
2614678Snate@binkert.orgagainst the gem5 style rules on hg commit and qrefresh commands.  This
2628336Ssteve.reinhardt@amd.comscript will now install the hook in your .hg/hgrc file.
2638336Ssteve.reinhardt@amd.comPress enter to continue, or ctrl-c to abort: """
2648336Ssteve.reinhardt@amd.com
2658336Ssteve.reinhardt@amd.commercurial_style_hook = """
2668336Ssteve.reinhardt@amd.com# The following lines were automatically added by gem5/SConstruct
2678336Ssteve.reinhardt@amd.com# to provide the gem5 style-checking hooks
2685871Snate@binkert.org[extensions]
2695871Snate@binkert.orgstyle = %s/util/style.py
2708336Ssteve.reinhardt@amd.com
2718336Ssteve.reinhardt@amd.com[hooks]
2728336Ssteve.reinhardt@amd.compretxncommit.style = python:style.check_style
2738336Ssteve.reinhardt@amd.compre-qrefresh.style = python:style.check_style
2748336Ssteve.reinhardt@amd.com# End of SConstruct additions
2755871Snate@binkert.org
2768336Ssteve.reinhardt@amd.com""" % (main.root.abspath)
2778336Ssteve.reinhardt@amd.com
2788336Ssteve.reinhardt@amd.commercurial_lib_not_found = """
2798336Ssteve.reinhardt@amd.comMercurial libraries cannot be found, ignoring style hook.  If
2808336Ssteve.reinhardt@amd.comyou are a gem5 developer, please fix this and run the style
2814678Snate@binkert.orghook. It is important.
2825871Snate@binkert.org"""
2834678Snate@binkert.org
2848336Ssteve.reinhardt@amd.com# Check for style hook and prompt for installation if it's not there.
2858336Ssteve.reinhardt@amd.com# Skip this if --ignore-style was specified, there's no .hg dir to
2868336Ssteve.reinhardt@amd.com# install a hook in, or there's no interactive terminal to prompt.
2878336Ssteve.reinhardt@amd.comif not GetOption('ignore_style') and hgdir.exists() and sys.stdin.isatty():
2888336Ssteve.reinhardt@amd.com    style_hook = True
2898336Ssteve.reinhardt@amd.com    try:
2908336Ssteve.reinhardt@amd.com        from mercurial import ui
2918336Ssteve.reinhardt@amd.com        ui = ui.ui()
2928336Ssteve.reinhardt@amd.com        ui.readconfig(hgdir.File('hgrc').abspath)
2938336Ssteve.reinhardt@amd.com        style_hook = ui.config('hooks', 'pretxncommit.style', None) and \
2948336Ssteve.reinhardt@amd.com                     ui.config('hooks', 'pre-qrefresh.style', None)
2958336Ssteve.reinhardt@amd.com    except ImportError:
2968336Ssteve.reinhardt@amd.com        print mercurial_lib_not_found
2978336Ssteve.reinhardt@amd.com
2988336Ssteve.reinhardt@amd.com    if not style_hook:
2998336Ssteve.reinhardt@amd.com        print mercurial_style_message,
3008336Ssteve.reinhardt@amd.com        # continue unless user does ctrl-c/ctrl-d etc.
3015871Snate@binkert.org        try:
3026121Snate@binkert.org            raw_input()
303955SN/A        except:
304955SN/A            print "Input exception, exiting scons.\n"
3052632Sstever@eecs.umich.edu            sys.exit(1)
3062632Sstever@eecs.umich.edu        hgrc_path = '%s/.hg/hgrc' % main.root.abspath
307955SN/A        print "Adding style hook to", hgrc_path, "\n"
308955SN/A        try:
309955SN/A            hgrc = open(hgrc_path, 'a')
310955SN/A            hgrc.write(mercurial_style_hook)
3118878Ssteve.reinhardt@amd.com            hgrc.close()
312955SN/A        except:
3132632Sstever@eecs.umich.edu            print "Error updating", hgrc_path
3142632Sstever@eecs.umich.edu            sys.exit(1)
3152632Sstever@eecs.umich.edu
3162632Sstever@eecs.umich.edu
3172632Sstever@eecs.umich.edu###################################################
3182632Sstever@eecs.umich.edu#
3192632Sstever@eecs.umich.edu# Figure out which configurations to set up based on the path(s) of
3208268Ssteve.reinhardt@amd.com# the target(s).
3218268Ssteve.reinhardt@amd.com#
3228268Ssteve.reinhardt@amd.com###################################################
3238268Ssteve.reinhardt@amd.com
3248268Ssteve.reinhardt@amd.com# Find default configuration & binary.
3258268Ssteve.reinhardt@amd.comDefault(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug'))
3268268Ssteve.reinhardt@amd.com
3272632Sstever@eecs.umich.edu# helper function: find last occurrence of element in list
3282632Sstever@eecs.umich.edudef rfind(l, elt, offs = -1):
3292632Sstever@eecs.umich.edu    for i in range(len(l)+offs, 0, -1):
3302632Sstever@eecs.umich.edu        if l[i] == elt:
3318268Ssteve.reinhardt@amd.com            return i
3322632Sstever@eecs.umich.edu    raise ValueError, "element not found"
3338268Ssteve.reinhardt@amd.com
3348268Ssteve.reinhardt@amd.com# Take a list of paths (or SCons Nodes) and return a list with all
3358268Ssteve.reinhardt@amd.com# paths made absolute and ~-expanded.  Paths will be interpreted
3368268Ssteve.reinhardt@amd.com# relative to the launch directory unless a different root is provided
3373718Sstever@eecs.umich.edudef makePathListAbsolute(path_list, root=GetLaunchDir()):
3382634Sstever@eecs.umich.edu    return [abspath(joinpath(root, expanduser(str(p))))
3392634Sstever@eecs.umich.edu            for p in path_list]
3405863Snate@binkert.org
3412638Sstever@eecs.umich.edu# Each target must have 'build' in the interior of the path; the
3428268Ssteve.reinhardt@amd.com# directory below this will determine the build parameters.  For
3432632Sstever@eecs.umich.edu# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
3442632Sstever@eecs.umich.edu# recognize that ALPHA_SE specifies the configuration because it
3452632Sstever@eecs.umich.edu# follow 'build' in the build path.
3462632Sstever@eecs.umich.edu
3472632Sstever@eecs.umich.edu# The funky assignment to "[:]" is needed to replace the list contents
3481858SN/A# in place rather than reassign the symbol to a new list, which
3493716Sstever@eecs.umich.edu# doesn't work (obviously!).
3502638Sstever@eecs.umich.eduBUILD_TARGETS[:] = makePathListAbsolute(BUILD_TARGETS)
3512638Sstever@eecs.umich.edu
3522638Sstever@eecs.umich.edu# Generate a list of the unique build roots and configs that the
3532638Sstever@eecs.umich.edu# collected targets reference.
3542638Sstever@eecs.umich.eduvariant_paths = []
3552638Sstever@eecs.umich.edubuild_root = None
3562638Sstever@eecs.umich.edufor t in BUILD_TARGETS:
3575863Snate@binkert.org    path_dirs = t.split('/')
3585863Snate@binkert.org    try:
3595863Snate@binkert.org        build_top = rfind(path_dirs, 'build', -2)
360955SN/A    except:
3615341Sstever@gmail.com        print "Error: no non-leaf 'build' dir found on target path", t
3625341Sstever@gmail.com        Exit(1)
3635863Snate@binkert.org    this_build_root = joinpath('/',*path_dirs[:build_top+1])
3647756SAli.Saidi@ARM.com    if not build_root:
3655341Sstever@gmail.com        build_root = this_build_root
3666121Snate@binkert.org    else:
3674494Ssaidi@eecs.umich.edu        if this_build_root != build_root:
3686121Snate@binkert.org            print "Error: build targets not under same build root\n"\
3691105SN/A                  "  %s\n  %s" % (build_root, this_build_root)
3702667Sstever@eecs.umich.edu            Exit(1)
3712667Sstever@eecs.umich.edu    variant_path = joinpath('/',*path_dirs[:build_top+2])
3722667Sstever@eecs.umich.edu    if variant_path not in variant_paths:
3732667Sstever@eecs.umich.edu        variant_paths.append(variant_path)
3746121Snate@binkert.org
3752667Sstever@eecs.umich.edu# Make sure build_root exists (might not if this is the first build there)
3765341Sstever@gmail.comif not isdir(build_root):
3775863Snate@binkert.org    mkdir(build_root)
3785341Sstever@gmail.commain['BUILDROOT'] = build_root
3795341Sstever@gmail.com
3805341Sstever@gmail.comExport('main')
3818120Sgblack@eecs.umich.edu
3825341Sstever@gmail.commain.SConsignFile(joinpath(build_root, "sconsign"))
3838120Sgblack@eecs.umich.edu
3845341Sstever@gmail.com# Default duplicate option is to use hard links, but this messes up
3858120Sgblack@eecs.umich.edu# when you use emacs to edit a file in the target dir, as emacs moves
3866121Snate@binkert.org# file to file~ then copies to file, breaking the link.  Symbolic
3876121Snate@binkert.org# (soft) links work better.
3888980Ssteve.reinhardt@amd.commain.SetOption('duplicate', 'soft-copy')
3899396Sandreas.hansson@arm.com
3905397Ssaidi@eecs.umich.edu#
3915397Ssaidi@eecs.umich.edu# Set up global sticky variables... these are common to an entire build
3927727SAli.Saidi@ARM.com# tree (not specific to a particular build like ALPHA_SE)
3938268Ssteve.reinhardt@amd.com#
3946168Snate@binkert.org
3955341Sstever@gmail.comglobal_vars_file = joinpath(build_root, 'variables.global')
3968120Sgblack@eecs.umich.edu
3978120Sgblack@eecs.umich.eduglobal_vars = Variables(global_vars_file, args=ARGUMENTS)
3988120Sgblack@eecs.umich.edu
3996814Sgblack@eecs.umich.eduglobal_vars.AddVariables(
4005863Snate@binkert.org    ('CC', 'C compiler', environ.get('CC', main['CC'])),
4018120Sgblack@eecs.umich.edu    ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])),
4025341Sstever@gmail.com    ('SWIG', 'SWIG tool', environ.get('SWIG', main['SWIG'])),
4035863Snate@binkert.org    ('PROTOC', 'protoc tool', environ.get('PROTOC', 'protoc')),
4048268Ssteve.reinhardt@amd.com    ('BATCH', 'Use batch pool for build and tests', False),
4056121Snate@binkert.org    ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
4066121Snate@binkert.org    ('M5_BUILD_CACHE', 'Cache built objects in this directory', False),
4078268Ssteve.reinhardt@amd.com    ('EXTRAS', 'Add extra directories to the compilation', '')
4085742Snate@binkert.org    )
4095742Snate@binkert.org
4105341Sstever@gmail.com# Update main environment with values from ARGUMENTS & global_vars_file
4115742Snate@binkert.orgglobal_vars.Update(main)
4125742Snate@binkert.orghelp_texts["global_vars"] += global_vars.GenerateHelpText(main)
4135341Sstever@gmail.com
4146017Snate@binkert.org# Save sticky variable settings back to current variables file
4156121Snate@binkert.orgglobal_vars.Save(global_vars_file, main)
4166017Snate@binkert.org
4177816Ssteve.reinhardt@amd.com# Parse EXTRAS variable to build list of all directories where we're
4187756SAli.Saidi@ARM.com# look for sources etc.  This list is exported as extras_dir_list.
4197756SAli.Saidi@ARM.combase_dir = main.srcdir.abspath
4207756SAli.Saidi@ARM.comif main['EXTRAS']:
4217756SAli.Saidi@ARM.com    extras_dir_list = makePathListAbsolute(main['EXTRAS'].split(':'))
4227756SAli.Saidi@ARM.comelse:
4237756SAli.Saidi@ARM.com    extras_dir_list = []
4247756SAli.Saidi@ARM.com
4257756SAli.Saidi@ARM.comExport('base_dir')
4267816Ssteve.reinhardt@amd.comExport('extras_dir_list')
4277816Ssteve.reinhardt@amd.com
4287816Ssteve.reinhardt@amd.com# the ext directory should be on the #includes path
4297816Ssteve.reinhardt@amd.commain.Append(CPPPATH=[Dir('ext')])
4307816Ssteve.reinhardt@amd.com
4317816Ssteve.reinhardt@amd.comdef strip_build_path(path, env):
4327816Ssteve.reinhardt@amd.com    path = str(path)
4337816Ssteve.reinhardt@amd.com    variant_base = env['BUILDROOT'] + os.path.sep
4347816Ssteve.reinhardt@amd.com    if path.startswith(variant_base):
4357816Ssteve.reinhardt@amd.com        path = path[len(variant_base):]
4367756SAli.Saidi@ARM.com    elif path.startswith('build/'):
4377816Ssteve.reinhardt@amd.com        path = path[6:]
4387816Ssteve.reinhardt@amd.com    return path
4397816Ssteve.reinhardt@amd.com
4407816Ssteve.reinhardt@amd.com# Generate a string of the form:
4417816Ssteve.reinhardt@amd.com#   common/path/prefix/src1, src2 -> tgt1, tgt2
4427816Ssteve.reinhardt@amd.com# to print while building.
4437816Ssteve.reinhardt@amd.comclass Transform(object):
4447816Ssteve.reinhardt@amd.com    # all specific color settings should be here and nowhere else
4457816Ssteve.reinhardt@amd.com    tool_color = termcap.Normal
4467816Ssteve.reinhardt@amd.com    pfx_color = termcap.Yellow
4477816Ssteve.reinhardt@amd.com    srcs_color = termcap.Yellow + termcap.Bold
4487816Ssteve.reinhardt@amd.com    arrow_color = termcap.Blue + termcap.Bold
4497816Ssteve.reinhardt@amd.com    tgts_color = termcap.Yellow + termcap.Bold
4507816Ssteve.reinhardt@amd.com
4517816Ssteve.reinhardt@amd.com    def __init__(self, tool, max_sources=99):
4527816Ssteve.reinhardt@amd.com        self.format = self.tool_color + (" [%8s] " % tool) \
4537816Ssteve.reinhardt@amd.com                      + self.pfx_color + "%s" \
4547816Ssteve.reinhardt@amd.com                      + self.srcs_color + "%s" \
4557816Ssteve.reinhardt@amd.com                      + self.arrow_color + " -> " \
4567816Ssteve.reinhardt@amd.com                      + self.tgts_color + "%s" \
4577816Ssteve.reinhardt@amd.com                      + termcap.Normal
4587816Ssteve.reinhardt@amd.com        self.max_sources = max_sources
4597816Ssteve.reinhardt@amd.com
4607816Ssteve.reinhardt@amd.com    def __call__(self, target, source, env, for_signature=None):
4617816Ssteve.reinhardt@amd.com        # truncate source list according to max_sources param
4627816Ssteve.reinhardt@amd.com        source = source[0:self.max_sources]
4637816Ssteve.reinhardt@amd.com        def strip(f):
4647816Ssteve.reinhardt@amd.com            return strip_build_path(str(f), env)
4657816Ssteve.reinhardt@amd.com        if len(source) > 0:
4667816Ssteve.reinhardt@amd.com            srcs = map(strip, source)
4677816Ssteve.reinhardt@amd.com        else:
4687816Ssteve.reinhardt@amd.com            srcs = ['']
4697816Ssteve.reinhardt@amd.com        tgts = map(strip, target)
4707816Ssteve.reinhardt@amd.com        # surprisingly, os.path.commonprefix is a dumb char-by-char string
4717816Ssteve.reinhardt@amd.com        # operation that has nothing to do with paths.
4727816Ssteve.reinhardt@amd.com        com_pfx = os.path.commonprefix(srcs + tgts)
4737816Ssteve.reinhardt@amd.com        com_pfx_len = len(com_pfx)
4747816Ssteve.reinhardt@amd.com        if com_pfx:
4757816Ssteve.reinhardt@amd.com            # do some cleanup and sanity checking on common prefix
4767816Ssteve.reinhardt@amd.com            if com_pfx[-1] == ".":
4777816Ssteve.reinhardt@amd.com                # prefix matches all but file extension: ok
4787816Ssteve.reinhardt@amd.com                # back up one to change 'foo.cc -> o' to 'foo.cc -> .o'
4797816Ssteve.reinhardt@amd.com                com_pfx = com_pfx[0:-1]
4807816Ssteve.reinhardt@amd.com            elif com_pfx[-1] == "/":
4817816Ssteve.reinhardt@amd.com                # common prefix is directory path: OK
4827816Ssteve.reinhardt@amd.com                pass
4837816Ssteve.reinhardt@amd.com            else:
4847816Ssteve.reinhardt@amd.com                src0_len = len(srcs[0])
4857816Ssteve.reinhardt@amd.com                tgt0_len = len(tgts[0])
4867816Ssteve.reinhardt@amd.com                if src0_len == com_pfx_len:
4877816Ssteve.reinhardt@amd.com                    # source is a substring of target, OK
4887816Ssteve.reinhardt@amd.com                    pass
4897816Ssteve.reinhardt@amd.com                elif tgt0_len == com_pfx_len:
4907816Ssteve.reinhardt@amd.com                    # target is a substring of source, need to back up to
4917816Ssteve.reinhardt@amd.com                    # avoid empty string on RHS of arrow
4927816Ssteve.reinhardt@amd.com                    sep_idx = com_pfx.rfind(".")
4937816Ssteve.reinhardt@amd.com                    if sep_idx != -1:
4947816Ssteve.reinhardt@amd.com                        com_pfx = com_pfx[0:sep_idx]
4957816Ssteve.reinhardt@amd.com                    else:
4967816Ssteve.reinhardt@amd.com                        com_pfx = ''
4977816Ssteve.reinhardt@amd.com                elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".":
4988947Sandreas.hansson@arm.com                    # still splitting at file extension: ok
4998947Sandreas.hansson@arm.com                    pass
5007756SAli.Saidi@ARM.com                else:
5018120Sgblack@eecs.umich.edu                    # probably a fluke; ignore it
5027756SAli.Saidi@ARM.com                    com_pfx = ''
5037756SAli.Saidi@ARM.com        # recalculate length in case com_pfx was modified
5047756SAli.Saidi@ARM.com        com_pfx_len = len(com_pfx)
5057756SAli.Saidi@ARM.com        def fmt(files):
5067816Ssteve.reinhardt@amd.com            f = map(lambda s: s[com_pfx_len:], files)
5077816Ssteve.reinhardt@amd.com            return ', '.join(f)
5087816Ssteve.reinhardt@amd.com        return self.format % (com_pfx, fmt(srcs), fmt(tgts))
5097816Ssteve.reinhardt@amd.com
5107816Ssteve.reinhardt@amd.comExport('Transform')
5117816Ssteve.reinhardt@amd.com
5127816Ssteve.reinhardt@amd.com# enable the regression script to use the termcap
5137816Ssteve.reinhardt@amd.commain['TERMCAP'] = termcap
5147816Ssteve.reinhardt@amd.com
5157816Ssteve.reinhardt@amd.comif GetOption('verbose'):
5167756SAli.Saidi@ARM.com    def MakeAction(action, string, *args, **kwargs):
5177756SAli.Saidi@ARM.com        return Action(action, *args, **kwargs)
5189227Sandreas.hansson@arm.comelse:
5199227Sandreas.hansson@arm.com    MakeAction = Action
5209227Sandreas.hansson@arm.com    main['CCCOMSTR']        = Transform("CC")
5219227Sandreas.hansson@arm.com    main['CXXCOMSTR']       = Transform("CXX")
5229590Sandreas@sandberg.pp.se    main['ASCOMSTR']        = Transform("AS")
5239590Sandreas@sandberg.pp.se    main['SWIGCOMSTR']      = Transform("SWIG")
5249590Sandreas@sandberg.pp.se    main['ARCOMSTR']        = Transform("AR", 0)
5259590Sandreas@sandberg.pp.se    main['LINKCOMSTR']      = Transform("LINK", 0)
5269590Sandreas@sandberg.pp.se    main['RANLIBCOMSTR']    = Transform("RANLIB", 0)
5279590Sandreas@sandberg.pp.se    main['M4COMSTR']        = Transform("M4")
5286654Snate@binkert.org    main['SHCCCOMSTR']      = Transform("SHCC")
5296654Snate@binkert.org    main['SHCXXCOMSTR']     = Transform("SHCXX")
5305871Snate@binkert.orgExport('MakeAction')
5316121Snate@binkert.org
5328946Sandreas.hansson@arm.com# Initialize the Link-Time Optimization (LTO) flags
5339419Sandreas.hansson@arm.commain['LTO_CCFLAGS'] = []
5343940Ssaidi@eecs.umich.edumain['LTO_LDFLAGS'] = []
5353918Ssaidi@eecs.umich.edu
5363918Ssaidi@eecs.umich.edu# According to the readme, tcmalloc works best if the compiler doesn't
5371858SN/A# assume that we're using the builtin malloc and friends. These flags
5389556Sandreas.hansson@arm.com# are compiler-specific, so we need to set them after we detect which
5399556Sandreas.hansson@arm.com# compiler we're using.
5409556Sandreas.hansson@arm.commain['TCMALLOC_CCFLAGS'] = []
5419556Sandreas.hansson@arm.com
5429556Sandreas.hansson@arm.comCXX_version = readCommand([main['CXX'],'--version'], exception=False)
5439556Sandreas.hansson@arm.comCXX_V = readCommand([main['CXX'],'-V'], exception=False)
5449556Sandreas.hansson@arm.com
5459556Sandreas.hansson@arm.commain['GCC'] = CXX_version and CXX_version.find('g++') >= 0
5469556Sandreas.hansson@arm.commain['CLANG'] = CXX_version and CXX_version.find('clang') >= 0
5479556Sandreas.hansson@arm.comif main['GCC'] + main['CLANG'] > 1:
5489556Sandreas.hansson@arm.com    print 'Error: How can we have two at the same time?'
5499556Sandreas.hansson@arm.com    Exit(1)
5509556Sandreas.hansson@arm.com
5519556Sandreas.hansson@arm.com# Set up default C++ compiler flags
5529556Sandreas.hansson@arm.comif main['GCC'] or main['CLANG']:
5539556Sandreas.hansson@arm.com    # As gcc and clang share many flags, do the common parts here
5549556Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-pipe'])
5559556Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-fno-strict-aliasing'])
5569556Sandreas.hansson@arm.com    # Enable -Wall and then disable the few warnings that we
5579556Sandreas.hansson@arm.com    # consistently violate
5589556Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef'])
5599556Sandreas.hansson@arm.com    # We always compile using C++11, but only gcc >= 4.7 and clang 3.1
5609556Sandreas.hansson@arm.com    # actually use that name, so we stick with c++0x
5619556Sandreas.hansson@arm.com    main.Append(CXXFLAGS=['-std=c++0x'])
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,
5706121Snate@binkert.org    if not CXX_version:
57110238Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\
57210238Sandreas.hansson@arm.com               termcap.Normal
57310238Sandreas.hansson@arm.com    else:
57410238Sandreas.hansson@arm.com        print CXX_version.replace('\n', '<nl>')
5759420Sandreas.hansson@arm.com    print "       If you're trying to use a compiler other than GCC"
57610238Sandreas.hansson@arm.com    print "       or clang, there appears to be something wrong with your"
57710238Sandreas.hansson@arm.com    print "       environment."
5789420Sandreas.hansson@arm.com    print "       "
5799420Sandreas.hansson@arm.com    print "       If you are trying to use a compiler other than those listed"
5809420Sandreas.hansson@arm.com    print "       above you will need to ease fix SConstruct and "
5819420Sandreas.hansson@arm.com    print "       src/SConscript to support that compiler."
5829420Sandreas.hansson@arm.com    Exit(1)
58310264Sandreas.hansson@arm.com
58410264Sandreas.hansson@arm.comif main['GCC']:
58510264Sandreas.hansson@arm.com    # Check for a supported version of gcc. >= 4.6 is chosen for its
58610264Sandreas.hansson@arm.com    # level of c++11 support. See
58710264Sandreas.hansson@arm.com    # http://gcc.gnu.org/projects/cxx0x.html for details. 4.6 is also
58810264Sandreas.hansson@arm.com    # the first version with proper LTO support.
58910264Sandreas.hansson@arm.com    gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False)
59010264Sandreas.hansson@arm.com    if compareVersions(gcc_version, "4.6") < 0:
59110264Sandreas.hansson@arm.com        print 'Error: gcc version 4.6 or newer required.'
59210264Sandreas.hansson@arm.com        print '       Installed version:', gcc_version
59310264Sandreas.hansson@arm.com        Exit(1)
59410264Sandreas.hansson@arm.com
59510264Sandreas.hansson@arm.com    main['GCC_VERSION'] = gcc_version
59610264Sandreas.hansson@arm.com
59710264Sandreas.hansson@arm.com    # gcc from version 4.8 and above generates "rep; ret" instructions
59810264Sandreas.hansson@arm.com    # to avoid performance penalties on certain AMD chips. Older
59910238Sandreas.hansson@arm.com    # assemblers detect this as an error, "Error: expecting string
60010238Sandreas.hansson@arm.com    # instruction after `rep'"
60110238Sandreas.hansson@arm.com    if compareVersions(gcc_version, "4.8") > 0:
60210238Sandreas.hansson@arm.com        as_version = readCommand([main['AS'], '-v', '/dev/null'],
60310238Sandreas.hansson@arm.com                                 exception=False).split()
60410238Sandreas.hansson@arm.com
60510238Sandreas.hansson@arm.com        if not as_version or compareVersions(as_version[-1], "2.23") < 0:
60610238Sandreas.hansson@arm.com            print termcap.Yellow + termcap.Bold + \
6079227Sandreas.hansson@arm.com                'Warning: This combination of gcc and binutils have' + \
60810238Sandreas.hansson@arm.com                ' known incompatibilities.\n' + \
60910238Sandreas.hansson@arm.com                '         If you encounter build problems, please update ' + \
61010238Sandreas.hansson@arm.com                'binutils to 2.23.' + \
61110238Sandreas.hansson@arm.com                termcap.Normal
61210238Sandreas.hansson@arm.com
6139227Sandreas.hansson@arm.com    # Make sure we warn if the user has requested to compile with the
6149590Sandreas@sandberg.pp.se    # Undefined Benahvior Sanitizer and this version of gcc does not
6159590Sandreas@sandberg.pp.se    # support it.
6169590Sandreas@sandberg.pp.se    if GetOption('with_ubsan') and \
6178737Skoansin.tan@gmail.com            compareVersions(gcc_version, '4.9') < 0:
61810238Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + \
61910238Sandreas.hansson@arm.com            'Warning: UBSan is only supported using gcc 4.9 and later.' + \
6209420Sandreas.hansson@arm.com            termcap.Normal
6218737Skoansin.tan@gmail.com
62210106SMitch.Hayenga@arm.com    # Add the appropriate Link-Time Optimization (LTO) flags
6238737Skoansin.tan@gmail.com    # unless LTO is explicitly turned off. Note that these flags
6248737Skoansin.tan@gmail.com    # are only used by the fast target.
62510238Sandreas.hansson@arm.com    if not GetOption('no_lto'):
62610238Sandreas.hansson@arm.com        # Pass the LTO flag when compiling to produce GIMPLE
6278737Skoansin.tan@gmail.com        # output, we merely create the flags here and only append
6288737Skoansin.tan@gmail.com        # them later
6298737Skoansin.tan@gmail.com        main['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
6308737Skoansin.tan@gmail.com
6318737Skoansin.tan@gmail.com        # Use the same amount of jobs for LTO as we are running
6328737Skoansin.tan@gmail.com        # scons with
6339556Sandreas.hansson@arm.com        main['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
6349556Sandreas.hansson@arm.com
6359556Sandreas.hansson@arm.com    main.Append(TCMALLOC_CCFLAGS=['-fno-builtin-malloc', '-fno-builtin-calloc',
6369556Sandreas.hansson@arm.com                                  '-fno-builtin-realloc', '-fno-builtin-free'])
6379556Sandreas.hansson@arm.com
6389556Sandreas.hansson@arm.comelif main['CLANG']:
6399556Sandreas.hansson@arm.com    # Check for a supported version of clang, >= 3.0 is needed to
6409556Sandreas.hansson@arm.com    # support similar features as gcc 4.6. See
64110278SAndreas.Sandberg@ARM.com    # http://clang.llvm.org/cxx_status.html for details
64210278SAndreas.Sandberg@ARM.com    clang_version_re = re.compile(".* version (\d+\.\d+)")
64310278SAndreas.Sandberg@ARM.com    clang_version_match = clang_version_re.search(CXX_version)
64410278SAndreas.Sandberg@ARM.com    if (clang_version_match):
64510278SAndreas.Sandberg@ARM.com        clang_version = clang_version_match.groups()[0]
64610278SAndreas.Sandberg@ARM.com        if compareVersions(clang_version, "3.0") < 0:
6479556Sandreas.hansson@arm.com            print 'Error: clang version 3.0 or newer required.'
6489590Sandreas@sandberg.pp.se            print '       Installed version:', clang_version
6499590Sandreas@sandberg.pp.se            Exit(1)
6509420Sandreas.hansson@arm.com    else:
6519846Sandreas.hansson@arm.com        print 'Error: Unable to determine clang version.'
6529846Sandreas.hansson@arm.com        Exit(1)
6539846Sandreas.hansson@arm.com
6549846Sandreas.hansson@arm.com    # clang has a few additional warnings that we disable,
6558946Sandreas.hansson@arm.com    # tautological comparisons are allowed due to unsigned integers
6563918Ssaidi@eecs.umich.edu    # being compared to constants that happen to be 0, and extraneous
6579068SAli.Saidi@ARM.com    # parantheses are allowed due to Ruby's printing of the AST,
6589068SAli.Saidi@ARM.com    # finally self assignments are allowed as the generated CPU code
6599068SAli.Saidi@ARM.com    # is relying on this
6609068SAli.Saidi@ARM.com    main.Append(CCFLAGS=['-Wno-tautological-compare',
6619068SAli.Saidi@ARM.com                         '-Wno-parentheses',
6629068SAli.Saidi@ARM.com                         '-Wno-self-assign',
6639068SAli.Saidi@ARM.com                         # Some versions of libstdc++ (4.8?) seem to
6649068SAli.Saidi@ARM.com                         # use struct hash and class hash
6659068SAli.Saidi@ARM.com                         # interchangeably.
6669419Sandreas.hansson@arm.com                         '-Wno-mismatched-tags',
6679068SAli.Saidi@ARM.com                         ])
6689068SAli.Saidi@ARM.com
6699068SAli.Saidi@ARM.com    main.Append(TCMALLOC_CCFLAGS=['-fno-builtin'])
6709068SAli.Saidi@ARM.com
6719068SAli.Saidi@ARM.com    # On Mac OS X/Darwin we need to also use libc++ (part of XCode) as
6729068SAli.Saidi@ARM.com    # opposed to libstdc++, as the later is dated.
6733918Ssaidi@eecs.umich.edu    if sys.platform == "darwin":
6743918Ssaidi@eecs.umich.edu        main.Append(CXXFLAGS=['-stdlib=libc++'])
6756157Snate@binkert.org        main.Append(LIBS=['c++'])
6766157Snate@binkert.org
6776157Snate@binkert.orgelse:
6786157Snate@binkert.org    print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal,
6795397Ssaidi@eecs.umich.edu    print "Don't know what compiler options to use for your compiler."
6805397Ssaidi@eecs.umich.edu    print termcap.Yellow + '       compiler:' + termcap.Normal, main['CXX']
6816121Snate@binkert.org    print termcap.Yellow + '       version:' + termcap.Normal,
6826121Snate@binkert.org    if not CXX_version:
6836121Snate@binkert.org        print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\
6846121Snate@binkert.org               termcap.Normal
6856121Snate@binkert.org    else:
6866121Snate@binkert.org        print CXX_version.replace('\n', '<nl>')
6875397Ssaidi@eecs.umich.edu    print "       If you're trying to use a compiler other than GCC"
6881851SN/A    print "       or clang, there appears to be something wrong with your"
6891851SN/A    print "       environment."
6907739Sgblack@eecs.umich.edu    print "       "
691955SN/A    print "       If you are trying to use a compiler other than those listed"
6929396Sandreas.hansson@arm.com    print "       above you will need to ease fix SConstruct and "
6939396Sandreas.hansson@arm.com    print "       src/SConscript to support that compiler."
6949396Sandreas.hansson@arm.com    Exit(1)
6959396Sandreas.hansson@arm.com
6969396Sandreas.hansson@arm.com# Set up common yacc/bison flags (needed for Ruby)
6979396Sandreas.hansson@arm.commain['YACCFLAGS'] = '-d'
6989396Sandreas.hansson@arm.commain['YACCHXXFILESUFFIX'] = '.hh'
6999396Sandreas.hansson@arm.com
7009396Sandreas.hansson@arm.com# Do this after we save setting back, or else we'll tack on an
7019396Sandreas.hansson@arm.com# extra 'qdo' every time we run scons.
7029396Sandreas.hansson@arm.comif main['BATCH']:
7039396Sandreas.hansson@arm.com    main['CC']     = main['BATCH_CMD'] + ' ' + main['CC']
7049396Sandreas.hansson@arm.com    main['CXX']    = main['BATCH_CMD'] + ' ' + main['CXX']
7059396Sandreas.hansson@arm.com    main['AS']     = main['BATCH_CMD'] + ' ' + main['AS']
7069396Sandreas.hansson@arm.com    main['AR']     = main['BATCH_CMD'] + ' ' + main['AR']
7079396Sandreas.hansson@arm.com    main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB']
7089477Sandreas.hansson@arm.com
7099477Sandreas.hansson@arm.comif sys.platform == 'cygwin':
7109477Sandreas.hansson@arm.com    # cygwin has some header file issues...
7119477Sandreas.hansson@arm.com    main.Append(CCFLAGS=["-Wno-uninitialized"])
7129477Sandreas.hansson@arm.com
7139477Sandreas.hansson@arm.com# Check for the protobuf compiler
7149477Sandreas.hansson@arm.comprotoc_version = readCommand([main['PROTOC'], '--version'],
7159477Sandreas.hansson@arm.com                             exception='').split()
7169477Sandreas.hansson@arm.com
7179477Sandreas.hansson@arm.com# First two words should be "libprotoc x.y.z"
7189477Sandreas.hansson@arm.comif len(protoc_version) < 2 or protoc_version[0] != 'libprotoc':
7199477Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + \
7209477Sandreas.hansson@arm.com        'Warning: Protocol buffer compiler (protoc) not found.\n' + \
7219477Sandreas.hansson@arm.com        '         Please install protobuf-compiler for tracing support.' + \
7229477Sandreas.hansson@arm.com        termcap.Normal
7239477Sandreas.hansson@arm.com    main['PROTOC'] = False
7249477Sandreas.hansson@arm.comelse:
7259477Sandreas.hansson@arm.com    # Based on the availability of the compress stream wrappers,
7269477Sandreas.hansson@arm.com    # require 2.1.0
7279477Sandreas.hansson@arm.com    min_protoc_version = '2.1.0'
7289477Sandreas.hansson@arm.com    if compareVersions(protoc_version[1], min_protoc_version) < 0:
7299477Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + \
7309396Sandreas.hansson@arm.com            'Warning: protoc version', min_protoc_version, \
7313053Sstever@eecs.umich.edu            'or newer required.\n' + \
7326121Snate@binkert.org            '         Installed version:', protoc_version[1], \
7333053Sstever@eecs.umich.edu            termcap.Normal
7343053Sstever@eecs.umich.edu        main['PROTOC'] = False
7353053Sstever@eecs.umich.edu    else:
7363053Sstever@eecs.umich.edu        # Attempt to determine the appropriate include path and
7373053Sstever@eecs.umich.edu        # library path using pkg-config, that means we also need to
7389072Sandreas.hansson@arm.com        # check for pkg-config. Note that it is possible to use
7393053Sstever@eecs.umich.edu        # protobuf without the involvement of pkg-config. Later on we
7404742Sstever@eecs.umich.edu        # check go a library config check and at that point the test
7414742Sstever@eecs.umich.edu        # will fail if libprotobuf cannot be found.
7423053Sstever@eecs.umich.edu        if readCommand(['pkg-config', '--version'], exception=''):
7433053Sstever@eecs.umich.edu            try:
7443053Sstever@eecs.umich.edu                # Attempt to establish what linking flags to add for protobuf
74510181SCurtis.Dunham@arm.com                # using pkg-config
7466654Snate@binkert.org                main.ParseConfig('pkg-config --cflags --libs-only-L protobuf')
7473053Sstever@eecs.umich.edu            except:
7483053Sstever@eecs.umich.edu                print termcap.Yellow + termcap.Bold + \
7493053Sstever@eecs.umich.edu                    'Warning: pkg-config could not get protobuf flags.' + \
7503053Sstever@eecs.umich.edu                    termcap.Normal
7512667Sstever@eecs.umich.edu
7524554Sbinkertn@umich.edu# Check for SWIG
7536121Snate@binkert.orgif not main.has_key('SWIG'):
7542667Sstever@eecs.umich.edu    print 'Error: SWIG utility not found.'
75510384SCurtis.Dunham@arm.com    print '       Please install (see http://www.swig.org) and retry.'
75610384SCurtis.Dunham@arm.com    Exit(1)
75710384SCurtis.Dunham@arm.com
75810384SCurtis.Dunham@arm.com# Check for appropriate SWIG version
75910384SCurtis.Dunham@arm.comswig_version = readCommand([main['SWIG'], '-version'], exception='').split()
7604554Sbinkertn@umich.edu# First 3 words should be "SWIG Version x.y.z"
7614554Sbinkertn@umich.eduif len(swig_version) < 3 or \
7624554Sbinkertn@umich.edu        swig_version[0] != 'SWIG' or swig_version[1] != 'Version':
7636121Snate@binkert.org    print 'Error determining SWIG version.'
7644554Sbinkertn@umich.edu    Exit(1)
7654554Sbinkertn@umich.edu
7664554Sbinkertn@umich.edumin_swig_version = '2.0.4'
7674781Snate@binkert.orgif compareVersions(swig_version[2], min_swig_version) < 0:
7684554Sbinkertn@umich.edu    print 'Error: SWIG version', min_swig_version, 'or newer required.'
7694554Sbinkertn@umich.edu    print '       Installed version:', swig_version[2]
7702667Sstever@eecs.umich.edu    Exit(1)
7714554Sbinkertn@umich.edu
7724554Sbinkertn@umich.edu# Check for known incompatibilities. The standard library shipped with
7734554Sbinkertn@umich.edu# gcc >= 4.9 does not play well with swig versions prior to 3.0
7744554Sbinkertn@umich.eduif main['GCC'] and compareVersions(gcc_version, '4.9') >= 0 and \
7752667Sstever@eecs.umich.edu        compareVersions(swig_version[2], '3.0') < 0:
7764554Sbinkertn@umich.edu    print termcap.Yellow + termcap.Bold + \
7772667Sstever@eecs.umich.edu        'Warning: This combination of gcc and swig have' + \
7784554Sbinkertn@umich.edu        ' known incompatibilities.\n' + \
7796121Snate@binkert.org        '         If you encounter build problems, please update ' + \
7802667Sstever@eecs.umich.edu        'swig to 3.0 or later.' + \
7815522Snate@binkert.org        termcap.Normal
7825522Snate@binkert.org
7835522Snate@binkert.org# Set up SWIG flags & scanner
7845522Snate@binkert.orgswig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
7855522Snate@binkert.orgmain.Append(SWIGFLAGS=swig_flags)
7865522Snate@binkert.org
7875522Snate@binkert.org# Check for 'timeout' from GNU coreutils. If present, regressions will
7885522Snate@binkert.org# be run with a time limit. We require version 8.13 since we rely on
7895522Snate@binkert.org# support for the '--foreground' option.
7905522Snate@binkert.orgtimeout_lines = readCommand(['timeout', '--version'],
7915522Snate@binkert.org                            exception='').splitlines()
7925522Snate@binkert.org# Get the first line and tokenize it
7935522Snate@binkert.orgtimeout_version = timeout_lines[0].split() if timeout_lines else []
7945522Snate@binkert.orgmain['TIMEOUT'] =  timeout_version and \
7955522Snate@binkert.org    compareVersions(timeout_version[-1], '8.13') >= 0
7965522Snate@binkert.org
7975522Snate@binkert.org# filter out all existing swig scanners, they mess up the dependency
7985522Snate@binkert.org# stuff for some reason
7995522Snate@binkert.orgscanners = []
8005522Snate@binkert.orgfor scanner in main['SCANNERS']:
8015522Snate@binkert.org    skeys = scanner.skeys
8025522Snate@binkert.org    if skeys == '.i':
8035522Snate@binkert.org        continue
8045522Snate@binkert.org
8055522Snate@binkert.org    if isinstance(skeys, (list, tuple)) and '.i' in skeys:
8065522Snate@binkert.org        continue
8079986Sandreas@sandberg.pp.se
8089986Sandreas@sandberg.pp.se    scanners.append(scanner)
8099986Sandreas@sandberg.pp.se
8109986Sandreas@sandberg.pp.se# add the new swig scanner that we like better
8119986Sandreas@sandberg.pp.sefrom SCons.Scanner import ClassicCPP as CPPScanner
8129986Sandreas@sandberg.pp.seswig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
8139986Sandreas@sandberg.pp.sescanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re))
8149986Sandreas@sandberg.pp.se
8159986Sandreas@sandberg.pp.se# replace the scanners list that has what we want
8169986Sandreas@sandberg.pp.semain['SCANNERS'] = scanners
8179986Sandreas@sandberg.pp.se
8189986Sandreas@sandberg.pp.se# Add a custom Check function to the Configure context so that we can
8199986Sandreas@sandberg.pp.se# figure out if the compiler adds leading underscores to global
8209986Sandreas@sandberg.pp.se# variables.  This is needed for the autogenerated asm files that we
8219986Sandreas@sandberg.pp.se# use for embedding the python code.
8229986Sandreas@sandberg.pp.sedef CheckLeading(context):
8239986Sandreas@sandberg.pp.se    context.Message("Checking for leading underscore in global variables...")
8249986Sandreas@sandberg.pp.se    # 1) Define a global variable called x from asm so the C compiler
8259986Sandreas@sandberg.pp.se    #    won't change the symbol at all.
8269986Sandreas@sandberg.pp.se    # 2) Declare that variable.
8272638Sstever@eecs.umich.edu    # 3) Use the variable
8282638Sstever@eecs.umich.edu    #
8296121Snate@binkert.org    # If the compiler prepends an underscore, this will successfully
8303716Sstever@eecs.umich.edu    # link because the external symbol 'x' will be called '_x' which
8315522Snate@binkert.org    # was defined by the asm statement.  If the compiler does not
8329986Sandreas@sandberg.pp.se    # prepend an underscore, this will not successfully link because
8339986Sandreas@sandberg.pp.se    # '_x' will have been defined by assembly, while the C portion of
8349986Sandreas@sandberg.pp.se    # the code will be trying to use 'x'
8359986Sandreas@sandberg.pp.se    ret = context.TryLink('''
8365522Snate@binkert.org        asm(".globl _x; _x: .byte 0");
8375522Snate@binkert.org        extern int x;
8385522Snate@binkert.org        int main() { return x; }
8395522Snate@binkert.org        ''', extension=".c")
8401858SN/A    context.env.Append(LEADING_UNDERSCORE=ret)
8415227Ssaidi@eecs.umich.edu    context.Result(ret)
8425227Ssaidi@eecs.umich.edu    return ret
8435227Ssaidi@eecs.umich.edu
8445227Ssaidi@eecs.umich.edu# Add a custom Check function to test for structure members.
8456654Snate@binkert.orgdef CheckMember(context, include, decl, member, include_quotes="<>"):
8466654Snate@binkert.org    context.Message("Checking for member %s in %s..." %
8477769SAli.Saidi@ARM.com                    (member, decl))
8487769SAli.Saidi@ARM.com    text = """
8497769SAli.Saidi@ARM.com#include %(header)s
8507769SAli.Saidi@ARM.comint main(){
8515227Ssaidi@eecs.umich.edu  %(decl)s test;
8525227Ssaidi@eecs.umich.edu  (void)test.%(member)s;
8535227Ssaidi@eecs.umich.edu  return 0;
8545204Sstever@gmail.com};
8555204Sstever@gmail.com""" % { "header" : include_quotes[0] + include + include_quotes[1],
8565204Sstever@gmail.com        "decl" : decl,
8575204Sstever@gmail.com        "member" : member,
8585204Sstever@gmail.com        }
8595204Sstever@gmail.com
8605204Sstever@gmail.com    ret = context.TryCompile(text, extension=".cc")
8615204Sstever@gmail.com    context.Result(ret)
8625204Sstever@gmail.com    return ret
8635204Sstever@gmail.com
8645204Sstever@gmail.com# Platform-specific configuration.  Note again that we assume that all
8655204Sstever@gmail.com# builds under a given build root run on the same host platform.
8665204Sstever@gmail.comconf = Configure(main,
8675204Sstever@gmail.com                 conf_dir = joinpath(build_root, '.scons_config'),
8685204Sstever@gmail.com                 log_file = joinpath(build_root, 'scons_config.log'),
8695204Sstever@gmail.com                 custom_tests = {
8705204Sstever@gmail.com        'CheckLeading' : CheckLeading,
8716121Snate@binkert.org        'CheckMember' : CheckMember,
8725204Sstever@gmail.com        })
8737727SAli.Saidi@ARM.com
8747727SAli.Saidi@ARM.com# Check for leading underscores.  Don't really need to worry either
8757727SAli.Saidi@ARM.com# way so don't need to check the return code.
8767727SAli.Saidi@ARM.comconf.CheckLeading()
8777727SAli.Saidi@ARM.com
8789812Sandreas.hansson@arm.com# Check if we should compile a 64 bit binary on Mac OS X/Darwin
8799812Sandreas.hansson@arm.comtry:
8809812Sandreas.hansson@arm.com    import platform
8819812Sandreas.hansson@arm.com    uname = platform.uname()
8829812Sandreas.hansson@arm.com    if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0:
8839812Sandreas.hansson@arm.com        if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
8849812Sandreas.hansson@arm.com            main.Append(CCFLAGS=['-arch', 'x86_64'])
88510158Sstian@dream-web.no            main.Append(CFLAGS=['-arch', 'x86_64'])
88610158Sstian@dream-web.no            main.Append(LINKFLAGS=['-arch', 'x86_64'])
88710158Sstian@dream-web.no            main.Append(ASFLAGS=['-arch', 'x86_64'])
88810158Sstian@dream-web.noexcept:
88910160Sandreas.hansson@arm.com    pass
89010160Sandreas.hansson@arm.com
89110158Sstian@dream-web.no# Recent versions of scons substitute a "Null" object for Configure()
8929812Sandreas.hansson@arm.com# when configuration isn't necessary, e.g., if the "--help" option is
8939812Sandreas.hansson@arm.com# present.  Unfortuantely this Null object always returns false,
8949812Sandreas.hansson@arm.com# breaking all our configuration checks.  We replace it with our own
8959812Sandreas.hansson@arm.com# more optimistic null object that returns True instead.
8969812Sandreas.hansson@arm.comif not conf:
8979812Sandreas.hansson@arm.com    def NullCheck(*args, **kwargs):
8989812Sandreas.hansson@arm.com        return True
89910158Sstian@dream-web.no
9009812Sandreas.hansson@arm.com    class NullConf:
9019812Sandreas.hansson@arm.com        def __init__(self, env):
9029812Sandreas.hansson@arm.com            self.env = env
9039812Sandreas.hansson@arm.com        def Finish(self):
9049812Sandreas.hansson@arm.com            return self.env
9059812Sandreas.hansson@arm.com        def __getattr__(self, mname):
9069812Sandreas.hansson@arm.com            return NullCheck
9079812Sandreas.hansson@arm.com
9087727SAli.Saidi@ARM.com    conf = NullConf(main)
9095863Snate@binkert.org
9103118Sstever@eecs.umich.edu# Cache build files in the supplied directory.
9115863Snate@binkert.orgif main['M5_BUILD_CACHE']:
9129239Sandreas.hansson@arm.com    print 'Using build cache located at', main['M5_BUILD_CACHE']
9133118Sstever@eecs.umich.edu    CacheDir(main['M5_BUILD_CACHE'])
9143118Sstever@eecs.umich.edu
9155863Snate@binkert.orgif not GetOption('without_python'):
9165863Snate@binkert.org    # Find Python include and library directories for embedding the
9175863Snate@binkert.org    # interpreter. We rely on python-config to resolve the appropriate
9185863Snate@binkert.org    # includes and linker flags. ParseConfig does not seem to understand
9193118Sstever@eecs.umich.edu    # the more exotic linker flags such as -Xlinker and -export-dynamic so
9203483Ssaidi@eecs.umich.edu    # we add them explicitly below. If you want to link in an alternate
9213494Ssaidi@eecs.umich.edu    # version of python, see above for instructions on how to invoke
9223494Ssaidi@eecs.umich.edu    # scons with the appropriate PATH set.
9233483Ssaidi@eecs.umich.edu    #
9243483Ssaidi@eecs.umich.edu    # First we check if python2-config exists, else we use python-config
9253483Ssaidi@eecs.umich.edu    python_config = readCommand(['which', 'python2-config'],
9263053Sstever@eecs.umich.edu                                exception='').strip()
9273053Sstever@eecs.umich.edu    if not os.path.exists(python_config):
9283918Ssaidi@eecs.umich.edu        python_config = readCommand(['which', 'python-config'],
9293053Sstever@eecs.umich.edu                                    exception='').strip()
9303053Sstever@eecs.umich.edu    py_includes = readCommand([python_config, '--includes'],
9313053Sstever@eecs.umich.edu                              exception='').split()
9323053Sstever@eecs.umich.edu    # Strip the -I from the include folders before adding them to the
9333053Sstever@eecs.umich.edu    # CPPPATH
9349396Sandreas.hansson@arm.com    main.Append(CPPPATH=map(lambda inc: inc[2:], py_includes))
9359396Sandreas.hansson@arm.com
9369396Sandreas.hansson@arm.com    # Read the linker flags and split them into libraries and other link
9379396Sandreas.hansson@arm.com    # flags. The libraries are added later through the call the CheckLib.
9389396Sandreas.hansson@arm.com    py_ld_flags = readCommand([python_config, '--ldflags'],
9399396Sandreas.hansson@arm.com        exception='').split()
9409396Sandreas.hansson@arm.com    py_libs = []
9419396Sandreas.hansson@arm.com    for lib in py_ld_flags:
9429396Sandreas.hansson@arm.com         if not lib.startswith('-l'):
9439477Sandreas.hansson@arm.com             main.Append(LINKFLAGS=[lib])
9449396Sandreas.hansson@arm.com         else:
9459477Sandreas.hansson@arm.com             lib = lib[2:]
9469477Sandreas.hansson@arm.com             if lib not in py_libs:
9479477Sandreas.hansson@arm.com                 py_libs.append(lib)
9489477Sandreas.hansson@arm.com
9499396Sandreas.hansson@arm.com    # verify that this stuff works
9507840Snate@binkert.org    if not conf.CheckHeader('Python.h', '<>'):
9517865Sgblack@eecs.umich.edu        print "Error: can't find Python.h header in", py_includes
9527865Sgblack@eecs.umich.edu        print "Install Python headers (package python-dev on Ubuntu and RedHat)"
9537865Sgblack@eecs.umich.edu        Exit(1)
9547865Sgblack@eecs.umich.edu
9557865Sgblack@eecs.umich.edu    for lib in py_libs:
9567840Snate@binkert.org        if not conf.CheckLib(lib):
9579900Sandreas@sandberg.pp.se            print "Error: can't find library %s required by python" % lib
9589900Sandreas@sandberg.pp.se            Exit(1)
9599900Sandreas@sandberg.pp.se
9609900Sandreas@sandberg.pp.se# On Solaris you need to use libsocket for socket ops
9619591Sandreas@sandberg.pp.seif not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
9629591Sandreas@sandberg.pp.se   if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
9639591Sandreas@sandberg.pp.se       print "Can't find library with socket calls (e.g. accept())"
9649590Sandreas@sandberg.pp.se       Exit(1)
9659590Sandreas@sandberg.pp.se
9669045SAli.Saidi@ARM.com# Check for zlib.  If the check passes, libz will be automatically
9679045SAli.Saidi@ARM.com# added to the LIBS environment variable.
9689071Sandreas.hansson@arm.comif not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
9699071Sandreas.hansson@arm.com    print 'Error: did not find needed zlib compression library '\
9709045SAli.Saidi@ARM.com          'and/or zlib.h header file.'
9717840Snate@binkert.org    print '       Please install zlib and try again.'
9727840Snate@binkert.org    Exit(1)
9737840Snate@binkert.org
9741858SN/A# If we have the protobuf compiler, also make sure we have the
9751858SN/A# development libraries. If the check passes, libprotobuf will be
9761858SN/A# automatically added to the LIBS environment variable. After
9771858SN/A# this, we can use the HAVE_PROTOBUF flag to determine if we have
9781858SN/A# got both protoc and libprotobuf available.
9791858SN/Amain['HAVE_PROTOBUF'] = main['PROTOC'] and \
9809903Sandreas.hansson@arm.com    conf.CheckLibWithHeader('protobuf', 'google/protobuf/message.h',
9819903Sandreas.hansson@arm.com                            'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;')
9829903Sandreas.hansson@arm.com
9839903Sandreas.hansson@arm.com# If we have the compiler but not the library, print another warning.
9849903Sandreas.hansson@arm.comif main['PROTOC'] and not main['HAVE_PROTOBUF']:
9859903Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + \
9869651SAndreas.Sandberg@ARM.com        'Warning: did not find protocol buffer library and/or headers.\n' + \
9879903Sandreas.hansson@arm.com    '       Please install libprotobuf-dev for tracing support.' + \
9889651SAndreas.Sandberg@ARM.com    termcap.Normal
9899651SAndreas.Sandberg@ARM.com
9909651SAndreas.Sandberg@ARM.com# Check for librt.
9919651SAndreas.Sandberg@ARM.comhave_posix_clock = \
9929651SAndreas.Sandberg@ARM.com    conf.CheckLibWithHeader(None, 'time.h', 'C',
9939657Sandreas.sandberg@arm.com                            'clock_nanosleep(0,0,NULL,NULL);') or \
9949883Sandreas@sandberg.pp.se    conf.CheckLibWithHeader('rt', 'time.h', 'C',
9959651SAndreas.Sandberg@ARM.com                            'clock_nanosleep(0,0,NULL,NULL);')
9969651SAndreas.Sandberg@ARM.com
9979651SAndreas.Sandberg@ARM.comhave_posix_timers = \
9989651SAndreas.Sandberg@ARM.com    conf.CheckLibWithHeader([None, 'rt'], [ 'time.h', 'signal.h' ], 'C',
9999651SAndreas.Sandberg@ARM.com                            'timer_create(CLOCK_MONOTONIC, NULL, NULL);')
10009651SAndreas.Sandberg@ARM.com
10019651SAndreas.Sandberg@ARM.comif not GetOption('without_tcmalloc'):
10029651SAndreas.Sandberg@ARM.com    if conf.CheckLib('tcmalloc'):
10039651SAndreas.Sandberg@ARM.com        main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS'])
10049651SAndreas.Sandberg@ARM.com    elif conf.CheckLib('tcmalloc_minimal'):
10059651SAndreas.Sandberg@ARM.com        main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS'])
10069986Sandreas@sandberg.pp.se    else:
10079986Sandreas@sandberg.pp.se        print termcap.Yellow + termcap.Bold + \
10089986Sandreas@sandberg.pp.se              "You can get a 12% performance improvement by "\
10099986Sandreas@sandberg.pp.se              "installing tcmalloc (libgoogle-perftools-dev package "\
10109986Sandreas@sandberg.pp.se              "on Ubuntu or RedHat)." + termcap.Normal
10119986Sandreas@sandberg.pp.se
10125863Snate@binkert.orgif not have_posix_clock:
10135863Snate@binkert.org    print "Can't find library for POSIX clocks."
10145863Snate@binkert.org
10155863Snate@binkert.org# Check for <fenv.h> (C99 FP environment control)
10166121Snate@binkert.orghave_fenv = conf.CheckHeader('fenv.h', '<>')
10171858SN/Aif not have_fenv:
10185863Snate@binkert.org    print "Warning: Header file <fenv.h> not found."
10195863Snate@binkert.org    print "         This host has no IEEE FP rounding mode control."
10205863Snate@binkert.org
10215863Snate@binkert.org# Check if we should enable KVM-based hardware virtualization. The API
10225863Snate@binkert.org# we rely on exists since version 2.6.36 of the kernel, but somehow
10232139SN/A# the KVM_API_VERSION does not reflect the change. We test for one of
10244202Sbinkertn@umich.edu# the types as a fall back.
10254202Sbinkertn@umich.eduhave_kvm = conf.CheckHeader('linux/kvm.h', '<>')
10262139SN/Aif not have_kvm:
10276994Snate@binkert.org    print "Info: Compatible header file <linux/kvm.h> not found, " \
10286994Snate@binkert.org        "disabling KVM support."
10296994Snate@binkert.org
10306994Snate@binkert.org# x86 needs support for xsave. We test for the structure here since we
10316994Snate@binkert.org# won't be able to run new tests by the time we know which ISA we're
10326994Snate@binkert.org# targeting.
10336994Snate@binkert.orghave_kvm_xsave = conf.CheckTypeSize('struct kvm_xsave',
10346994Snate@binkert.org                                    '#include <linux/kvm.h>') != 0
103510319SAndreas.Sandberg@ARM.com
10366994Snate@binkert.org# Check if the requested target ISA is compatible with the host
10376994Snate@binkert.orgdef is_isa_kvm_compatible(isa):
10386994Snate@binkert.org    try:
10396994Snate@binkert.org        import platform
10406994Snate@binkert.org        host_isa = platform.machine()
10416994Snate@binkert.org    except:
10426994Snate@binkert.org        print "Warning: Failed to determine host ISA."
10436994Snate@binkert.org        return False
10446994Snate@binkert.org
10456994Snate@binkert.org    if not have_posix_timers:
10466994Snate@binkert.org        print "Warning: Can not enable KVM, host seems to lack support " \
10472155SN/A            "for POSIX timers"
10485863Snate@binkert.org        return False
10491869SN/A
10501869SN/A    if isa == "arm":
10515863Snate@binkert.org        return host_isa == "armv7l"
10525863Snate@binkert.org    elif isa == "x86":
10534202Sbinkertn@umich.edu        if host_isa != "x86_64":
10546108Snate@binkert.org            return False
10556108Snate@binkert.org
10566108Snate@binkert.org        if not have_kvm_xsave:
10576108Snate@binkert.org            print "KVM on x86 requires xsave support in kernel headers."
10589219Spower.jg@gmail.com            return False
10599219Spower.jg@gmail.com
10609219Spower.jg@gmail.com        return True
10619219Spower.jg@gmail.com    else:
10629219Spower.jg@gmail.com        return False
10639219Spower.jg@gmail.com
10649219Spower.jg@gmail.com
10659219Spower.jg@gmail.com# Check if the exclude_host attribute is available. We want this to
10664202Sbinkertn@umich.edu# get accurate instruction counts in KVM.
10675863Snate@binkert.orgmain['HAVE_PERF_ATTR_EXCLUDE_HOST'] = conf.CheckMember(
106810135SCurtis.Dunham@arm.com    'linux/perf_event.h', 'struct perf_event_attr', 'exclude_host')
10698474Sgblack@eecs.umich.edu
10705742Snate@binkert.org
10718268Ssteve.reinhardt@amd.com######################################################################
10728268Ssteve.reinhardt@amd.com#
10738268Ssteve.reinhardt@amd.com# Finish the configuration
10745742Snate@binkert.org#
10755341Sstever@gmail.commain = conf.Finish()
10768474Sgblack@eecs.umich.edu
10778474Sgblack@eecs.umich.edu######################################################################
10785342Sstever@gmail.com#
10794202Sbinkertn@umich.edu# Collect all non-global variables
10804202Sbinkertn@umich.edu#
10814202Sbinkertn@umich.edu
10825863Snate@binkert.org# Define the universe of supported ISAs
10835863Snate@binkert.orgall_isa_list = [ ]
10846994Snate@binkert.orgExport('all_isa_list')
10856994Snate@binkert.org
108610319SAndreas.Sandberg@ARM.comclass CpuModel(object):
10875863Snate@binkert.org    '''The CpuModel class encapsulates everything the ISA parser needs to
10885863Snate@binkert.org    know about a particular CPU model.'''
10895863Snate@binkert.org
10905863Snate@binkert.org    # Dict of available CPU model objects.  Accessible as CpuModel.dict.
10915863Snate@binkert.org    dict = {}
10925863Snate@binkert.org
10935863Snate@binkert.org    # Constructor.  Automatically adds models to CpuModel.dict.
10945863Snate@binkert.org    def __init__(self, name, default=False):
10957840Snate@binkert.org        self.name = name           # name of model
10965863Snate@binkert.org
10975952Ssaidi@eecs.umich.edu        # This cpu is enabled by default
10989651SAndreas.Sandberg@ARM.com        self.default = default
10999219Spower.jg@gmail.com
11009219Spower.jg@gmail.com        # Add self to dict
11011869SN/A        if name in CpuModel.dict:
11021858SN/A            raise AttributeError, "CpuModel '%s' already registered" % name
11035863Snate@binkert.org        CpuModel.dict[name] = self
11049420Sandreas.hansson@arm.com
11059986Sandreas@sandberg.pp.seExport('CpuModel')
11069986Sandreas@sandberg.pp.se
11071858SN/A# Sticky variables get saved in the variables file so they persist from
1108955SN/A# one invocation to the next (unless overridden, in which case the new
1109955SN/A# value becomes sticky).
11101869SN/Asticky_vars = Variables(args=ARGUMENTS)
11111869SN/AExport('sticky_vars')
11121869SN/A
11131869SN/A# Sticky variables that should be exported
11141869SN/Aexport_vars = []
11155863Snate@binkert.orgExport('export_vars')
11165863Snate@binkert.org
11175863Snate@binkert.org# For Ruby
11181869SN/Aall_protocols = []
11195863Snate@binkert.orgExport('all_protocols')
11201869SN/Aprotocol_dirs = []
11215863Snate@binkert.orgExport('protocol_dirs')
11221869SN/Aslicc_includes = []
11231869SN/AExport('slicc_includes')
11241869SN/A
11251869SN/A# Walk the tree and execute all SConsopts scripts that wil add to the
11268483Sgblack@eecs.umich.edu# above variables
11271869SN/Aif GetOption('verbose'):
11281869SN/A    print "Reading SConsopts"
11291869SN/Afor bdir in [ base_dir ] + extras_dir_list:
11301869SN/A    if not isdir(bdir):
11315863Snate@binkert.org        print "Error: directory '%s' does not exist" % bdir
11325863Snate@binkert.org        Exit(1)
11331869SN/A    for root, dirs, files in os.walk(bdir):
11345863Snate@binkert.org        if 'SConsopts' in files:
11355863Snate@binkert.org            if GetOption('verbose'):
11363356Sbinkertn@umich.edu                print "Reading", joinpath(root, 'SConsopts')
11373356Sbinkertn@umich.edu            SConscript(joinpath(root, 'SConsopts'))
11383356Sbinkertn@umich.edu
11393356Sbinkertn@umich.eduall_isa_list.sort()
11403356Sbinkertn@umich.edu
11414781Snate@binkert.orgsticky_vars.AddVariables(
11425863Snate@binkert.org    EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list),
11435863Snate@binkert.org    ListVariable('CPU_MODELS', 'CPU models',
11441869SN/A                 sorted(n for n,m in CpuModel.dict.iteritems() if m.default),
11451869SN/A                 sorted(CpuModel.dict.keys())),
11461869SN/A    BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
11476121Snate@binkert.org                 False),
11481869SN/A    BoolVariable('SS_COMPATIBLE_FP',
11492638Sstever@eecs.umich.edu                 'Make floating-point results compatible with SimpleScalar',
11506121Snate@binkert.org                 False),
11516121Snate@binkert.org    BoolVariable('USE_SSE2',
11522638Sstever@eecs.umich.edu                 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
11535749Scws3k@cs.virginia.edu                 False),
11546121Snate@binkert.org    BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock),
11556121Snate@binkert.org    BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
11565749Scws3k@cs.virginia.edu    BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False),
11579537Satgutier@umich.edu    BoolVariable('USE_KVM', 'Enable hardware virtualized (KVM) CPU models', have_kvm),
11589537Satgutier@umich.edu    EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None',
11599537Satgutier@umich.edu                  all_protocols),
11609537Satgutier@umich.edu    )
11619888Sandreas@sandberg.pp.se
11629888Sandreas@sandberg.pp.se# These variables get exported to #defines in config/*.hh (see src/SConscript).
11639888Sandreas@sandberg.pp.seexport_vars += ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'CP_ANNOTATE',
11649888Sandreas@sandberg.pp.se                'USE_POSIX_CLOCK', 'USE_KVM', 'PROTOCOL', 'HAVE_PROTOBUF',
116510066Sandreas.hansson@arm.com                'HAVE_PERF_ATTR_EXCLUDE_HOST']
116610066Sandreas.hansson@arm.com
116710066Sandreas.hansson@arm.com###################################################
116810066Sandreas.hansson@arm.com#
11691869SN/A# Define a SCons builder for configuration flag headers.
11701869SN/A#
11713546Sgblack@eecs.umich.edu###################################################
11723546Sgblack@eecs.umich.edu
11733546Sgblack@eecs.umich.edu# This function generates a config header file that #defines the
11743546Sgblack@eecs.umich.edu# variable symbol to the current variable setting (0 or 1).  The source
11756121Snate@binkert.org# operands are the name of the variable and a Value node containing the
117610196SCurtis.Dunham@arm.com# value of the variable.
11775863Snate@binkert.orgdef build_config_file(target, source, env):
11783546Sgblack@eecs.umich.edu    (variable, value) = [s.get_contents() for s in source]
11793546Sgblack@eecs.umich.edu    f = file(str(target[0]), 'w')
11803546Sgblack@eecs.umich.edu    print >> f, '#define', variable, value
11813546Sgblack@eecs.umich.edu    f.close()
11824781Snate@binkert.org    return None
11836658Snate@binkert.org
118410196SCurtis.Dunham@arm.com# Combine the two functions into a scons Action object.
118510196SCurtis.Dunham@arm.comconfig_action = MakeAction(build_config_file, Transform("CONFIG H", 2))
118610196SCurtis.Dunham@arm.com
118710196SCurtis.Dunham@arm.com# The emitter munges the source & target node lists to reflect what
118810196SCurtis.Dunham@arm.com# we're really doing.
118910196SCurtis.Dunham@arm.comdef config_emitter(target, source, env):
119010196SCurtis.Dunham@arm.com    # extract variable name from Builder arg
11913546Sgblack@eecs.umich.edu    variable = str(target[0])
11923546Sgblack@eecs.umich.edu    # True target is config header file
11933546Sgblack@eecs.umich.edu    target = joinpath('config', variable.lower() + '.hh')
11943546Sgblack@eecs.umich.edu    val = env[variable]
11957756SAli.Saidi@ARM.com    if isinstance(val, bool):
11967816Ssteve.reinhardt@amd.com        # Force value to 0/1
11973546Sgblack@eecs.umich.edu        val = int(val)
11983546Sgblack@eecs.umich.edu    elif isinstance(val, str):
11993546Sgblack@eecs.umich.edu        val = '"' + val + '"'
12003546Sgblack@eecs.umich.edu
120110196SCurtis.Dunham@arm.com    # Sources are variable name & value (packaged in SCons Value nodes)
120210196SCurtis.Dunham@arm.com    return ([target], [Value(variable), Value(val)])
120310196SCurtis.Dunham@arm.com
120410196SCurtis.Dunham@arm.comconfig_builder = Builder(emitter = config_emitter, action = config_action)
120510196SCurtis.Dunham@arm.com
12064202Sbinkertn@umich.edumain.Append(BUILDERS = { 'ConfigFile' : config_builder })
12073546Sgblack@eecs.umich.edu
120810196SCurtis.Dunham@arm.com# libelf build is shared across all configs in the build root.
120910196SCurtis.Dunham@arm.commain.SConscript('ext/libelf/SConscript',
121010196SCurtis.Dunham@arm.com                variant_dir = joinpath(build_root, 'libelf'))
121110196SCurtis.Dunham@arm.com
121210196SCurtis.Dunham@arm.com# gzstream build is shared across all configs in the build root.
121310196SCurtis.Dunham@arm.commain.SConscript('ext/gzstream/SConscript',
121410196SCurtis.Dunham@arm.com                variant_dir = joinpath(build_root, 'gzstream'))
121510196SCurtis.Dunham@arm.com
121610196SCurtis.Dunham@arm.com# libfdt build is shared across all configs in the build root.
121710196SCurtis.Dunham@arm.commain.SConscript('ext/libfdt/SConscript',
121810196SCurtis.Dunham@arm.com                variant_dir = joinpath(build_root, 'libfdt'))
121910196SCurtis.Dunham@arm.com
122010196SCurtis.Dunham@arm.com# fputils build is shared across all configs in the build root.
122110196SCurtis.Dunham@arm.commain.SConscript('ext/fputils/SConscript',
122210196SCurtis.Dunham@arm.com                variant_dir = joinpath(build_root, 'fputils'))
122310196SCurtis.Dunham@arm.com
122410196SCurtis.Dunham@arm.com# DRAMSim2 build is shared across all configs in the build root.
122510196SCurtis.Dunham@arm.commain.SConscript('ext/dramsim2/SConscript',
122610196SCurtis.Dunham@arm.com                variant_dir = joinpath(build_root, 'dramsim2'))
122710196SCurtis.Dunham@arm.com
122810196SCurtis.Dunham@arm.com# DRAMPower build is shared across all configs in the build root.
122910196SCurtis.Dunham@arm.commain.SConscript('ext/drampower/SConscript',
123010196SCurtis.Dunham@arm.com                variant_dir = joinpath(build_root, 'drampower'))
123110196SCurtis.Dunham@arm.com
12323546Sgblack@eecs.umich.edu###################################################
12333546Sgblack@eecs.umich.edu#
1234955SN/A# This function is used to set up a directory with switching headers
1235955SN/A#
1236955SN/A###################################################
1237955SN/A
12385863Snate@binkert.orgmain['ALL_ISA_LIST'] = all_isa_list
123910135SCurtis.Dunham@arm.comall_isa_deps = {}
124010135SCurtis.Dunham@arm.comdef make_switching_dir(dname, switch_headers, env):
12415343Sstever@gmail.com    # Generate the header.  target[0] is the full path of the output
12425343Sstever@gmail.com    # header to generate.  'source' is a dummy variable, since we get the
12436121Snate@binkert.org    # list of ISAs from env['ALL_ISA_LIST'].
12445863Snate@binkert.org    def gen_switch_hdr(target, source, env):
12454773Snate@binkert.org        fname = str(target[0])
12465863Snate@binkert.org        isa = env['TARGET_ISA'].lower()
12472632Sstever@eecs.umich.edu        try:
12485863Snate@binkert.org            f = open(fname, 'w')
12492023SN/A            print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname))
12505863Snate@binkert.org            f.close()
12515863Snate@binkert.org        except IOError:
12525863Snate@binkert.org            print "Failed to create %s" % fname
12535863Snate@binkert.org            raise
12545863Snate@binkert.org
12555863Snate@binkert.org    # Build SCons Action object. 'varlist' specifies env vars that this
12565863Snate@binkert.org    # action depends on; when env['ALL_ISA_LIST'] changes these actions
12575863Snate@binkert.org    # should get re-executed.
125810135SCurtis.Dunham@arm.com    switch_hdr_action = MakeAction(gen_switch_hdr,
125910135SCurtis.Dunham@arm.com                          Transform("GENERATE"), varlist=['ALL_ISA_LIST'])
12602632Sstever@eecs.umich.edu
12615863Snate@binkert.org    # Instantiate actions for each header
12622023SN/A    for hdr in switch_headers:
12632632Sstever@eecs.umich.edu        env.Command(hdr, [], switch_hdr_action)
12645863Snate@binkert.org
12655342Sstever@gmail.com    isa_target = Dir('.').up().name.lower().replace('_', '-')
12665863Snate@binkert.org    env['PHONY_BASE'] = '#'+isa_target
12672632Sstever@eecs.umich.edu    all_isa_deps[isa_target] = None
12685863Snate@binkert.org
12695863Snate@binkert.orgExport('make_switching_dir')
12708267Ssteve.reinhardt@amd.com
12718120Sgblack@eecs.umich.edu# all-isas -> all-deps -> all-environs -> all_targets
12728267Ssteve.reinhardt@amd.commain.Alias('#all-isas', [])
12738267Ssteve.reinhardt@amd.commain.Alias('#all-deps', '#all-isas')
12748267Ssteve.reinhardt@amd.com
12758267Ssteve.reinhardt@amd.com# Dummy target to ensure all environments are created before telling
12768267Ssteve.reinhardt@amd.com# SCons what to actually make (the command line arguments).  We attach
12778267Ssteve.reinhardt@amd.com# them to the dependence graph after the environments are complete.
12788267Ssteve.reinhardt@amd.comORIG_BUILD_TARGETS = list(BUILD_TARGETS) # force a copy; gets closure to work.
12798267Ssteve.reinhardt@amd.comdef environsComplete(target, source, env):
12808267Ssteve.reinhardt@amd.com    for t in ORIG_BUILD_TARGETS:
12815863Snate@binkert.org        main.Depends('#all-targets', t)
12825863Snate@binkert.org
12835863Snate@binkert.org# Each build/* switching_dir attaches its *-environs target to #all-environs.
12842632Sstever@eecs.umich.edumain.Append(BUILDERS = {'CompleteEnvirons' :
12858267Ssteve.reinhardt@amd.com                        Builder(action=MakeAction(environsComplete, None))})
12868267Ssteve.reinhardt@amd.commain.CompleteEnvirons('#all-environs', [])
12878267Ssteve.reinhardt@amd.com
12882632Sstever@eecs.umich.edudef doNothing(**ignored): pass
12891888SN/Amain.Append(BUILDERS = {'Dummy': Builder(action=MakeAction(doNothing, None))})
12905863Snate@binkert.org
12915863Snate@binkert.org# The final target to which all the original targets ultimately get attached.
12921858SN/Amain.Dummy('#all-targets', '#all-environs')
12938120Sgblack@eecs.umich.eduBUILD_TARGETS[:] = ['#all-targets']
12948120Sgblack@eecs.umich.edu
12957756SAli.Saidi@ARM.com###################################################
12962598SN/A#
12975863Snate@binkert.org# Define build environments for selected configurations.
12981858SN/A#
12991858SN/A###################################################
13001858SN/A
13015863Snate@binkert.orgfor variant_path in variant_paths:
13021858SN/A    if not GetOption('silent'):
13031858SN/A        print "Building in", variant_path
13041858SN/A
13055863Snate@binkert.org    # Make a copy of the build-root environment to use for this config.
13061871SN/A    env = main.Clone()
13071858SN/A    env['BUILDDIR'] = variant_path
13081858SN/A
13091858SN/A    # variant_dir is the tail component of build path, and is used to
13101858SN/A    # determine the build parameters (e.g., 'ALPHA_SE')
13119651SAndreas.Sandberg@ARM.com    (build_root, variant_dir) = splitpath(variant_path)
13129651SAndreas.Sandberg@ARM.com
13139651SAndreas.Sandberg@ARM.com    # Set env variables according to the build directory config.
13149651SAndreas.Sandberg@ARM.com    sticky_vars.files = []
13159900Sandreas@sandberg.pp.se    # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
13169900Sandreas@sandberg.pp.se    # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
13179900Sandreas@sandberg.pp.se    # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
13189900Sandreas@sandberg.pp.se    current_vars_file = joinpath(build_root, 'variables', variant_dir)
13199651SAndreas.Sandberg@ARM.com    if isfile(current_vars_file):
13209651SAndreas.Sandberg@ARM.com        sticky_vars.files.append(current_vars_file)
13219651SAndreas.Sandberg@ARM.com        if not GetOption('silent'):
13229651SAndreas.Sandberg@ARM.com            print "Using saved variables file %s" % current_vars_file
13239651SAndreas.Sandberg@ARM.com    else:
13249986Sandreas@sandberg.pp.se        # Build dir-specific variables file doesn't exist.
13259986Sandreas@sandberg.pp.se
13269986Sandreas@sandberg.pp.se        # Make sure the directory is there so we can create it later
13279986Sandreas@sandberg.pp.se        opt_dir = dirname(current_vars_file)
13289986Sandreas@sandberg.pp.se        if not isdir(opt_dir):
13299986Sandreas@sandberg.pp.se            mkdir(opt_dir)
13309986Sandreas@sandberg.pp.se
13315863Snate@binkert.org        # Get default build variables from source tree.  Variables are
13325863Snate@binkert.org        # normally determined by name of $VARIANT_DIR, but can be
13331869SN/A        # overridden by '--default=' arg on command line.
13341965SN/A        default = GetOption('default')
13357739Sgblack@eecs.umich.edu        opts_dir = joinpath(main.root.abspath, 'build_opts')
13361965SN/A        if default:
13372761Sstever@eecs.umich.edu            default_vars_files = [joinpath(build_root, 'variables', default),
13385863Snate@binkert.org                                  joinpath(opts_dir, default)]
13391869SN/A        else:
134010196SCurtis.Dunham@arm.com            default_vars_files = [joinpath(opts_dir, variant_dir)]
13411869SN/A        existing_files = filter(isfile, default_vars_files)
134210196SCurtis.Dunham@arm.com        if existing_files:
134310196SCurtis.Dunham@arm.com            default_vars_file = existing_files[0]
134410196SCurtis.Dunham@arm.com            sticky_vars.files.append(default_vars_file)
134510196SCurtis.Dunham@arm.com            print "Variables file %s not found,\n  using defaults in %s" \
134610196SCurtis.Dunham@arm.com                  % (current_vars_file, default_vars_file)
134710196SCurtis.Dunham@arm.com        else:
134810196SCurtis.Dunham@arm.com            print "Error: cannot find variables file %s or " \
134910196SCurtis.Dunham@arm.com                  "default file(s) %s" \
135010196SCurtis.Dunham@arm.com                  % (current_vars_file, ' or '.join(default_vars_files))
135110196SCurtis.Dunham@arm.com            Exit(1)
135210196SCurtis.Dunham@arm.com
135310196SCurtis.Dunham@arm.com    # Apply current variable settings to env
135410196SCurtis.Dunham@arm.com    sticky_vars.Update(env)
135510196SCurtis.Dunham@arm.com
135610196SCurtis.Dunham@arm.com    help_texts["local_vars"] += \
135710196SCurtis.Dunham@arm.com        "Build variables for %s:\n" % variant_dir \
135810196SCurtis.Dunham@arm.com                 + sticky_vars.GenerateHelpText(env)
1359955SN/A
13608120Sgblack@eecs.umich.edu    # Process variable settings.
13618120Sgblack@eecs.umich.edu
13628120Sgblack@eecs.umich.edu    if not have_fenv and env['USE_FENV']:
13638120Sgblack@eecs.umich.edu        print "Warning: <fenv.h> not available; " \
13648120Sgblack@eecs.umich.edu              "forcing USE_FENV to False in", variant_dir + "."
13658120Sgblack@eecs.umich.edu        env['USE_FENV'] = False
13668120Sgblack@eecs.umich.edu
13678120Sgblack@eecs.umich.edu    if not env['USE_FENV']:
13688120Sgblack@eecs.umich.edu        print "Warning: No IEEE FP rounding mode control in", variant_dir + "."
13698120Sgblack@eecs.umich.edu        print "         FP results may deviate slightly from other platforms."
13708120Sgblack@eecs.umich.edu
13718120Sgblack@eecs.umich.edu    if env['EFENCE']:
1372        env.Append(LIBS=['efence'])
1373
1374    if env['USE_KVM']:
1375        if not have_kvm:
1376            print "Warning: Can not enable KVM, host seems to lack KVM support"
1377            env['USE_KVM'] = False
1378        elif not is_isa_kvm_compatible(env['TARGET_ISA']):
1379            print "Info: KVM support disabled due to unsupported host and " \
1380                "target ISA combination"
1381            env['USE_KVM'] = False
1382
1383    # Warn about missing optional functionality
1384    if env['USE_KVM']:
1385        if not main['HAVE_PERF_ATTR_EXCLUDE_HOST']:
1386            print "Warning: perf_event headers lack support for the " \
1387                "exclude_host attribute. KVM instruction counts will " \
1388                "be inaccurate."
1389
1390    # Save sticky variable settings back to current variables file
1391    sticky_vars.Save(current_vars_file, env)
1392
1393    if env['USE_SSE2']:
1394        env.Append(CCFLAGS=['-msse2'])
1395
1396    # The src/SConscript file sets up the build rules in 'env' according
1397    # to the configured variables.  It returns a list of environments,
1398    # one for each variant build (debug, opt, etc.)
1399    SConscript('src/SConscript', variant_dir = variant_path, exports = 'env')
1400
1401def pairwise(iterable):
1402    "s -> (s0,s1), (s1,s2), (s2, s3), ..."
1403    a, b = itertools.tee(iterable)
1404    b.next()
1405    return itertools.izip(a, b)
1406
1407# Create false dependencies so SCons will parse ISAs, establish
1408# dependencies, and setup the build Environments serially. Either
1409# SCons (likely) and/or our SConscripts (possibly) cannot cope with -j
1410# greater than 1. It appears to be standard race condition stuff; it
1411# doesn't always fail, but usually, and the behaviors are different.
1412# Every time I tried to remove this, builds would fail in some
1413# creative new way. So, don't do that. You'll want to, though, because
1414# tests/SConscript takes a long time to make its Environments.
1415for t1, t2 in pairwise(sorted(all_isa_deps.iterkeys())):
1416    main.Depends('#%s-deps'     % t2, '#%s-deps'     % t1)
1417    main.Depends('#%s-environs' % t2, '#%s-environs' % t1)
1418
1419# base help text
1420Help('''
1421Usage: scons [scons options] [build variables] [target(s)]
1422
1423Extra scons options:
1424%(options)s
1425
1426Global build variables:
1427%(global_vars)s
1428
1429%(local_vars)s
1430''' % help_texts)
1431