SConstruct revision 9846
1955SN/A# -*- mode:python -*-
2955SN/A
35871Snate@binkert.org# Copyright (c) 2013 ARM Limited
41762SN/A# All rights reserved.
5955SN/A#
6955SN/A# The license below extends only to copyright in the software and shall
7955SN/A# not be construed as granting a license to any other intellectual
8955SN/A# property including but not limited to intellectual property relating
9955SN/A# to a hardware implementation of the functionality of the software
10955SN/A# licensed hereunder.  You may use the software subject to the license
11955SN/A# terms below provided that you ensure that this notice is replicated
12955SN/A# unmodified and in its entirety in all distributions of the software,
13955SN/A# modified or unmodified, in source code or in binary form.
14955SN/A#
15955SN/A# Copyright (c) 2011 Advanced Micro Devices, Inc.
16955SN/A# Copyright (c) 2009 The Hewlett-Packard Development Company
17955SN/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
292665Ssaidi@eecs.umich.edu# this software without specific prior written permission.
302665Ssaidi@eecs.umich.edu#
315863Snate@binkert.org# 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
372632Sstever@eecs.umich.edu# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
382632Sstever@eecs.umich.edu# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
392632Sstever@eecs.umich.edu# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
402632Sstever@eecs.umich.edu# (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.
422632Sstever@eecs.umich.edu#
432632Sstever@eecs.umich.edu# Authors: Steve Reinhardt
442761Sstever@eecs.umich.edu#          Nathan Binkert
452632Sstever@eecs.umich.edu
462632Sstever@eecs.umich.edu###################################################
472632Sstever@eecs.umich.edu#
482761Sstever@eecs.umich.edu# SCons top-level build description (SConstruct) file.
492761Sstever@eecs.umich.edu#
502761Sstever@eecs.umich.edu# 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>'
522632Sstever@eecs.umich.edu# to build some other configuration (e.g., 'build/ALPHA/gem5.opt' for
532761Sstever@eecs.umich.edu# the optimized full-system version).
542761Sstever@eecs.umich.edu#
552761Sstever@eecs.umich.edu# You can build gem5 in a different directory as long as there is a
562761Sstever@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:
612632Sstever@eecs.umich.edu#
622632Sstever@eecs.umich.edu#   The following two commands are equivalent.  The '-u' option tells
632632Sstever@eecs.umich.edu#   scons to search up the directory tree for this SConstruct file.
642632Sstever@eecs.umich.edu#   % cd <path-to-src>/gem5 ; scons build/ALPHA/gem5.debug
65955SN/A#   % cd <path-to-src>/gem5/build/ALPHA; scons -u gem5.debug
66955SN/A#
67955SN/A#   The following two commands are equivalent and demonstrate building
685863Snate@binkert.org#   in a directory outside of the source tree.  The '-C' option tells
695863Snate@binkert.org#   scons to chdir to the specified directory to find this SConstruct
705863Snate@binkert.org#   file.
715863Snate@binkert.org#   % cd <path-to-src>/gem5 ; scons /local/foo/build/ALPHA/gem5.debug
725863Snate@binkert.org#   % cd /local/foo/build/ALPHA; scons -C <path-to-src>/gem5 gem5.debug
735863Snate@binkert.org#
745863Snate@binkert.org# You can use 'scons -H' to print scons options.  If you're in this
755863Snate@binkert.org# 'gem5' directory (or use -u or -C to tell scons where to find this
765863Snate@binkert.org# file), you can use 'scons -h' to print all the gem5-specific build
775863Snate@binkert.org# options as well.
785863Snate@binkert.org#
795863Snate@binkert.org###################################################
805863Snate@binkert.org
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:
925863Snate@binkert.org    http://gem5.org/Dependencies
935863Snate@binkert.org"""
945863Snate@binkert.org    raise
955863Snate@binkert.org
965863Snate@binkert.org# We ensure the python version early because because python-config
975863Snate@binkert.org# requires python 2.5
985863Snate@binkert.orgtry:
99955SN/A    EnsurePythonVersion(2, 5)
1005396Ssaidi@eecs.umich.eduexcept SystemExit, e:
1015863Snate@binkert.org    print """
1025863Snate@binkert.orgYou can use a non-default installation of the Python interpreter by
1034202Sbinkertn@umich.edurearranging your PATH so that scons finds the non-default 'python' and
1045863Snate@binkert.org'python-config' first.
1055863Snate@binkert.org
1065863Snate@binkert.orgFor more details, see:
1075863Snate@binkert.org    http://gem5.org/wiki/index.php/Using_a_non-default_Python_installation
108955SN/A"""
1095273Sstever@gmail.com    raise
1105871Snate@binkert.org
1115273Sstever@gmail.com# Global Python includes
1125871Snate@binkert.orgimport os
1135863Snate@binkert.orgimport re
1145863Snate@binkert.orgimport subprocess
1155863Snate@binkert.orgimport sys
1165871Snate@binkert.org
1175872Snate@binkert.orgfrom os import mkdir, environ
1185872Snate@binkert.orgfrom os.path import abspath, basename, dirname, expanduser, normpath
1195872Snate@binkert.orgfrom os.path import exists,  isdir, isfile
1205871Snate@binkert.orgfrom os.path import join as joinpath, split as splitpath
1215871Snate@binkert.org
1225871Snate@binkert.org# SCons includes
1235871Snate@binkert.orgimport SCons
1245871Snate@binkert.orgimport SCons.Node
1255871Snate@binkert.org
1265871Snate@binkert.orgextra_python_paths = [
1275871Snate@binkert.org    Dir('src/python').srcnode().abspath, # gem5 includes
1285871Snate@binkert.org    Dir('ext/ply').srcnode().abspath, # ply is used by several files
1295871Snate@binkert.org    ]
1305871Snate@binkert.org
1315871Snate@binkert.orgsys.path[1:1] = extra_python_paths
1325871Snate@binkert.org
1335871Snate@binkert.orgfrom m5.util import compareVersions, readCommand
1345863Snate@binkert.orgfrom m5.util.terminal import get_termcap
1355227Ssaidi@eecs.umich.edu
1365396Ssaidi@eecs.umich.eduhelp_texts = {
1375396Ssaidi@eecs.umich.edu    "options" : "",
1385396Ssaidi@eecs.umich.edu    "global_vars" : "",
1395396Ssaidi@eecs.umich.edu    "local_vars" : ""
1405396Ssaidi@eecs.umich.edu}
1415396Ssaidi@eecs.umich.edu
1425396Ssaidi@eecs.umich.eduExport("help_texts")
1435396Ssaidi@eecs.umich.edu
1445588Ssaidi@eecs.umich.edu
1455396Ssaidi@eecs.umich.edu# There's a bug in scons in that (1) by default, the help texts from
1465396Ssaidi@eecs.umich.edu# AddOption() are supposed to be displayed when you type 'scons -h'
1475396Ssaidi@eecs.umich.edu# and (2) you can override the help displayed by 'scons -h' using the
1485396Ssaidi@eecs.umich.edu# Help() function, but these two features are incompatible: once
1495396Ssaidi@eecs.umich.edu# you've overridden the help text using Help(), there's no way to get
1505396Ssaidi@eecs.umich.edu# at the help texts from AddOptions.  See:
1515396Ssaidi@eecs.umich.edu#     http://scons.tigris.org/issues/show_bug.cgi?id=2356
1525396Ssaidi@eecs.umich.edu#     http://scons.tigris.org/issues/show_bug.cgi?id=2611
1535396Ssaidi@eecs.umich.edu# This hack lets us extract the help text from AddOptions and
1545396Ssaidi@eecs.umich.edu# re-inject it via Help().  Ideally someday this bug will be fixed and
1555396Ssaidi@eecs.umich.edu# we can just use AddOption directly.
1565396Ssaidi@eecs.umich.edudef AddLocalOption(*args, **kwargs):
1575396Ssaidi@eecs.umich.edu    col_width = 30
1585396Ssaidi@eecs.umich.edu
1595871Snate@binkert.org    help = "  " + ", ".join(args)
1605871Snate@binkert.org    if "help" in kwargs:
1615871Snate@binkert.org        length = len(help)
1625871Snate@binkert.org        if length >= col_width:
1635871Snate@binkert.org            help += "\n" + " " * col_width
1646003Snate@binkert.org        else:
1656003Snate@binkert.org            help += " " * (col_width - length)
166955SN/A        help += kwargs["help"]
1675871Snate@binkert.org    help_texts["options"] += help + "\n"
1685871Snate@binkert.org
1695871Snate@binkert.org    AddOption(*args, **kwargs)
1705871Snate@binkert.org
171955SN/AAddLocalOption('--colors', dest='use_colors', action='store_true',
1725871Snate@binkert.org               help="Add color to abbreviated scons output")
1735871Snate@binkert.orgAddLocalOption('--no-colors', dest='use_colors', action='store_false',
1745871Snate@binkert.org               help="Don't add color to abbreviated scons output")
1751533SN/AAddLocalOption('--default', dest='default', type='string', action='store',
1765871Snate@binkert.org               help='Override which build_opts file to use for defaults')
1775871Snate@binkert.orgAddLocalOption('--ignore-style', dest='ignore_style', action='store_true',
1785863Snate@binkert.org               help='Disable style checking hooks')
1795871Snate@binkert.orgAddLocalOption('--no-lto', dest='no_lto', action='store_true',
1805871Snate@binkert.org               help='Disable Link-Time Optimization for fast')
1815871Snate@binkert.orgAddLocalOption('--update-ref', dest='update_ref', action='store_true',
1825871Snate@binkert.org               help='Update test reference outputs')
1835871Snate@binkert.orgAddLocalOption('--verbose', dest='verbose', action='store_true',
1845863Snate@binkert.org               help='Print full tool command lines')
1855871Snate@binkert.org
1865863Snate@binkert.orgtermcap = get_termcap(GetOption('use_colors'))
1875871Snate@binkert.org
1884678Snate@binkert.org########################################################################
1894678Snate@binkert.org#
1904678Snate@binkert.org# Set up the main build environment.
1914678Snate@binkert.org#
1924678Snate@binkert.org########################################################################
1934678Snate@binkert.orguse_vars = set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH',
1944678Snate@binkert.org                 'LIBRARY_PATH', 'PATH', 'PKG_CONFIG_PATH', 'PYTHONPATH',
1954678Snate@binkert.org                 'RANLIB', 'SWIG' ])
1964678Snate@binkert.org
1974678Snate@binkert.orguse_prefixes = [
1984678Snate@binkert.org    "M5",           # M5 configuration (e.g., path to kernels)
1994678Snate@binkert.org    "DISTCC_",      # distcc (distributed compiler wrapper) configuration
2005871Snate@binkert.org    "CCACHE_",      # ccache (caching compiler wrapper) configuration
2014678Snate@binkert.org    "CCC_",         # clang static analyzer configuration
2025871Snate@binkert.org    ]
2035871Snate@binkert.org
2045871Snate@binkert.orguse_env = {}
2055871Snate@binkert.orgfor key,val in os.environ.iteritems():
2065871Snate@binkert.org    if key in use_vars or \
2075871Snate@binkert.org            any([key.startswith(prefix) for prefix in use_prefixes]):
2085871Snate@binkert.org        use_env[key] = val
2095871Snate@binkert.org
2105871Snate@binkert.orgmain = Environment(ENV=use_env)
2115871Snate@binkert.orgmain.Decider('MD5-timestamp')
2125871Snate@binkert.orgmain.root = Dir(".")         # The current directory (where this file lives).
2135871Snate@binkert.orgmain.srcdir = Dir("src")     # The source directory
2145871Snate@binkert.org
2155990Ssaidi@eecs.umich.edumain_dict_keys = main.Dictionary().keys()
2165871Snate@binkert.org
2175871Snate@binkert.org# Check that we have a C/C++ compiler
2185871Snate@binkert.orgif not ('CC' in main_dict_keys and 'CXX' in main_dict_keys):
2194678Snate@binkert.org    print "No C++ compiler installed (package g++ on Ubuntu and RedHat)"
2205871Snate@binkert.org    Exit(1)
2215871Snate@binkert.org
2225871Snate@binkert.org# Check that swig is present
2235871Snate@binkert.orgif not 'SWIG' in main_dict_keys:
2245871Snate@binkert.org    print "swig is not installed (package swig on Ubuntu and RedHat)"
2255871Snate@binkert.org    Exit(1)
2265871Snate@binkert.org
2275871Snate@binkert.org# add useful python code PYTHONPATH so it can be used by subprocesses
2285871Snate@binkert.org# as well
2295871Snate@binkert.orgmain.AppendENVPath('PYTHONPATH', extra_python_paths)
2304678Snate@binkert.org
2315871Snate@binkert.org########################################################################
2324678Snate@binkert.org#
2335871Snate@binkert.org# Mercurial Stuff.
2345871Snate@binkert.org#
2355871Snate@binkert.org# If the gem5 directory is a mercurial repository, we should do some
2365871Snate@binkert.org# extra things.
2375871Snate@binkert.org#
2385871Snate@binkert.org########################################################################
2395871Snate@binkert.org
2405871Snate@binkert.orghgdir = main.root.Dir(".hg")
2415871Snate@binkert.org
2425990Ssaidi@eecs.umich.edumercurial_style_message = """
2435863Snate@binkert.orgYou're missing the gem5 style hook, which automatically checks your code
244955SN/Aagainst the gem5 style rules on hg commit and qrefresh commands.  This
245955SN/Ascript will now install the hook in your .hg/hgrc file.
2462632Sstever@eecs.umich.eduPress enter to continue, or ctrl-c to abort: """
2472632Sstever@eecs.umich.edu
248955SN/Amercurial_style_hook = """
249955SN/A# The following lines were automatically added by gem5/SConstruct
250955SN/A# to provide the gem5 style-checking hooks
251955SN/A[extensions]
2525863Snate@binkert.orgstyle = %s/util/style.py
253955SN/A
2542632Sstever@eecs.umich.edu[hooks]
2552632Sstever@eecs.umich.edupretxncommit.style = python:style.check_style
2562632Sstever@eecs.umich.edupre-qrefresh.style = python:style.check_style
2572632Sstever@eecs.umich.edu# End of SConstruct additions
2582632Sstever@eecs.umich.edu
2592632Sstever@eecs.umich.edu""" % (main.root.abspath)
2602632Sstever@eecs.umich.edu
2612632Sstever@eecs.umich.edumercurial_lib_not_found = """
2622632Sstever@eecs.umich.eduMercurial libraries cannot be found, ignoring style hook.  If
2632632Sstever@eecs.umich.eduyou are a gem5 developer, please fix this and run the style
2642632Sstever@eecs.umich.eduhook. It is important.
2652632Sstever@eecs.umich.edu"""
2662632Sstever@eecs.umich.edu
2673718Sstever@eecs.umich.edu# Check for style hook and prompt for installation if it's not there.
2683718Sstever@eecs.umich.edu# Skip this if --ignore-style was specified, there's no .hg dir to
2693718Sstever@eecs.umich.edu# install a hook in, or there's no interactive terminal to prompt.
2703718Sstever@eecs.umich.eduif not GetOption('ignore_style') and hgdir.exists() and sys.stdin.isatty():
2713718Sstever@eecs.umich.edu    style_hook = True
2725863Snate@binkert.org    try:
2735863Snate@binkert.org        from mercurial import ui
2743718Sstever@eecs.umich.edu        ui = ui.ui()
2753718Sstever@eecs.umich.edu        ui.readconfig(hgdir.File('hgrc').abspath)
2765863Snate@binkert.org        style_hook = ui.config('hooks', 'pretxncommit.style', None) and \
2775863Snate@binkert.org                     ui.config('hooks', 'pre-qrefresh.style', None)
2783718Sstever@eecs.umich.edu    except ImportError:
2793718Sstever@eecs.umich.edu        print mercurial_lib_not_found
2802634Sstever@eecs.umich.edu
2812634Sstever@eecs.umich.edu    if not style_hook:
2825863Snate@binkert.org        print mercurial_style_message,
2832638Sstever@eecs.umich.edu        # continue unless user does ctrl-c/ctrl-d etc.
2842632Sstever@eecs.umich.edu        try:
2852632Sstever@eecs.umich.edu            raw_input()
2862632Sstever@eecs.umich.edu        except:
2872632Sstever@eecs.umich.edu            print "Input exception, exiting scons.\n"
2882632Sstever@eecs.umich.edu            sys.exit(1)
2892632Sstever@eecs.umich.edu        hgrc_path = '%s/.hg/hgrc' % main.root.abspath
2901858SN/A        print "Adding style hook to", hgrc_path, "\n"
2913716Sstever@eecs.umich.edu        try:
2922638Sstever@eecs.umich.edu            hgrc = open(hgrc_path, 'a')
2932638Sstever@eecs.umich.edu            hgrc.write(mercurial_style_hook)
2942638Sstever@eecs.umich.edu            hgrc.close()
2952638Sstever@eecs.umich.edu        except:
2962638Sstever@eecs.umich.edu            print "Error updating", hgrc_path
2972638Sstever@eecs.umich.edu            sys.exit(1)
2982638Sstever@eecs.umich.edu
2995863Snate@binkert.org
3005863Snate@binkert.org###################################################
3015863Snate@binkert.org#
302955SN/A# Figure out which configurations to set up based on the path(s) of
3035341Sstever@gmail.com# the target(s).
3045341Sstever@gmail.com#
3055863Snate@binkert.org###################################################
3065341Sstever@gmail.com
3074494Ssaidi@eecs.umich.edu# Find default configuration & binary.
3084494Ssaidi@eecs.umich.eduDefault(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug'))
3095863Snate@binkert.org
3101105SN/A# helper function: find last occurrence of element in list
3112667Sstever@eecs.umich.edudef rfind(l, elt, offs = -1):
3122667Sstever@eecs.umich.edu    for i in range(len(l)+offs, 0, -1):
3132667Sstever@eecs.umich.edu        if l[i] == elt:
3142667Sstever@eecs.umich.edu            return i
3152667Sstever@eecs.umich.edu    raise ValueError, "element not found"
3162667Sstever@eecs.umich.edu
3175341Sstever@gmail.com# Take a list of paths (or SCons Nodes) and return a list with all
3185863Snate@binkert.org# paths made absolute and ~-expanded.  Paths will be interpreted
3195341Sstever@gmail.com# relative to the launch directory unless a different root is provided
3205341Sstever@gmail.comdef makePathListAbsolute(path_list, root=GetLaunchDir()):
3215341Sstever@gmail.com    return [abspath(joinpath(root, expanduser(str(p))))
3225863Snate@binkert.org            for p in path_list]
3235341Sstever@gmail.com
3245341Sstever@gmail.com# Each target must have 'build' in the interior of the path; the
3255341Sstever@gmail.com# directory below this will determine the build parameters.  For
3265863Snate@binkert.org# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
3275341Sstever@gmail.com# recognize that ALPHA_SE specifies the configuration because it
3285341Sstever@gmail.com# follow 'build' in the build path.
3295341Sstever@gmail.com
3305341Sstever@gmail.com# The funky assignment to "[:]" is needed to replace the list contents
3315341Sstever@gmail.com# in place rather than reassign the symbol to a new list, which
3325341Sstever@gmail.com# doesn't work (obviously!).
3335341Sstever@gmail.comBUILD_TARGETS[:] = makePathListAbsolute(BUILD_TARGETS)
3345341Sstever@gmail.com
3355341Sstever@gmail.com# Generate a list of the unique build roots and configs that the
3365341Sstever@gmail.com# collected targets reference.
3375863Snate@binkert.orgvariant_paths = []
3385341Sstever@gmail.combuild_root = None
3395863Snate@binkert.orgfor t in BUILD_TARGETS:
3405341Sstever@gmail.com    path_dirs = t.split('/')
3415863Snate@binkert.org    try:
3425863Snate@binkert.org        build_top = rfind(path_dirs, 'build', -2)
3435863Snate@binkert.org    except:
3445397Ssaidi@eecs.umich.edu        print "Error: no non-leaf 'build' dir found on target path", t
3455397Ssaidi@eecs.umich.edu        Exit(1)
3465341Sstever@gmail.com    this_build_root = joinpath('/',*path_dirs[:build_top+1])
3475341Sstever@gmail.com    if not build_root:
3485341Sstever@gmail.com        build_root = this_build_root
3495341Sstever@gmail.com    else:
3505341Sstever@gmail.com        if this_build_root != build_root:
3515341Sstever@gmail.com            print "Error: build targets not under same build root\n"\
3525341Sstever@gmail.com                  "  %s\n  %s" % (build_root, this_build_root)
3535341Sstever@gmail.com            Exit(1)
3545863Snate@binkert.org    variant_path = joinpath('/',*path_dirs[:build_top+2])
3555341Sstever@gmail.com    if variant_path not in variant_paths:
3565341Sstever@gmail.com        variant_paths.append(variant_path)
3575863Snate@binkert.org
3585341Sstever@gmail.com# Make sure build_root exists (might not if this is the first build there)
3595863Snate@binkert.orgif not isdir(build_root):
3605863Snate@binkert.org    mkdir(build_root)
3615341Sstever@gmail.commain['BUILDROOT'] = build_root
3625863Snate@binkert.org
3635863Snate@binkert.orgExport('main')
3645341Sstever@gmail.com
3655863Snate@binkert.orgmain.SConsignFile(joinpath(build_root, "sconsign"))
3665341Sstever@gmail.com
3675871Snate@binkert.org# Default duplicate option is to use hard links, but this messes up
3685341Sstever@gmail.com# when you use emacs to edit a file in the target dir, as emacs moves
3695742Snate@binkert.org# file to file~ then copies to file, breaking the link.  Symbolic
3705742Snate@binkert.org# (soft) links work better.
3715742Snate@binkert.orgmain.SetOption('duplicate', 'soft-copy')
3725341Sstever@gmail.com
3735742Snate@binkert.org#
3745742Snate@binkert.org# Set up global sticky variables... these are common to an entire build
3755341Sstever@gmail.com# tree (not specific to a particular build like ALPHA_SE)
3766017Snate@binkert.org#
3776017Snate@binkert.org
3786017Snate@binkert.orgglobal_vars_file = joinpath(build_root, 'variables.global')
3792632Sstever@eecs.umich.edu
3806016Snate@binkert.orgglobal_vars = Variables(global_vars_file, args=ARGUMENTS)
3815871Snate@binkert.org
3825871Snate@binkert.orgglobal_vars.AddVariables(
3835871Snate@binkert.org    ('CC', 'C compiler', environ.get('CC', main['CC'])),
3845871Snate@binkert.org    ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])),
3855871Snate@binkert.org    ('SWIG', 'SWIG tool', environ.get('SWIG', main['SWIG'])),
3865871Snate@binkert.org    ('PROTOC', 'protoc tool', environ.get('PROTOC', 'protoc')),
3875871Snate@binkert.org    ('BATCH', 'Use batch pool for build and tests', False),
3883942Ssaidi@eecs.umich.edu    ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
3893940Ssaidi@eecs.umich.edu    ('M5_BUILD_CACHE', 'Cache built objects in this directory', False),
3903918Ssaidi@eecs.umich.edu    ('EXTRAS', 'Add extra directories to the compilation', '')
3913918Ssaidi@eecs.umich.edu    )
3921858SN/A
3933918Ssaidi@eecs.umich.edu# Update main environment with values from ARGUMENTS & global_vars_file
3943918Ssaidi@eecs.umich.eduglobal_vars.Update(main)
3953918Ssaidi@eecs.umich.eduhelp_texts["global_vars"] += global_vars.GenerateHelpText(main)
3963918Ssaidi@eecs.umich.edu
3975571Snate@binkert.org# Save sticky variable settings back to current variables file
3983940Ssaidi@eecs.umich.eduglobal_vars.Save(global_vars_file, main)
3993940Ssaidi@eecs.umich.edu
4003918Ssaidi@eecs.umich.edu# Parse EXTRAS variable to build list of all directories where we're
4013918Ssaidi@eecs.umich.edu# look for sources etc.  This list is exported as extras_dir_list.
4023918Ssaidi@eecs.umich.edubase_dir = main.srcdir.abspath
4033918Ssaidi@eecs.umich.eduif main['EXTRAS']:
4043918Ssaidi@eecs.umich.edu    extras_dir_list = makePathListAbsolute(main['EXTRAS'].split(':'))
4053918Ssaidi@eecs.umich.eduelse:
4065871Snate@binkert.org    extras_dir_list = []
4073918Ssaidi@eecs.umich.edu
4083918Ssaidi@eecs.umich.eduExport('base_dir')
4093940Ssaidi@eecs.umich.eduExport('extras_dir_list')
4103918Ssaidi@eecs.umich.edu
4113918Ssaidi@eecs.umich.edu# the ext directory should be on the #includes path
4125397Ssaidi@eecs.umich.edumain.Append(CPPPATH=[Dir('ext')])
4135397Ssaidi@eecs.umich.edu
4145397Ssaidi@eecs.umich.edudef strip_build_path(path, env):
4155708Ssaidi@eecs.umich.edu    path = str(path)
4165708Ssaidi@eecs.umich.edu    variant_base = env['BUILDROOT'] + os.path.sep
4175708Ssaidi@eecs.umich.edu    if path.startswith(variant_base):
4185708Ssaidi@eecs.umich.edu        path = path[len(variant_base):]
4195708Ssaidi@eecs.umich.edu    elif path.startswith('build/'):
4205397Ssaidi@eecs.umich.edu        path = path[6:]
4211851SN/A    return path
4221851SN/A
4231858SN/A# Generate a string of the form:
424955SN/A#   common/path/prefix/src1, src2 -> tgt1, tgt2
4253053Sstever@eecs.umich.edu# to print while building.
4263053Sstever@eecs.umich.educlass Transform(object):
4273053Sstever@eecs.umich.edu    # all specific color settings should be here and nowhere else
4283053Sstever@eecs.umich.edu    tool_color = termcap.Normal
4293053Sstever@eecs.umich.edu    pfx_color = termcap.Yellow
4303053Sstever@eecs.umich.edu    srcs_color = termcap.Yellow + termcap.Bold
4313053Sstever@eecs.umich.edu    arrow_color = termcap.Blue + termcap.Bold
4325871Snate@binkert.org    tgts_color = termcap.Yellow + termcap.Bold
4333053Sstever@eecs.umich.edu
4344742Sstever@eecs.umich.edu    def __init__(self, tool, max_sources=99):
4354742Sstever@eecs.umich.edu        self.format = self.tool_color + (" [%8s] " % tool) \
4363053Sstever@eecs.umich.edu                      + self.pfx_color + "%s" \
4373053Sstever@eecs.umich.edu                      + self.srcs_color + "%s" \
4383053Sstever@eecs.umich.edu                      + self.arrow_color + " -> " \
4393053Sstever@eecs.umich.edu                      + self.tgts_color + "%s" \
4403053Sstever@eecs.umich.edu                      + termcap.Normal
4413053Sstever@eecs.umich.edu        self.max_sources = max_sources
4423053Sstever@eecs.umich.edu
4433053Sstever@eecs.umich.edu    def __call__(self, target, source, env, for_signature=None):
4443053Sstever@eecs.umich.edu        # truncate source list according to max_sources param
4452667Sstever@eecs.umich.edu        source = source[0:self.max_sources]
4464554Sbinkertn@umich.edu        def strip(f):
4474554Sbinkertn@umich.edu            return strip_build_path(str(f), env)
4482667Sstever@eecs.umich.edu        if len(source) > 0:
4494554Sbinkertn@umich.edu            srcs = map(strip, source)
4504554Sbinkertn@umich.edu        else:
4514554Sbinkertn@umich.edu            srcs = ['']
4524554Sbinkertn@umich.edu        tgts = map(strip, target)
4534554Sbinkertn@umich.edu        # surprisingly, os.path.commonprefix is a dumb char-by-char string
4544554Sbinkertn@umich.edu        # operation that has nothing to do with paths.
4554554Sbinkertn@umich.edu        com_pfx = os.path.commonprefix(srcs + tgts)
4564781Snate@binkert.org        com_pfx_len = len(com_pfx)
4574554Sbinkertn@umich.edu        if com_pfx:
4584554Sbinkertn@umich.edu            # do some cleanup and sanity checking on common prefix
4592667Sstever@eecs.umich.edu            if com_pfx[-1] == ".":
4604554Sbinkertn@umich.edu                # prefix matches all but file extension: ok
4614554Sbinkertn@umich.edu                # back up one to change 'foo.cc -> o' to 'foo.cc -> .o'
4624554Sbinkertn@umich.edu                com_pfx = com_pfx[0:-1]
4634554Sbinkertn@umich.edu            elif com_pfx[-1] == "/":
4642667Sstever@eecs.umich.edu                # common prefix is directory path: OK
4654554Sbinkertn@umich.edu                pass
4662667Sstever@eecs.umich.edu            else:
4674554Sbinkertn@umich.edu                src0_len = len(srcs[0])
4684554Sbinkertn@umich.edu                tgt0_len = len(tgts[0])
4692667Sstever@eecs.umich.edu                if src0_len == com_pfx_len:
4705522Snate@binkert.org                    # source is a substring of target, OK
4715522Snate@binkert.org                    pass
4725522Snate@binkert.org                elif tgt0_len == com_pfx_len:
4735522Snate@binkert.org                    # target is a substring of source, need to back up to
4745522Snate@binkert.org                    # avoid empty string on RHS of arrow
4755522Snate@binkert.org                    sep_idx = com_pfx.rfind(".")
4765522Snate@binkert.org                    if sep_idx != -1:
4775522Snate@binkert.org                        com_pfx = com_pfx[0:sep_idx]
4785522Snate@binkert.org                    else:
4795522Snate@binkert.org                        com_pfx = ''
4805522Snate@binkert.org                elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".":
4815522Snate@binkert.org                    # still splitting at file extension: ok
4825522Snate@binkert.org                    pass
4835522Snate@binkert.org                else:
4845522Snate@binkert.org                    # probably a fluke; ignore it
4855522Snate@binkert.org                    com_pfx = ''
4865522Snate@binkert.org        # recalculate length in case com_pfx was modified
4875522Snate@binkert.org        com_pfx_len = len(com_pfx)
4885522Snate@binkert.org        def fmt(files):
4895522Snate@binkert.org            f = map(lambda s: s[com_pfx_len:], files)
4905522Snate@binkert.org            return ', '.join(f)
4915522Snate@binkert.org        return self.format % (com_pfx, fmt(srcs), fmt(tgts))
4925522Snate@binkert.org
4935522Snate@binkert.orgExport('Transform')
4945522Snate@binkert.org
4955522Snate@binkert.org# enable the regression script to use the termcap
4962638Sstever@eecs.umich.edumain['TERMCAP'] = termcap
4972638Sstever@eecs.umich.edu
4982638Sstever@eecs.umich.eduif GetOption('verbose'):
4993716Sstever@eecs.umich.edu    def MakeAction(action, string, *args, **kwargs):
5005522Snate@binkert.org        return Action(action, *args, **kwargs)
5015522Snate@binkert.orgelse:
5025522Snate@binkert.org    MakeAction = Action
5035522Snate@binkert.org    main['CCCOMSTR']        = Transform("CC")
5045522Snate@binkert.org    main['CXXCOMSTR']       = Transform("CXX")
5055522Snate@binkert.org    main['ASCOMSTR']        = Transform("AS")
5061858SN/A    main['SWIGCOMSTR']      = Transform("SWIG")
5075227Ssaidi@eecs.umich.edu    main['ARCOMSTR']        = Transform("AR", 0)
5085227Ssaidi@eecs.umich.edu    main['LINKCOMSTR']      = Transform("LINK", 0)
5095227Ssaidi@eecs.umich.edu    main['RANLIBCOMSTR']    = Transform("RANLIB", 0)
5105227Ssaidi@eecs.umich.edu    main['M4COMSTR']        = Transform("M4")
5115227Ssaidi@eecs.umich.edu    main['SHCCCOMSTR']      = Transform("SHCC")
5125863Snate@binkert.org    main['SHCXXCOMSTR']     = Transform("SHCXX")
5135227Ssaidi@eecs.umich.eduExport('MakeAction')
5145227Ssaidi@eecs.umich.edu
5155227Ssaidi@eecs.umich.edu# Initialize the Link-Time Optimization (LTO) flags
5165227Ssaidi@eecs.umich.edumain['LTO_CCFLAGS'] = []
5175227Ssaidi@eecs.umich.edumain['LTO_LDFLAGS'] = []
5185227Ssaidi@eecs.umich.edu
5195227Ssaidi@eecs.umich.edu# According to the readme, tcmalloc works best if the compiler doesn't
5205204Sstever@gmail.com# assume that we're using the builtin malloc and friends. These flags
5215204Sstever@gmail.com# are compiler-specific, so we need to set them after we detect which
5225204Sstever@gmail.com# compiler we're using.
5235204Sstever@gmail.commain['TCMALLOC_CCFLAGS'] = []
5245204Sstever@gmail.com
5255204Sstever@gmail.comCXX_version = readCommand([main['CXX'],'--version'], exception=False)
5265204Sstever@gmail.comCXX_V = readCommand([main['CXX'],'-V'], exception=False)
5275204Sstever@gmail.com
5285204Sstever@gmail.commain['GCC'] = CXX_version and CXX_version.find('g++') >= 0
5295204Sstever@gmail.commain['CLANG'] = CXX_version and CXX_version.find('clang') >= 0
5305204Sstever@gmail.comif main['GCC'] + main['CLANG'] > 1:
5315204Sstever@gmail.com    print 'Error: How can we have two at the same time?'
5325204Sstever@gmail.com    Exit(1)
5335204Sstever@gmail.com
5345204Sstever@gmail.com# Set up default C++ compiler flags
5355204Sstever@gmail.comif main['GCC'] or main['CLANG']:
5365204Sstever@gmail.com    # As gcc and clang share many flags, do the common parts here
5375204Sstever@gmail.com    main.Append(CCFLAGS=['-pipe'])
5385204Sstever@gmail.com    main.Append(CCFLAGS=['-fno-strict-aliasing'])
5393118Sstever@eecs.umich.edu    # Enable -Wall and then disable the few warnings that we
5403118Sstever@eecs.umich.edu    # consistently violate
5413118Sstever@eecs.umich.edu    main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef'])
5423118Sstever@eecs.umich.edu    # We always compile using C++11, but only gcc >= 4.7 and clang 3.1
5433118Sstever@eecs.umich.edu    # actually use that name, so we stick with c++0x
5445863Snate@binkert.org    main.Append(CXXFLAGS=['-std=c++0x'])
5453118Sstever@eecs.umich.edu    # Add selected sanity checks from -Wextra
5465863Snate@binkert.org    main.Append(CXXFLAGS=['-Wmissing-field-initializers',
5473118Sstever@eecs.umich.edu                          '-Woverloaded-virtual'])
5485863Snate@binkert.orgelse:
5495863Snate@binkert.org    print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal,
5505863Snate@binkert.org    print "Don't know what compiler options to use for your compiler."
5515863Snate@binkert.org    print termcap.Yellow + '       compiler:' + termcap.Normal, main['CXX']
5525863Snate@binkert.org    print termcap.Yellow + '       version:' + termcap.Normal,
5535863Snate@binkert.org    if not CXX_version:
5545863Snate@binkert.org        print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\
5555863Snate@binkert.org               termcap.Normal
5566003Snate@binkert.org    else:
5575863Snate@binkert.org        print CXX_version.replace('\n', '<nl>')
5585863Snate@binkert.org    print "       If you're trying to use a compiler other than GCC"
5595863Snate@binkert.org    print "       or clang, there appears to be something wrong with your"
5605863Snate@binkert.org    print "       environment."
5615863Snate@binkert.org    print "       "
5625863Snate@binkert.org    print "       If you are trying to use a compiler other than those listed"
5635863Snate@binkert.org    print "       above you will need to ease fix SConstruct and "
5645863Snate@binkert.org    print "       src/SConscript to support that compiler."
5655863Snate@binkert.org    Exit(1)
5665863Snate@binkert.org
5675863Snate@binkert.orgif main['GCC']:
5685863Snate@binkert.org    # Check for a supported version of gcc, >= 4.4 is needed for c++0x
5695863Snate@binkert.org    # support. See http://gcc.gnu.org/projects/cxx0x.html for details
5705863Snate@binkert.org    gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False)
5715863Snate@binkert.org    if compareVersions(gcc_version, "4.4") < 0:
5723118Sstever@eecs.umich.edu        print 'Error: gcc version 4.4 or newer required.'
5735863Snate@binkert.org        print '       Installed version:', gcc_version
5743118Sstever@eecs.umich.edu        Exit(1)
5753118Sstever@eecs.umich.edu
5765863Snate@binkert.org    main['GCC_VERSION'] = gcc_version
5775863Snate@binkert.org
5785863Snate@binkert.org    # Check for versions with bugs
5795863Snate@binkert.org    if not compareVersions(gcc_version, '4.4.1') or \
5805863Snate@binkert.org       not compareVersions(gcc_version, '4.4.2'):
5815863Snate@binkert.org        print 'Info: Tree vectorizer in GCC 4.4.1 & 4.4.2 is buggy, disabling.'
5823118Sstever@eecs.umich.edu        main.Append(CCFLAGS=['-fno-tree-vectorize'])
5833483Ssaidi@eecs.umich.edu
5843494Ssaidi@eecs.umich.edu    # LTO support is only really working properly from 4.6 and beyond
5853494Ssaidi@eecs.umich.edu    if compareVersions(gcc_version, '4.6') >= 0:
5863483Ssaidi@eecs.umich.edu        # Add the appropriate Link-Time Optimization (LTO) flags
5873483Ssaidi@eecs.umich.edu        # unless LTO is explicitly turned off. Note that these flags
5883483Ssaidi@eecs.umich.edu        # are only used by the fast target.
5893053Sstever@eecs.umich.edu        if not GetOption('no_lto'):
5903053Sstever@eecs.umich.edu            # Pass the LTO flag when compiling to produce GIMPLE
5913918Ssaidi@eecs.umich.edu            # output, we merely create the flags here and only append
5923053Sstever@eecs.umich.edu            # them later/
5933053Sstever@eecs.umich.edu            main['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
5943053Sstever@eecs.umich.edu
5953053Sstever@eecs.umich.edu            # Use the same amount of jobs for LTO as we are running
5963053Sstever@eecs.umich.edu            # scons with, we hardcode the use of the linker plugin
5971858SN/A            # which requires either gold or GNU ld >= 2.21
5981858SN/A            main['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs'),
5991858SN/A                                   '-fuse-linker-plugin']
6001858SN/A
6011858SN/A    main.Append(TCMALLOC_CCFLAGS=['-fno-builtin-malloc', '-fno-builtin-calloc',
6021858SN/A                                  '-fno-builtin-realloc', '-fno-builtin-free'])
6035863Snate@binkert.org
6045863Snate@binkert.orgelif main['CLANG']:
6051859SN/A    # Check for a supported version of clang, >= 2.9 is needed to
6065863Snate@binkert.org    # support similar features as gcc 4.4. See
6071858SN/A    # http://clang.llvm.org/cxx_status.html for details
6085863Snate@binkert.org    clang_version_re = re.compile(".* version (\d+\.\d+)")
6091858SN/A    clang_version_match = clang_version_re.match(CXX_version)
6101859SN/A    if (clang_version_match):
6111859SN/A        clang_version = clang_version_match.groups()[0]
6125863Snate@binkert.org        if compareVersions(clang_version, "2.9") < 0:
6133053Sstever@eecs.umich.edu            print 'Error: clang version 2.9 or newer required.'
6143053Sstever@eecs.umich.edu            print '       Installed version:', clang_version
6153053Sstever@eecs.umich.edu            Exit(1)
6163053Sstever@eecs.umich.edu    else:
6171859SN/A        print 'Error: Unable to determine clang version.'
6181859SN/A        Exit(1)
6191859SN/A
6201859SN/A    # clang has a few additional warnings that we disable,
6211859SN/A    # tautological comparisons are allowed due to unsigned integers
6221859SN/A    # being compared to constants that happen to be 0, and extraneous
6231859SN/A    # parantheses are allowed due to Ruby's printing of the AST,
6241859SN/A    # finally self assignments are allowed as the generated CPU code
6251862SN/A    # is relying on this
6261859SN/A    main.Append(CCFLAGS=['-Wno-tautological-compare',
6271859SN/A                         '-Wno-parentheses',
6281859SN/A                         '-Wno-self-assign'])
6295863Snate@binkert.org
6305863Snate@binkert.org    main.Append(TCMALLOC_CCFLAGS=['-fno-builtin'])
6315863Snate@binkert.org
6325863Snate@binkert.org    # On Mac OS X/Darwin we need to also use libc++ (part of XCode) as
6331858SN/A    # opposed to libstdc++, as the later is dated.
6341858SN/A    if sys.platform == "darwin":
6355863Snate@binkert.org        main.Append(CXXFLAGS=['-stdlib=libc++'])
6365863Snate@binkert.org        main.Append(LIBS=['c++'])
6375863Snate@binkert.org
6385863Snate@binkert.orgelse:
6395863Snate@binkert.org    print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal,
6405871Snate@binkert.org    print "Don't know what compiler options to use for your compiler."
6415871Snate@binkert.org    print termcap.Yellow + '       compiler:' + termcap.Normal, main['CXX']
6422139SN/A    print termcap.Yellow + '       version:' + termcap.Normal,
6434202Sbinkertn@umich.edu    if not CXX_version:
6444202Sbinkertn@umich.edu        print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\
6452139SN/A               termcap.Normal
6462155SN/A    else:
6474202Sbinkertn@umich.edu        print CXX_version.replace('\n', '<nl>')
6484202Sbinkertn@umich.edu    print "       If you're trying to use a compiler other than GCC"
6494202Sbinkertn@umich.edu    print "       or clang, there appears to be something wrong with your"
6502155SN/A    print "       environment."
6515863Snate@binkert.org    print "       "
6521869SN/A    print "       If you are trying to use a compiler other than those listed"
6531869SN/A    print "       above you will need to ease fix SConstruct and "
6545863Snate@binkert.org    print "       src/SConscript to support that compiler."
6555863Snate@binkert.org    Exit(1)
6564202Sbinkertn@umich.edu
6575863Snate@binkert.org# Set up common yacc/bison flags (needed for Ruby)
6585863Snate@binkert.orgmain['YACCFLAGS'] = '-d'
6595863Snate@binkert.orgmain['YACCHXXFILESUFFIX'] = '.hh'
6604202Sbinkertn@umich.edu
6614202Sbinkertn@umich.edu# Do this after we save setting back, or else we'll tack on an
6625863Snate@binkert.org# extra 'qdo' every time we run scons.
6635742Snate@binkert.orgif main['BATCH']:
6645742Snate@binkert.org    main['CC']     = main['BATCH_CMD'] + ' ' + main['CC']
6655341Sstever@gmail.com    main['CXX']    = main['BATCH_CMD'] + ' ' + main['CXX']
6665342Sstever@gmail.com    main['AS']     = main['BATCH_CMD'] + ' ' + main['AS']
6675342Sstever@gmail.com    main['AR']     = main['BATCH_CMD'] + ' ' + main['AR']
6684202Sbinkertn@umich.edu    main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB']
6694202Sbinkertn@umich.edu
6704202Sbinkertn@umich.eduif sys.platform == 'cygwin':
6714202Sbinkertn@umich.edu    # cygwin has some header file issues...
6724202Sbinkertn@umich.edu    main.Append(CCFLAGS=["-Wno-uninitialized"])
6735863Snate@binkert.org
6745863Snate@binkert.org# Check for the protobuf compiler
6755863Snate@binkert.orgprotoc_version = readCommand([main['PROTOC'], '--version'],
6765863Snate@binkert.org                             exception='').split()
6775863Snate@binkert.org
6785863Snate@binkert.org# First two words should be "libprotoc x.y.z"
6795863Snate@binkert.orgif len(protoc_version) < 2 or protoc_version[0] != 'libprotoc':
6805863Snate@binkert.org    print termcap.Yellow + termcap.Bold + \
6815863Snate@binkert.org        'Warning: Protocol buffer compiler (protoc) not found.\n' + \
6825863Snate@binkert.org        '         Please install protobuf-compiler for tracing support.' + \
6835863Snate@binkert.org        termcap.Normal
6845863Snate@binkert.org    main['PROTOC'] = False
6855863Snate@binkert.orgelse:
6865863Snate@binkert.org    # Based on the availability of the compress stream wrappers,
6875863Snate@binkert.org    # require 2.1.0
6885863Snate@binkert.org    min_protoc_version = '2.1.0'
6895863Snate@binkert.org    if compareVersions(protoc_version[1], min_protoc_version) < 0:
6905863Snate@binkert.org        print termcap.Yellow + termcap.Bold + \
6915863Snate@binkert.org            'Warning: protoc version', min_protoc_version, \
6925863Snate@binkert.org            'or newer required.\n' + \
6935952Ssaidi@eecs.umich.edu            '         Installed version:', protoc_version[1], \
6941869SN/A            termcap.Normal
6951858SN/A        main['PROTOC'] = False
6965863Snate@binkert.org    else:
6975863Snate@binkert.org        # Attempt to determine the appropriate include path and
6981869SN/A        # library path using pkg-config, that means we also need to
6991858SN/A        # check for pkg-config. Note that it is possible to use
7005863Snate@binkert.org        # protobuf without the involvement of pkg-config. Later on we
7015863Snate@binkert.org        # check go a library config check and at that point the test
7025863Snate@binkert.org        # will fail if libprotobuf cannot be found.
7035863Snate@binkert.org        if readCommand(['pkg-config', '--version'], exception=''):
7045952Ssaidi@eecs.umich.edu            try:
7051858SN/A                # Attempt to establish what linking flags to add for protobuf
706955SN/A                # using pkg-config
707955SN/A                main.ParseConfig('pkg-config --cflags --libs-only-L protobuf')
7081869SN/A            except:
7091869SN/A                print termcap.Yellow + termcap.Bold + \
7101869SN/A                    'Warning: pkg-config could not get protobuf flags.' + \
7111869SN/A                    termcap.Normal
7121869SN/A
7135863Snate@binkert.org# Check for SWIG
7145863Snate@binkert.orgif not main.has_key('SWIG'):
7155863Snate@binkert.org    print 'Error: SWIG utility not found.'
7161869SN/A    print '       Please install (see http://www.swig.org) and retry.'
7175863Snate@binkert.org    Exit(1)
7181869SN/A
7195863Snate@binkert.org# Check for appropriate SWIG version
7201869SN/Aswig_version = readCommand([main['SWIG'], '-version'], exception='').split()
7211869SN/A# First 3 words should be "SWIG Version x.y.z"
7221869SN/Aif len(swig_version) < 3 or \
7231869SN/A        swig_version[0] != 'SWIG' or swig_version[1] != 'Version':
7241869SN/A    print 'Error determining SWIG version.'
7255863Snate@binkert.org    Exit(1)
7265863Snate@binkert.org
7271869SN/Amin_swig_version = '1.3.34'
7281869SN/Aif compareVersions(swig_version[2], min_swig_version) < 0:
7291869SN/A    print 'Error: SWIG version', min_swig_version, 'or newer required.'
7301869SN/A    print '       Installed version:', swig_version[2]
7311869SN/A    Exit(1)
7321869SN/A
7331869SN/Aif swig_version[2] in ["2.0.9", "2.0.10"]:
7345863Snate@binkert.org    print '\n' + termcap.Yellow + termcap.Bold + \
7355863Snate@binkert.org        'Warning: SWIG version 2.0.9/10 sometimes generates broken code.\n' + \
7361869SN/A        termcap.Normal + \
7375863Snate@binkert.org        'This problem only affects some platforms and some Python\n' + \
7385863Snate@binkert.org        'versions. See the following SWIG bug report for details:\n' + \
7393356Sbinkertn@umich.edu        'http://sourceforge.net/p/swig/bugs/1297/\n'
7403356Sbinkertn@umich.edu
7413356Sbinkertn@umich.edu
7423356Sbinkertn@umich.edu# Set up SWIG flags & scanner
7433356Sbinkertn@umich.eduswig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
7444781Snate@binkert.orgmain.Append(SWIGFLAGS=swig_flags)
7455863Snate@binkert.org
7465863Snate@binkert.org# filter out all existing swig scanners, they mess up the dependency
7471869SN/A# stuff for some reason
7481869SN/Ascanners = []
7491869SN/Afor scanner in main['SCANNERS']:
7501869SN/A    skeys = scanner.skeys
7511869SN/A    if skeys == '.i':
7522638Sstever@eecs.umich.edu        continue
7532638Sstever@eecs.umich.edu
7545871Snate@binkert.org    if isinstance(skeys, (list, tuple)) and '.i' in skeys:
7552638Sstever@eecs.umich.edu        continue
7565749Scws3k@cs.virginia.edu
7575749Scws3k@cs.virginia.edu    scanners.append(scanner)
7585871Snate@binkert.org
7595749Scws3k@cs.virginia.edu# add the new swig scanner that we like better
7601869SN/Afrom SCons.Scanner import ClassicCPP as CPPScanner
7611869SN/Aswig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
7623546Sgblack@eecs.umich.eduscanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re))
7633546Sgblack@eecs.umich.edu
7643546Sgblack@eecs.umich.edu# replace the scanners list that has what we want
7653546Sgblack@eecs.umich.edumain['SCANNERS'] = scanners
7664202Sbinkertn@umich.edu
7675863Snate@binkert.org# Add a custom Check function to the Configure context so that we can
7683546Sgblack@eecs.umich.edu# figure out if the compiler adds leading underscores to global
7693546Sgblack@eecs.umich.edu# variables.  This is needed for the autogenerated asm files that we
7703546Sgblack@eecs.umich.edu# use for embedding the python code.
7713546Sgblack@eecs.umich.edudef CheckLeading(context):
7724781Snate@binkert.org    context.Message("Checking for leading underscore in global variables...")
7735863Snate@binkert.org    # 1) Define a global variable called x from asm so the C compiler
7744781Snate@binkert.org    #    won't change the symbol at all.
7754781Snate@binkert.org    # 2) Declare that variable.
7764781Snate@binkert.org    # 3) Use the variable
7774781Snate@binkert.org    #
7784781Snate@binkert.org    # If the compiler prepends an underscore, this will successfully
7795863Snate@binkert.org    # link because the external symbol 'x' will be called '_x' which
7804781Snate@binkert.org    # was defined by the asm statement.  If the compiler does not
7814781Snate@binkert.org    # prepend an underscore, this will not successfully link because
7824781Snate@binkert.org    # '_x' will have been defined by assembly, while the C portion of
7834781Snate@binkert.org    # the code will be trying to use 'x'
7843546Sgblack@eecs.umich.edu    ret = context.TryLink('''
7853546Sgblack@eecs.umich.edu        asm(".globl _x; _x: .byte 0");
7863546Sgblack@eecs.umich.edu        extern int x;
7874781Snate@binkert.org        int main() { return x; }
7883546Sgblack@eecs.umich.edu        ''', extension=".c")
7893546Sgblack@eecs.umich.edu    context.env.Append(LEADING_UNDERSCORE=ret)
7903546Sgblack@eecs.umich.edu    context.Result(ret)
7913546Sgblack@eecs.umich.edu    return ret
7923546Sgblack@eecs.umich.edu
7933546Sgblack@eecs.umich.edu# Platform-specific configuration.  Note again that we assume that all
7943546Sgblack@eecs.umich.edu# builds under a given build root run on the same host platform.
7953546Sgblack@eecs.umich.educonf = Configure(main,
7963546Sgblack@eecs.umich.edu                 conf_dir = joinpath(build_root, '.scons_config'),
7973546Sgblack@eecs.umich.edu                 log_file = joinpath(build_root, 'scons_config.log'),
7984202Sbinkertn@umich.edu                 custom_tests = { 'CheckLeading' : CheckLeading })
7993546Sgblack@eecs.umich.edu
8003546Sgblack@eecs.umich.edu# Check for leading underscores.  Don't really need to worry either
8013546Sgblack@eecs.umich.edu# way so don't need to check the return code.
802955SN/Aconf.CheckLeading()
803955SN/A
804955SN/A# Check if we should compile a 64 bit binary on Mac OS X/Darwin
805955SN/Atry:
8061858SN/A    import platform
8071858SN/A    uname = platform.uname()
8081858SN/A    if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0:
8095863Snate@binkert.org        if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
8105863Snate@binkert.org            main.Append(CCFLAGS=['-arch', 'x86_64'])
8115343Sstever@gmail.com            main.Append(CFLAGS=['-arch', 'x86_64'])
8125343Sstever@gmail.com            main.Append(LINKFLAGS=['-arch', 'x86_64'])
8135863Snate@binkert.org            main.Append(ASFLAGS=['-arch', 'x86_64'])
8145863Snate@binkert.orgexcept:
8154773Snate@binkert.org    pass
8165863Snate@binkert.org
8172632Sstever@eecs.umich.edu# Recent versions of scons substitute a "Null" object for Configure()
8185863Snate@binkert.org# when configuration isn't necessary, e.g., if the "--help" option is
8192023SN/A# present.  Unfortuantely this Null object always returns false,
8205863Snate@binkert.org# breaking all our configuration checks.  We replace it with our own
8215863Snate@binkert.org# more optimistic null object that returns True instead.
8225863Snate@binkert.orgif not conf:
8235863Snate@binkert.org    def NullCheck(*args, **kwargs):
8245863Snate@binkert.org        return True
8255863Snate@binkert.org
8265863Snate@binkert.org    class NullConf:
8275863Snate@binkert.org        def __init__(self, env):
8285863Snate@binkert.org            self.env = env
8292632Sstever@eecs.umich.edu        def Finish(self):
8305863Snate@binkert.org            return self.env
8312023SN/A        def __getattr__(self, mname):
8322632Sstever@eecs.umich.edu            return NullCheck
8335863Snate@binkert.org
8345342Sstever@gmail.com    conf = NullConf(main)
8355863Snate@binkert.org
8362632Sstever@eecs.umich.edu# Cache build files in the supplied directory.
8375863Snate@binkert.orgif main['M5_BUILD_CACHE']:
8385863Snate@binkert.org    print 'Using build cache located at', main['M5_BUILD_CACHE']
8392632Sstever@eecs.umich.edu    CacheDir(main['M5_BUILD_CACHE'])
8405863Snate@binkert.org
8415863Snate@binkert.org# Find Python include and library directories for embedding the
8425863Snate@binkert.org# interpreter. We rely on python-config to resolve the appropriate
8435863Snate@binkert.org# includes and linker flags. ParseConfig does not seem to understand
8445863Snate@binkert.org# the more exotic linker flags such as -Xlinker and -export-dynamic so
8455863Snate@binkert.org# we add them explicitly below. If you want to link in an alternate
8462632Sstever@eecs.umich.edu# version of python, see above for instructions on how to invoke
8475863Snate@binkert.org# scons with the appropriate PATH set.
8485863Snate@binkert.orgpy_includes = readCommand(['python-config', '--includes'],
8492632Sstever@eecs.umich.edu                          exception='').split()
8501888SN/A# Strip the -I from the include folders before adding them to the
8515863Snate@binkert.org# CPPPATH
8525863Snate@binkert.orgmain.Append(CPPPATH=map(lambda inc: inc[2:], py_includes))
8535863Snate@binkert.org
8541858SN/A# Read the linker flags and split them into libraries and other link
8555863Snate@binkert.org# flags. The libraries are added later through the call the CheckLib.
8565863Snate@binkert.orgpy_ld_flags = readCommand(['python-config', '--ldflags'], exception='').split()
8575863Snate@binkert.orgpy_libs = []
8585863Snate@binkert.orgfor lib in py_ld_flags:
8592598SN/A     if not lib.startswith('-l'):
8605863Snate@binkert.org         main.Append(LINKFLAGS=[lib])
8611858SN/A     else:
8621858SN/A         lib = lib[2:]
8631858SN/A         if lib not in py_libs:
8645863Snate@binkert.org             py_libs.append(lib)
8651858SN/A
8661858SN/A# verify that this stuff works
8671858SN/Aif not conf.CheckHeader('Python.h', '<>'):
8685863Snate@binkert.org    print "Error: can't find Python.h header in", py_includes
8691871SN/A    print "Install Python headers (package python-dev on Ubuntu and RedHat)"
8701858SN/A    Exit(1)
8711858SN/A
8721858SN/Afor lib in py_libs:
8731858SN/A    if not conf.CheckLib(lib):
8741858SN/A        print "Error: can't find library %s required by python" % lib
8751858SN/A        Exit(1)
8761858SN/A
8775863Snate@binkert.org# On Solaris you need to use libsocket for socket ops
8781858SN/Aif not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
8791858SN/A   if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
8805863Snate@binkert.org       print "Can't find library with socket calls (e.g. accept())"
8811859SN/A       Exit(1)
8821859SN/A
8831869SN/A# Check for zlib.  If the check passes, libz will be automatically
8845863Snate@binkert.org# added to the LIBS environment variable.
8855863Snate@binkert.orgif not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
8861869SN/A    print 'Error: did not find needed zlib compression library '\
8871965SN/A          'and/or zlib.h header file.'
8881965SN/A    print '       Please install zlib and try again.'
8891965SN/A    Exit(1)
8902761Sstever@eecs.umich.edu
8915863Snate@binkert.org# If we have the protobuf compiler, also make sure we have the
8921869SN/A# development libraries. If the check passes, libprotobuf will be
8935863Snate@binkert.org# automatically added to the LIBS environment variable. After
8942667Sstever@eecs.umich.edu# this, we can use the HAVE_PROTOBUF flag to determine if we have
8951869SN/A# got both protoc and libprotobuf available.
8961869SN/Amain['HAVE_PROTOBUF'] = main['PROTOC'] and \
8972929Sktlim@umich.edu    conf.CheckLibWithHeader('protobuf', 'google/protobuf/message.h',
8982929Sktlim@umich.edu                            'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;')
8995863Snate@binkert.org
9002929Sktlim@umich.edu# If we have the compiler but not the library, print another warning.
901955SN/Aif main['PROTOC'] and not main['HAVE_PROTOBUF']:
9022598SN/A    print termcap.Yellow + termcap.Bold + \
903        'Warning: did not find protocol buffer library and/or headers.\n' + \
904    '       Please install libprotobuf-dev for tracing support.' + \
905    termcap.Normal
906
907# Check for librt.
908have_posix_clock = \
909    conf.CheckLibWithHeader(None, 'time.h', 'C',
910                            'clock_nanosleep(0,0,NULL,NULL);') or \
911    conf.CheckLibWithHeader('rt', 'time.h', 'C',
912                            'clock_nanosleep(0,0,NULL,NULL);')
913
914if conf.CheckLib('tcmalloc'):
915    main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS'])
916elif conf.CheckLib('tcmalloc_minimal'):
917    main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS'])
918else:
919    print termcap.Yellow + termcap.Bold + \
920          "You can get a 12% performance improvement by installing tcmalloc "\
921          "(libgoogle-perftools-dev package on Ubuntu or RedHat)." + \
922          termcap.Normal
923
924if not have_posix_clock:
925    print "Can't find library for POSIX clocks."
926
927# Check for <fenv.h> (C99 FP environment control)
928have_fenv = conf.CheckHeader('fenv.h', '<>')
929if not have_fenv:
930    print "Warning: Header file <fenv.h> not found."
931    print "         This host has no IEEE FP rounding mode control."
932
933# Check if we should enable KVM-based hardware virtualization
934have_kvm = conf.CheckHeader('linux/kvm.h', '<>')
935if not have_kvm:
936    print "Info: Header file <linux/kvm.h> not found, " \
937        "disabling KVM support."
938
939# Check if the requested target ISA is compatible with the host
940def is_isa_kvm_compatible(isa):
941    isa_comp_table = {
942        "arm" : ( "armv7l" ),
943        }
944    try:
945        import platform
946        host_isa = platform.machine()
947    except:
948        print "Warning: Failed to determine host ISA."
949        return False
950
951    return host_isa in isa_comp_table.get(isa, [])
952
953
954######################################################################
955#
956# Finish the configuration
957#
958main = conf.Finish()
959
960######################################################################
961#
962# Collect all non-global variables
963#
964
965# Define the universe of supported ISAs
966all_isa_list = [ ]
967Export('all_isa_list')
968
969class CpuModel(object):
970    '''The CpuModel class encapsulates everything the ISA parser needs to
971    know about a particular CPU model.'''
972
973    # Dict of available CPU model objects.  Accessible as CpuModel.dict.
974    dict = {}
975    list = []
976    defaults = []
977
978    # Constructor.  Automatically adds models to CpuModel.dict.
979    def __init__(self, name, filename, includes, strings, default=False):
980        self.name = name           # name of model
981        self.filename = filename   # filename for output exec code
982        self.includes = includes   # include files needed in exec file
983        # The 'strings' dict holds all the per-CPU symbols we can
984        # substitute into templates etc.
985        self.strings = strings
986
987        # This cpu is enabled by default
988        self.default = default
989
990        # Add self to dict
991        if name in CpuModel.dict:
992            raise AttributeError, "CpuModel '%s' already registered" % name
993        CpuModel.dict[name] = self
994        CpuModel.list.append(name)
995
996Export('CpuModel')
997
998# Sticky variables get saved in the variables file so they persist from
999# one invocation to the next (unless overridden, in which case the new
1000# value becomes sticky).
1001sticky_vars = Variables(args=ARGUMENTS)
1002Export('sticky_vars')
1003
1004# Sticky variables that should be exported
1005export_vars = []
1006Export('export_vars')
1007
1008# For Ruby
1009all_protocols = []
1010Export('all_protocols')
1011protocol_dirs = []
1012Export('protocol_dirs')
1013slicc_includes = []
1014Export('slicc_includes')
1015
1016# Walk the tree and execute all SConsopts scripts that wil add to the
1017# above variables
1018if not GetOption('verbose'):
1019    print "Reading SConsopts"
1020for bdir in [ base_dir ] + extras_dir_list:
1021    if not isdir(bdir):
1022        print "Error: directory '%s' does not exist" % bdir
1023        Exit(1)
1024    for root, dirs, files in os.walk(bdir):
1025        if 'SConsopts' in files:
1026            if GetOption('verbose'):
1027                print "Reading", joinpath(root, 'SConsopts')
1028            SConscript(joinpath(root, 'SConsopts'))
1029
1030all_isa_list.sort()
1031
1032sticky_vars.AddVariables(
1033    EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list),
1034    ListVariable('CPU_MODELS', 'CPU models',
1035                 sorted(n for n,m in CpuModel.dict.iteritems() if m.default),
1036                 sorted(CpuModel.list)),
1037    BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
1038                 False),
1039    BoolVariable('SS_COMPATIBLE_FP',
1040                 'Make floating-point results compatible with SimpleScalar',
1041                 False),
1042    BoolVariable('USE_SSE2',
1043                 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
1044                 False),
1045    BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock),
1046    BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
1047    BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False),
1048    BoolVariable('USE_KVM', 'Enable hardware virtualized (KVM) CPU models', have_kvm),
1049    EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None',
1050                  all_protocols),
1051    )
1052
1053# These variables get exported to #defines in config/*.hh (see src/SConscript).
1054export_vars += ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'CP_ANNOTATE',
1055                'USE_POSIX_CLOCK', 'PROTOCOL', 'HAVE_PROTOBUF']
1056
1057###################################################
1058#
1059# Define a SCons builder for configuration flag headers.
1060#
1061###################################################
1062
1063# This function generates a config header file that #defines the
1064# variable symbol to the current variable setting (0 or 1).  The source
1065# operands are the name of the variable and a Value node containing the
1066# value of the variable.
1067def build_config_file(target, source, env):
1068    (variable, value) = [s.get_contents() for s in source]
1069    f = file(str(target[0]), 'w')
1070    print >> f, '#define', variable, value
1071    f.close()
1072    return None
1073
1074# Combine the two functions into a scons Action object.
1075config_action = MakeAction(build_config_file, Transform("CONFIG H", 2))
1076
1077# The emitter munges the source & target node lists to reflect what
1078# we're really doing.
1079def config_emitter(target, source, env):
1080    # extract variable name from Builder arg
1081    variable = str(target[0])
1082    # True target is config header file
1083    target = joinpath('config', variable.lower() + '.hh')
1084    val = env[variable]
1085    if isinstance(val, bool):
1086        # Force value to 0/1
1087        val = int(val)
1088    elif isinstance(val, str):
1089        val = '"' + val + '"'
1090
1091    # Sources are variable name & value (packaged in SCons Value nodes)
1092    return ([target], [Value(variable), Value(val)])
1093
1094config_builder = Builder(emitter = config_emitter, action = config_action)
1095
1096main.Append(BUILDERS = { 'ConfigFile' : config_builder })
1097
1098# libelf build is shared across all configs in the build root.
1099main.SConscript('ext/libelf/SConscript',
1100                variant_dir = joinpath(build_root, 'libelf'))
1101
1102# gzstream build is shared across all configs in the build root.
1103main.SConscript('ext/gzstream/SConscript',
1104                variant_dir = joinpath(build_root, 'gzstream'))
1105
1106# libfdt build is shared across all configs in the build root.
1107main.SConscript('ext/libfdt/SConscript',
1108                variant_dir = joinpath(build_root, 'libfdt'))
1109
1110###################################################
1111#
1112# This function is used to set up a directory with switching headers
1113#
1114###################################################
1115
1116main['ALL_ISA_LIST'] = all_isa_list
1117def make_switching_dir(dname, switch_headers, env):
1118    # Generate the header.  target[0] is the full path of the output
1119    # header to generate.  'source' is a dummy variable, since we get the
1120    # list of ISAs from env['ALL_ISA_LIST'].
1121    def gen_switch_hdr(target, source, env):
1122        fname = str(target[0])
1123        f = open(fname, 'w')
1124        isa = env['TARGET_ISA'].lower()
1125        print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname))
1126        f.close()
1127
1128    # Build SCons Action object. 'varlist' specifies env vars that this
1129    # action depends on; when env['ALL_ISA_LIST'] changes these actions
1130    # should get re-executed.
1131    switch_hdr_action = MakeAction(gen_switch_hdr,
1132                          Transform("GENERATE"), varlist=['ALL_ISA_LIST'])
1133
1134    # Instantiate actions for each header
1135    for hdr in switch_headers:
1136        env.Command(hdr, [], switch_hdr_action)
1137Export('make_switching_dir')
1138
1139###################################################
1140#
1141# Define build environments for selected configurations.
1142#
1143###################################################
1144
1145for variant_path in variant_paths:
1146    print "Building in", variant_path
1147
1148    # Make a copy of the build-root environment to use for this config.
1149    env = main.Clone()
1150    env['BUILDDIR'] = variant_path
1151
1152    # variant_dir is the tail component of build path, and is used to
1153    # determine the build parameters (e.g., 'ALPHA_SE')
1154    (build_root, variant_dir) = splitpath(variant_path)
1155
1156    # Set env variables according to the build directory config.
1157    sticky_vars.files = []
1158    # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
1159    # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
1160    # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
1161    current_vars_file = joinpath(build_root, 'variables', variant_dir)
1162    if isfile(current_vars_file):
1163        sticky_vars.files.append(current_vars_file)
1164        print "Using saved variables file %s" % current_vars_file
1165    else:
1166        # Build dir-specific variables file doesn't exist.
1167
1168        # Make sure the directory is there so we can create it later
1169        opt_dir = dirname(current_vars_file)
1170        if not isdir(opt_dir):
1171            mkdir(opt_dir)
1172
1173        # Get default build variables from source tree.  Variables are
1174        # normally determined by name of $VARIANT_DIR, but can be
1175        # overridden by '--default=' arg on command line.
1176        default = GetOption('default')
1177        opts_dir = joinpath(main.root.abspath, 'build_opts')
1178        if default:
1179            default_vars_files = [joinpath(build_root, 'variables', default),
1180                                  joinpath(opts_dir, default)]
1181        else:
1182            default_vars_files = [joinpath(opts_dir, variant_dir)]
1183        existing_files = filter(isfile, default_vars_files)
1184        if existing_files:
1185            default_vars_file = existing_files[0]
1186            sticky_vars.files.append(default_vars_file)
1187            print "Variables file %s not found,\n  using defaults in %s" \
1188                  % (current_vars_file, default_vars_file)
1189        else:
1190            print "Error: cannot find variables file %s or " \
1191                  "default file(s) %s" \
1192                  % (current_vars_file, ' or '.join(default_vars_files))
1193            Exit(1)
1194
1195    # Apply current variable settings to env
1196    sticky_vars.Update(env)
1197
1198    help_texts["local_vars"] += \
1199        "Build variables for %s:\n" % variant_dir \
1200                 + sticky_vars.GenerateHelpText(env)
1201
1202    # Process variable settings.
1203
1204    if not have_fenv and env['USE_FENV']:
1205        print "Warning: <fenv.h> not available; " \
1206              "forcing USE_FENV to False in", variant_dir + "."
1207        env['USE_FENV'] = False
1208
1209    if not env['USE_FENV']:
1210        print "Warning: No IEEE FP rounding mode control in", variant_dir + "."
1211        print "         FP results may deviate slightly from other platforms."
1212
1213    if env['EFENCE']:
1214        env.Append(LIBS=['efence'])
1215
1216    if env['USE_KVM']:
1217        if not have_kvm:
1218            print "Warning: Can not enable KVM, host seems to lack KVM support"
1219            env['USE_KVM'] = False
1220        elif not is_isa_kvm_compatible(env['TARGET_ISA']):
1221            print "Info: KVM support disabled due to unsupported host and " \
1222                "target ISA combination"
1223            env['USE_KVM'] = False
1224
1225    # Save sticky variable settings back to current variables file
1226    sticky_vars.Save(current_vars_file, env)
1227
1228    if env['USE_SSE2']:
1229        env.Append(CCFLAGS=['-msse2'])
1230
1231    # The src/SConscript file sets up the build rules in 'env' according
1232    # to the configured variables.  It returns a list of environments,
1233    # one for each variant build (debug, opt, etc.)
1234    envList = SConscript('src/SConscript', variant_dir = variant_path,
1235                         exports = 'env')
1236
1237    # Set up the regression tests for each build.
1238    for e in envList:
1239        SConscript('tests/SConscript',
1240                   variant_dir = joinpath(variant_path, 'tests', e.Label),
1241                   exports = { 'env' : e }, duplicate = False)
1242
1243# base help text
1244Help('''
1245Usage: scons [scons options] [build variables] [target(s)]
1246
1247Extra scons options:
1248%(options)s
1249
1250Global build variables:
1251%(global_vars)s
1252
1253%(local_vars)s
1254''' % help_texts)
1255