SConstruct revision 10066
1955SN/A# -*- mode:python -*-
2955SN/A
39812Sandreas.hansson@arm.com# Copyright (c) 2013 ARM Limited
49812Sandreas.hansson@arm.com# All rights reserved.
59812Sandreas.hansson@arm.com#
69812Sandreas.hansson@arm.com# The license below extends only to copyright in the software and shall
79812Sandreas.hansson@arm.com# not be construed as granting a license to any other intellectual
89812Sandreas.hansson@arm.com# property including but not limited to intellectual property relating
99812Sandreas.hansson@arm.com# to a hardware implementation of the functionality of the software
109812Sandreas.hansson@arm.com# licensed hereunder.  You may use the software subject to the license
119812Sandreas.hansson@arm.com# terms below provided that you ensure that this notice is replicated
129812Sandreas.hansson@arm.com# unmodified and in its entirety in all distributions of the software,
139812Sandreas.hansson@arm.com# modified or unmodified, in source code or in binary form.
149812Sandreas.hansson@arm.com#
157816Ssteve.reinhardt@amd.com# Copyright (c) 2011 Advanced Micro Devices, Inc.
165871Snate@binkert.org# Copyright (c) 2009 The Hewlett-Packard Development Company
171762SN/A# Copyright (c) 2004-2005 The Regents of The University of Michigan
18955SN/A# All rights reserved.
19955SN/A#
20955SN/A# Redistribution and use in source and binary forms, with or without
21955SN/A# modification, are permitted provided that the following conditions are
22955SN/A# met: redistributions of source code must retain the above copyright
23955SN/A# notice, this list of conditions and the following disclaimer;
24955SN/A# redistributions in binary form must reproduce the above copyright
25955SN/A# notice, this list of conditions and the following disclaimer in the
26955SN/A# documentation and/or other materials provided with the distribution;
27955SN/A# neither the name of the copyright holders nor the names of its
28955SN/A# contributors may be used to endorse or promote products derived from
29955SN/A# this software without specific prior written permission.
30955SN/A#
31955SN/A# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32955SN/A# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33955SN/A# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
34955SN/A# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35955SN/A# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36955SN/A# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
37955SN/A# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
38955SN/A# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
39955SN/A# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
40955SN/A# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
41955SN/A# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
422665Ssaidi@eecs.umich.edu#
432665Ssaidi@eecs.umich.edu# Authors: Steve Reinhardt
445863Snate@binkert.org#          Nathan Binkert
45955SN/A
46955SN/A###################################################
47955SN/A#
48955SN/A# SCons top-level build description (SConstruct) file.
49955SN/A#
508878Ssteve.reinhardt@amd.com# While in this directory ('gem5'), just type 'scons' to build the default
512632Sstever@eecs.umich.edu# configuration (see below), or type 'scons build/<CONFIG>/<binary>'
528878Ssteve.reinhardt@amd.com# to build some other configuration (e.g., 'build/ALPHA/gem5.opt' for
532632Sstever@eecs.umich.edu# the optimized full-system version).
54955SN/A#
558878Ssteve.reinhardt@amd.com# You can build gem5 in a different directory as long as there is a
562632Sstever@eecs.umich.edu# 'build/<CONFIG>' somewhere along the target path.  The build system
572761Sstever@eecs.umich.edu# expects that all configs under the same build directory are being
582632Sstever@eecs.umich.edu# built for the same host system.
592632Sstever@eecs.umich.edu#
602632Sstever@eecs.umich.edu# Examples:
612761Sstever@eecs.umich.edu#
622761Sstever@eecs.umich.edu#   The following two commands are equivalent.  The '-u' option tells
632761Sstever@eecs.umich.edu#   scons to search up the directory tree for this SConstruct file.
648878Ssteve.reinhardt@amd.com#   % cd <path-to-src>/gem5 ; scons build/ALPHA/gem5.debug
658878Ssteve.reinhardt@amd.com#   % cd <path-to-src>/gem5/build/ALPHA; scons -u gem5.debug
662761Sstever@eecs.umich.edu#
672761Sstever@eecs.umich.edu#   The following two commands are equivalent and demonstrate building
682761Sstever@eecs.umich.edu#   in a directory outside of the source tree.  The '-C' option tells
692761Sstever@eecs.umich.edu#   scons to chdir to the specified directory to find this SConstruct
702761Sstever@eecs.umich.edu#   file.
718878Ssteve.reinhardt@amd.com#   % cd <path-to-src>/gem5 ; scons /local/foo/build/ALPHA/gem5.debug
728878Ssteve.reinhardt@amd.com#   % cd /local/foo/build/ALPHA; scons -C <path-to-src>/gem5 gem5.debug
732632Sstever@eecs.umich.edu#
742632Sstever@eecs.umich.edu# You can use 'scons -H' to print scons options.  If you're in this
758878Ssteve.reinhardt@amd.com# 'gem5' directory (or use -u or -C to tell scons where to find this
768878Ssteve.reinhardt@amd.com# file), you can use 'scons -h' to print all the gem5-specific build
772632Sstever@eecs.umich.edu# options as well.
78955SN/A#
79955SN/A###################################################
80955SN/A
815863Snate@binkert.org# Check for recent-enough Python and SCons versions.
825863Snate@binkert.orgtry:
835863Snate@binkert.org    # Really old versions of scons only take two options for the
845863Snate@binkert.org    # function, so check once without the revision and once with the
855863Snate@binkert.org    # revision, the first instance will fail for stuff other than
865863Snate@binkert.org    # 0.98, and the second will fail for 0.98.0
875863Snate@binkert.org    EnsureSConsVersion(0, 98)
885863Snate@binkert.org    EnsureSConsVersion(0, 98, 1)
895863Snate@binkert.orgexcept SystemExit, e:
905863Snate@binkert.org    print """
915863Snate@binkert.orgFor more details, see:
928878Ssteve.reinhardt@amd.com    http://gem5.org/Dependencies
935863Snate@binkert.org"""
945863Snate@binkert.org    raise
955863Snate@binkert.org
969812Sandreas.hansson@arm.com# We ensure the python version early because because python-config
979812Sandreas.hansson@arm.com# requires python 2.5
985863Snate@binkert.orgtry:
999812Sandreas.hansson@arm.com    EnsurePythonVersion(2, 5)
1005863Snate@binkert.orgexcept SystemExit, e:
1015863Snate@binkert.org    print """
1025863Snate@binkert.orgYou can use a non-default installation of the Python interpreter by
1039812Sandreas.hansson@arm.comrearranging your PATH so that scons finds the non-default 'python' and
1049812Sandreas.hansson@arm.com'python-config' first.
1055863Snate@binkert.org
1065863Snate@binkert.orgFor more details, see:
1078878Ssteve.reinhardt@amd.com    http://gem5.org/wiki/index.php/Using_a_non-default_Python_installation
1085863Snate@binkert.org"""
1095863Snate@binkert.org    raise
1105863Snate@binkert.org
1116654Snate@binkert.org# Global Python includes
112955SN/Aimport os
1135396Ssaidi@eecs.umich.eduimport re
1145863Snate@binkert.orgimport subprocess
1155863Snate@binkert.orgimport sys
1164202Sbinkertn@umich.edu
1175863Snate@binkert.orgfrom os import mkdir, environ
1185863Snate@binkert.orgfrom os.path import abspath, basename, dirname, expanduser, normpath
1195863Snate@binkert.orgfrom os.path import exists,  isdir, isfile
1205863Snate@binkert.orgfrom os.path import join as joinpath, split as splitpath
121955SN/A
1226654Snate@binkert.org# SCons includes
1235273Sstever@gmail.comimport SCons
1245871Snate@binkert.orgimport SCons.Node
1255273Sstever@gmail.com
1266655Snate@binkert.orgextra_python_paths = [
1278878Ssteve.reinhardt@amd.com    Dir('src/python').srcnode().abspath, # gem5 includes
1286655Snate@binkert.org    Dir('ext/ply').srcnode().abspath, # ply is used by several files
1296655Snate@binkert.org    ]
1309219Spower.jg@gmail.com
1316655Snate@binkert.orgsys.path[1:1] = extra_python_paths
1325871Snate@binkert.org
1336654Snate@binkert.orgfrom m5.util import compareVersions, readCommand
1348947Sandreas.hansson@arm.comfrom m5.util.terminal import get_termcap
1355396Ssaidi@eecs.umich.edu
1368120Sgblack@eecs.umich.eduhelp_texts = {
1378120Sgblack@eecs.umich.edu    "options" : "",
1388120Sgblack@eecs.umich.edu    "global_vars" : "",
1398120Sgblack@eecs.umich.edu    "local_vars" : ""
1408120Sgblack@eecs.umich.edu}
1418120Sgblack@eecs.umich.edu
1428120Sgblack@eecs.umich.eduExport("help_texts")
1438120Sgblack@eecs.umich.edu
1448879Ssteve.reinhardt@amd.com
1458879Ssteve.reinhardt@amd.com# There's a bug in scons in that (1) by default, the help texts from
1468879Ssteve.reinhardt@amd.com# AddOption() are supposed to be displayed when you type 'scons -h'
1478879Ssteve.reinhardt@amd.com# and (2) you can override the help displayed by 'scons -h' using the
1488879Ssteve.reinhardt@amd.com# Help() function, but these two features are incompatible: once
1498879Ssteve.reinhardt@amd.com# you've overridden the help text using Help(), there's no way to get
1508879Ssteve.reinhardt@amd.com# at the help texts from AddOptions.  See:
1518879Ssteve.reinhardt@amd.com#     http://scons.tigris.org/issues/show_bug.cgi?id=2356
1528879Ssteve.reinhardt@amd.com#     http://scons.tigris.org/issues/show_bug.cgi?id=2611
1538879Ssteve.reinhardt@amd.com# This hack lets us extract the help text from AddOptions and
1548879Ssteve.reinhardt@amd.com# re-inject it via Help().  Ideally someday this bug will be fixed and
1558879Ssteve.reinhardt@amd.com# we can just use AddOption directly.
1568879Ssteve.reinhardt@amd.comdef AddLocalOption(*args, **kwargs):
1578120Sgblack@eecs.umich.edu    col_width = 30
1588120Sgblack@eecs.umich.edu
1598120Sgblack@eecs.umich.edu    help = "  " + ", ".join(args)
1608120Sgblack@eecs.umich.edu    if "help" in kwargs:
1618120Sgblack@eecs.umich.edu        length = len(help)
1628120Sgblack@eecs.umich.edu        if length >= col_width:
1638120Sgblack@eecs.umich.edu            help += "\n" + " " * col_width
1648120Sgblack@eecs.umich.edu        else:
1658120Sgblack@eecs.umich.edu            help += " " * (col_width - length)
1668120Sgblack@eecs.umich.edu        help += kwargs["help"]
1678120Sgblack@eecs.umich.edu    help_texts["options"] += help + "\n"
1688120Sgblack@eecs.umich.edu
1698120Sgblack@eecs.umich.edu    AddOption(*args, **kwargs)
1708120Sgblack@eecs.umich.edu
1718879Ssteve.reinhardt@amd.comAddLocalOption('--colors', dest='use_colors', action='store_true',
1728879Ssteve.reinhardt@amd.com               help="Add color to abbreviated scons output")
1738879Ssteve.reinhardt@amd.comAddLocalOption('--no-colors', dest='use_colors', action='store_false',
1748879Ssteve.reinhardt@amd.com               help="Don't add color to abbreviated scons output")
1758879Ssteve.reinhardt@amd.comAddLocalOption('--default', dest='default', type='string', action='store',
1768879Ssteve.reinhardt@amd.com               help='Override which build_opts file to use for defaults')
1778879Ssteve.reinhardt@amd.comAddLocalOption('--ignore-style', dest='ignore_style', action='store_true',
1788879Ssteve.reinhardt@amd.com               help='Disable style checking hooks')
1799227Sandreas.hansson@arm.comAddLocalOption('--no-lto', dest='no_lto', action='store_true',
1809227Sandreas.hansson@arm.com               help='Disable Link-Time Optimization for fast')
1818879Ssteve.reinhardt@amd.comAddLocalOption('--update-ref', dest='update_ref', action='store_true',
1828879Ssteve.reinhardt@amd.com               help='Update test reference outputs')
1838879Ssteve.reinhardt@amd.comAddLocalOption('--verbose', dest='verbose', action='store_true',
1848879Ssteve.reinhardt@amd.com               help='Print full tool command lines')
1858120Sgblack@eecs.umich.edu
1868947Sandreas.hansson@arm.comtermcap = get_termcap(GetOption('use_colors'))
1877816Ssteve.reinhardt@amd.com
1885871Snate@binkert.org########################################################################
1895871Snate@binkert.org#
1906121Snate@binkert.org# Set up the main build environment.
1915871Snate@binkert.org#
1925871Snate@binkert.org########################################################################
1939926Sstan.czerniawski@arm.com
1949926Sstan.czerniawski@arm.com# export TERM so that clang reports errors in color
1959119Sandreas.hansson@arm.comuse_vars = set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH',
1969396Sandreas.hansson@arm.com                 'LIBRARY_PATH', 'PATH', 'PKG_CONFIG_PATH', 'PYTHONPATH',
1979926Sstan.czerniawski@arm.com                 'RANLIB', 'SWIG', 'TERM' ])
198955SN/A
1999416SAndreas.Sandberg@ARM.comuse_prefixes = [
2009416SAndreas.Sandberg@ARM.com    "M5",           # M5 configuration (e.g., path to kernels)
2019416SAndreas.Sandberg@ARM.com    "DISTCC_",      # distcc (distributed compiler wrapper) configuration
2029416SAndreas.Sandberg@ARM.com    "CCACHE_",      # ccache (caching compiler wrapper) configuration
2039416SAndreas.Sandberg@ARM.com    "CCC_",         # clang static analyzer configuration
2049416SAndreas.Sandberg@ARM.com    ]
2059416SAndreas.Sandberg@ARM.com
2065871Snate@binkert.orguse_env = {}
2075871Snate@binkert.orgfor key,val in os.environ.iteritems():
2089416SAndreas.Sandberg@ARM.com    if key in use_vars or \
2099416SAndreas.Sandberg@ARM.com            any([key.startswith(prefix) for prefix in use_prefixes]):
2105871Snate@binkert.org        use_env[key] = val
211955SN/A
2126121Snate@binkert.orgmain = Environment(ENV=use_env)
2138881Smarc.orr@gmail.commain.Decider('MD5-timestamp')
2146121Snate@binkert.orgmain.root = Dir(".")         # The current directory (where this file lives).
2156121Snate@binkert.orgmain.srcdir = Dir("src")     # The source directory
2161533SN/A
2179239Sandreas.hansson@arm.commain_dict_keys = main.Dictionary().keys()
2189239Sandreas.hansson@arm.com
2199239Sandreas.hansson@arm.com# Check that we have a C/C++ compiler
2209239Sandreas.hansson@arm.comif not ('CC' in main_dict_keys and 'CXX' in main_dict_keys):
2219239Sandreas.hansson@arm.com    print "No C++ compiler installed (package g++ on Ubuntu and RedHat)"
2229239Sandreas.hansson@arm.com    Exit(1)
2239239Sandreas.hansson@arm.com
2249239Sandreas.hansson@arm.com# Check that swig is present
2259239Sandreas.hansson@arm.comif not 'SWIG' in main_dict_keys:
2269239Sandreas.hansson@arm.com    print "swig is not installed (package swig on Ubuntu and RedHat)"
2279239Sandreas.hansson@arm.com    Exit(1)
2289239Sandreas.hansson@arm.com
2296655Snate@binkert.org# add useful python code PYTHONPATH so it can be used by subprocesses
2306655Snate@binkert.org# as well
2316655Snate@binkert.orgmain.AppendENVPath('PYTHONPATH', extra_python_paths)
2326655Snate@binkert.org
2335871Snate@binkert.org########################################################################
2345871Snate@binkert.org#
2355863Snate@binkert.org# Mercurial Stuff.
2365871Snate@binkert.org#
2378878Ssteve.reinhardt@amd.com# If the gem5 directory is a mercurial repository, we should do some
2385871Snate@binkert.org# extra things.
2395871Snate@binkert.org#
2405871Snate@binkert.org########################################################################
2415863Snate@binkert.org
2426121Snate@binkert.orghgdir = main.root.Dir(".hg")
2435863Snate@binkert.org
2445871Snate@binkert.orgmercurial_style_message = """
2458336Ssteve.reinhardt@amd.comYou're missing the gem5 style hook, which automatically checks your code
2468336Ssteve.reinhardt@amd.comagainst the gem5 style rules on hg commit and qrefresh commands.  This
2478336Ssteve.reinhardt@amd.comscript will now install the hook in your .hg/hgrc file.
2488336Ssteve.reinhardt@amd.comPress enter to continue, or ctrl-c to abort: """
2494678Snate@binkert.org
2508336Ssteve.reinhardt@amd.commercurial_style_hook = """
2518336Ssteve.reinhardt@amd.com# The following lines were automatically added by gem5/SConstruct
2528336Ssteve.reinhardt@amd.com# to provide the gem5 style-checking hooks
2534678Snate@binkert.org[extensions]
2544678Snate@binkert.orgstyle = %s/util/style.py
2554678Snate@binkert.org
2564678Snate@binkert.org[hooks]
2577827Snate@binkert.orgpretxncommit.style = python:style.check_style
2587827Snate@binkert.orgpre-qrefresh.style = python:style.check_style
2598336Ssteve.reinhardt@amd.com# End of SConstruct additions
2604678Snate@binkert.org
2618336Ssteve.reinhardt@amd.com""" % (main.root.abspath)
2628336Ssteve.reinhardt@amd.com
2638336Ssteve.reinhardt@amd.commercurial_lib_not_found = """
2648336Ssteve.reinhardt@amd.comMercurial libraries cannot be found, ignoring style hook.  If
2658336Ssteve.reinhardt@amd.comyou are a gem5 developer, please fix this and run the style
2668336Ssteve.reinhardt@amd.comhook. It is important.
2675871Snate@binkert.org"""
2685871Snate@binkert.org
2698336Ssteve.reinhardt@amd.com# Check for style hook and prompt for installation if it's not there.
2708336Ssteve.reinhardt@amd.com# Skip this if --ignore-style was specified, there's no .hg dir to
2718336Ssteve.reinhardt@amd.com# install a hook in, or there's no interactive terminal to prompt.
2728336Ssteve.reinhardt@amd.comif not GetOption('ignore_style') and hgdir.exists() and sys.stdin.isatty():
2738336Ssteve.reinhardt@amd.com    style_hook = True
2745871Snate@binkert.org    try:
2758336Ssteve.reinhardt@amd.com        from mercurial import ui
2768336Ssteve.reinhardt@amd.com        ui = ui.ui()
2778336Ssteve.reinhardt@amd.com        ui.readconfig(hgdir.File('hgrc').abspath)
2788336Ssteve.reinhardt@amd.com        style_hook = ui.config('hooks', 'pretxncommit.style', None) and \
2798336Ssteve.reinhardt@amd.com                     ui.config('hooks', 'pre-qrefresh.style', None)
2804678Snate@binkert.org    except ImportError:
2815871Snate@binkert.org        print mercurial_lib_not_found
2824678Snate@binkert.org
2838336Ssteve.reinhardt@amd.com    if not style_hook:
2848336Ssteve.reinhardt@amd.com        print mercurial_style_message,
2858336Ssteve.reinhardt@amd.com        # continue unless user does ctrl-c/ctrl-d etc.
2868336Ssteve.reinhardt@amd.com        try:
2878336Ssteve.reinhardt@amd.com            raw_input()
2888336Ssteve.reinhardt@amd.com        except:
2898336Ssteve.reinhardt@amd.com            print "Input exception, exiting scons.\n"
2908336Ssteve.reinhardt@amd.com            sys.exit(1)
2918336Ssteve.reinhardt@amd.com        hgrc_path = '%s/.hg/hgrc' % main.root.abspath
2928336Ssteve.reinhardt@amd.com        print "Adding style hook to", hgrc_path, "\n"
2938336Ssteve.reinhardt@amd.com        try:
2948336Ssteve.reinhardt@amd.com            hgrc = open(hgrc_path, 'a')
2958336Ssteve.reinhardt@amd.com            hgrc.write(mercurial_style_hook)
2968336Ssteve.reinhardt@amd.com            hgrc.close()
2978336Ssteve.reinhardt@amd.com        except:
2988336Ssteve.reinhardt@amd.com            print "Error updating", hgrc_path
2998336Ssteve.reinhardt@amd.com            sys.exit(1)
3005871Snate@binkert.org
3016121Snate@binkert.org
302955SN/A###################################################
303955SN/A#
3042632Sstever@eecs.umich.edu# Figure out which configurations to set up based on the path(s) of
3052632Sstever@eecs.umich.edu# the target(s).
306955SN/A#
307955SN/A###################################################
308955SN/A
309955SN/A# Find default configuration & binary.
3108878Ssteve.reinhardt@amd.comDefault(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug'))
311955SN/A
3122632Sstever@eecs.umich.edu# helper function: find last occurrence of element in list
3132632Sstever@eecs.umich.edudef rfind(l, elt, offs = -1):
3142632Sstever@eecs.umich.edu    for i in range(len(l)+offs, 0, -1):
3152632Sstever@eecs.umich.edu        if l[i] == elt:
3162632Sstever@eecs.umich.edu            return i
3172632Sstever@eecs.umich.edu    raise ValueError, "element not found"
3182632Sstever@eecs.umich.edu
3198268Ssteve.reinhardt@amd.com# Take a list of paths (or SCons Nodes) and return a list with all
3208268Ssteve.reinhardt@amd.com# paths made absolute and ~-expanded.  Paths will be interpreted
3218268Ssteve.reinhardt@amd.com# relative to the launch directory unless a different root is provided
3228268Ssteve.reinhardt@amd.comdef makePathListAbsolute(path_list, root=GetLaunchDir()):
3238268Ssteve.reinhardt@amd.com    return [abspath(joinpath(root, expanduser(str(p))))
3248268Ssteve.reinhardt@amd.com            for p in path_list]
3258268Ssteve.reinhardt@amd.com
3262632Sstever@eecs.umich.edu# Each target must have 'build' in the interior of the path; the
3272632Sstever@eecs.umich.edu# directory below this will determine the build parameters.  For
3282632Sstever@eecs.umich.edu# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
3292632Sstever@eecs.umich.edu# recognize that ALPHA_SE specifies the configuration because it
3308268Ssteve.reinhardt@amd.com# follow 'build' in the build path.
3312632Sstever@eecs.umich.edu
3328268Ssteve.reinhardt@amd.com# The funky assignment to "[:]" is needed to replace the list contents
3338268Ssteve.reinhardt@amd.com# in place rather than reassign the symbol to a new list, which
3348268Ssteve.reinhardt@amd.com# doesn't work (obviously!).
3358268Ssteve.reinhardt@amd.comBUILD_TARGETS[:] = makePathListAbsolute(BUILD_TARGETS)
3363718Sstever@eecs.umich.edu
3372634Sstever@eecs.umich.edu# Generate a list of the unique build roots and configs that the
3382634Sstever@eecs.umich.edu# collected targets reference.
3395863Snate@binkert.orgvariant_paths = []
3402638Sstever@eecs.umich.edubuild_root = None
3418268Ssteve.reinhardt@amd.comfor t in BUILD_TARGETS:
3422632Sstever@eecs.umich.edu    path_dirs = t.split('/')
3432632Sstever@eecs.umich.edu    try:
3442632Sstever@eecs.umich.edu        build_top = rfind(path_dirs, 'build', -2)
3452632Sstever@eecs.umich.edu    except:
3462632Sstever@eecs.umich.edu        print "Error: no non-leaf 'build' dir found on target path", t
3471858SN/A        Exit(1)
3483716Sstever@eecs.umich.edu    this_build_root = joinpath('/',*path_dirs[:build_top+1])
3492638Sstever@eecs.umich.edu    if not build_root:
3502638Sstever@eecs.umich.edu        build_root = this_build_root
3512638Sstever@eecs.umich.edu    else:
3522638Sstever@eecs.umich.edu        if this_build_root != build_root:
3532638Sstever@eecs.umich.edu            print "Error: build targets not under same build root\n"\
3542638Sstever@eecs.umich.edu                  "  %s\n  %s" % (build_root, this_build_root)
3552638Sstever@eecs.umich.edu            Exit(1)
3565863Snate@binkert.org    variant_path = joinpath('/',*path_dirs[:build_top+2])
3575863Snate@binkert.org    if variant_path not in variant_paths:
3585863Snate@binkert.org        variant_paths.append(variant_path)
359955SN/A
3605341Sstever@gmail.com# Make sure build_root exists (might not if this is the first build there)
3615341Sstever@gmail.comif not isdir(build_root):
3625863Snate@binkert.org    mkdir(build_root)
3637756SAli.Saidi@ARM.commain['BUILDROOT'] = build_root
3645341Sstever@gmail.com
3656121Snate@binkert.orgExport('main')
3664494Ssaidi@eecs.umich.edu
3676121Snate@binkert.orgmain.SConsignFile(joinpath(build_root, "sconsign"))
3681105SN/A
3692667Sstever@eecs.umich.edu# Default duplicate option is to use hard links, but this messes up
3702667Sstever@eecs.umich.edu# when you use emacs to edit a file in the target dir, as emacs moves
3712667Sstever@eecs.umich.edu# file to file~ then copies to file, breaking the link.  Symbolic
3722667Sstever@eecs.umich.edu# (soft) links work better.
3736121Snate@binkert.orgmain.SetOption('duplicate', 'soft-copy')
3742667Sstever@eecs.umich.edu
3755341Sstever@gmail.com#
3765863Snate@binkert.org# Set up global sticky variables... these are common to an entire build
3775341Sstever@gmail.com# tree (not specific to a particular build like ALPHA_SE)
3785341Sstever@gmail.com#
3795341Sstever@gmail.com
3808120Sgblack@eecs.umich.eduglobal_vars_file = joinpath(build_root, 'variables.global')
3815341Sstever@gmail.com
3828120Sgblack@eecs.umich.eduglobal_vars = Variables(global_vars_file, args=ARGUMENTS)
3835341Sstever@gmail.com
3848120Sgblack@eecs.umich.eduglobal_vars.AddVariables(
3856121Snate@binkert.org    ('CC', 'C compiler', environ.get('CC', main['CC'])),
3866121Snate@binkert.org    ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])),
3878980Ssteve.reinhardt@amd.com    ('SWIG', 'SWIG tool', environ.get('SWIG', main['SWIG'])),
3889396Sandreas.hansson@arm.com    ('PROTOC', 'protoc tool', environ.get('PROTOC', 'protoc')),
3895397Ssaidi@eecs.umich.edu    ('BATCH', 'Use batch pool for build and tests', False),
3905397Ssaidi@eecs.umich.edu    ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
3917727SAli.Saidi@ARM.com    ('M5_BUILD_CACHE', 'Cache built objects in this directory', False),
3928268Ssteve.reinhardt@amd.com    ('EXTRAS', 'Add extra directories to the compilation', '')
3936168Snate@binkert.org    )
3945341Sstever@gmail.com
3958120Sgblack@eecs.umich.edu# Update main environment with values from ARGUMENTS & global_vars_file
3968120Sgblack@eecs.umich.eduglobal_vars.Update(main)
3978120Sgblack@eecs.umich.eduhelp_texts["global_vars"] += global_vars.GenerateHelpText(main)
3986814Sgblack@eecs.umich.edu
3995863Snate@binkert.org# Save sticky variable settings back to current variables file
4008120Sgblack@eecs.umich.eduglobal_vars.Save(global_vars_file, main)
4015341Sstever@gmail.com
4025863Snate@binkert.org# Parse EXTRAS variable to build list of all directories where we're
4038268Ssteve.reinhardt@amd.com# look for sources etc.  This list is exported as extras_dir_list.
4046121Snate@binkert.orgbase_dir = main.srcdir.abspath
4056121Snate@binkert.orgif main['EXTRAS']:
4068268Ssteve.reinhardt@amd.com    extras_dir_list = makePathListAbsolute(main['EXTRAS'].split(':'))
4075742Snate@binkert.orgelse:
4085742Snate@binkert.org    extras_dir_list = []
4095341Sstever@gmail.com
4105742Snate@binkert.orgExport('base_dir')
4115742Snate@binkert.orgExport('extras_dir_list')
4125341Sstever@gmail.com
4136017Snate@binkert.org# the ext directory should be on the #includes path
4146121Snate@binkert.orgmain.Append(CPPPATH=[Dir('ext')])
4156017Snate@binkert.org
4167816Ssteve.reinhardt@amd.comdef strip_build_path(path, env):
4177756SAli.Saidi@ARM.com    path = str(path)
4187756SAli.Saidi@ARM.com    variant_base = env['BUILDROOT'] + os.path.sep
4197756SAli.Saidi@ARM.com    if path.startswith(variant_base):
4207756SAli.Saidi@ARM.com        path = path[len(variant_base):]
4217756SAli.Saidi@ARM.com    elif path.startswith('build/'):
4227756SAli.Saidi@ARM.com        path = path[6:]
4237756SAli.Saidi@ARM.com    return path
4247756SAli.Saidi@ARM.com
4257816Ssteve.reinhardt@amd.com# Generate a string of the form:
4267816Ssteve.reinhardt@amd.com#   common/path/prefix/src1, src2 -> tgt1, tgt2
4277816Ssteve.reinhardt@amd.com# to print while building.
4287816Ssteve.reinhardt@amd.comclass Transform(object):
4297816Ssteve.reinhardt@amd.com    # all specific color settings should be here and nowhere else
4307816Ssteve.reinhardt@amd.com    tool_color = termcap.Normal
4317816Ssteve.reinhardt@amd.com    pfx_color = termcap.Yellow
4327816Ssteve.reinhardt@amd.com    srcs_color = termcap.Yellow + termcap.Bold
4337816Ssteve.reinhardt@amd.com    arrow_color = termcap.Blue + termcap.Bold
4347816Ssteve.reinhardt@amd.com    tgts_color = termcap.Yellow + termcap.Bold
4357756SAli.Saidi@ARM.com
4367816Ssteve.reinhardt@amd.com    def __init__(self, tool, max_sources=99):
4377816Ssteve.reinhardt@amd.com        self.format = self.tool_color + (" [%8s] " % tool) \
4387816Ssteve.reinhardt@amd.com                      + self.pfx_color + "%s" \
4397816Ssteve.reinhardt@amd.com                      + self.srcs_color + "%s" \
4407816Ssteve.reinhardt@amd.com                      + self.arrow_color + " -> " \
4417816Ssteve.reinhardt@amd.com                      + self.tgts_color + "%s" \
4427816Ssteve.reinhardt@amd.com                      + termcap.Normal
4437816Ssteve.reinhardt@amd.com        self.max_sources = max_sources
4447816Ssteve.reinhardt@amd.com
4457816Ssteve.reinhardt@amd.com    def __call__(self, target, source, env, for_signature=None):
4467816Ssteve.reinhardt@amd.com        # truncate source list according to max_sources param
4477816Ssteve.reinhardt@amd.com        source = source[0:self.max_sources]
4487816Ssteve.reinhardt@amd.com        def strip(f):
4497816Ssteve.reinhardt@amd.com            return strip_build_path(str(f), env)
4507816Ssteve.reinhardt@amd.com        if len(source) > 0:
4517816Ssteve.reinhardt@amd.com            srcs = map(strip, source)
4527816Ssteve.reinhardt@amd.com        else:
4537816Ssteve.reinhardt@amd.com            srcs = ['']
4547816Ssteve.reinhardt@amd.com        tgts = map(strip, target)
4557816Ssteve.reinhardt@amd.com        # surprisingly, os.path.commonprefix is a dumb char-by-char string
4567816Ssteve.reinhardt@amd.com        # operation that has nothing to do with paths.
4577816Ssteve.reinhardt@amd.com        com_pfx = os.path.commonprefix(srcs + tgts)
4587816Ssteve.reinhardt@amd.com        com_pfx_len = len(com_pfx)
4597816Ssteve.reinhardt@amd.com        if com_pfx:
4607816Ssteve.reinhardt@amd.com            # do some cleanup and sanity checking on common prefix
4617816Ssteve.reinhardt@amd.com            if com_pfx[-1] == ".":
4627816Ssteve.reinhardt@amd.com                # prefix matches all but file extension: ok
4637816Ssteve.reinhardt@amd.com                # back up one to change 'foo.cc -> o' to 'foo.cc -> .o'
4647816Ssteve.reinhardt@amd.com                com_pfx = com_pfx[0:-1]
4657816Ssteve.reinhardt@amd.com            elif com_pfx[-1] == "/":
4667816Ssteve.reinhardt@amd.com                # common prefix is directory path: OK
4677816Ssteve.reinhardt@amd.com                pass
4687816Ssteve.reinhardt@amd.com            else:
4697816Ssteve.reinhardt@amd.com                src0_len = len(srcs[0])
4707816Ssteve.reinhardt@amd.com                tgt0_len = len(tgts[0])
4717816Ssteve.reinhardt@amd.com                if src0_len == com_pfx_len:
4727816Ssteve.reinhardt@amd.com                    # source is a substring of target, OK
4737816Ssteve.reinhardt@amd.com                    pass
4747816Ssteve.reinhardt@amd.com                elif tgt0_len == com_pfx_len:
4757816Ssteve.reinhardt@amd.com                    # target is a substring of source, need to back up to
4767816Ssteve.reinhardt@amd.com                    # avoid empty string on RHS of arrow
4777816Ssteve.reinhardt@amd.com                    sep_idx = com_pfx.rfind(".")
4787816Ssteve.reinhardt@amd.com                    if sep_idx != -1:
4797816Ssteve.reinhardt@amd.com                        com_pfx = com_pfx[0:sep_idx]
4807816Ssteve.reinhardt@amd.com                    else:
4817816Ssteve.reinhardt@amd.com                        com_pfx = ''
4827816Ssteve.reinhardt@amd.com                elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".":
4837816Ssteve.reinhardt@amd.com                    # still splitting at file extension: ok
4847816Ssteve.reinhardt@amd.com                    pass
4857816Ssteve.reinhardt@amd.com                else:
4867816Ssteve.reinhardt@amd.com                    # probably a fluke; ignore it
4877816Ssteve.reinhardt@amd.com                    com_pfx = ''
4887816Ssteve.reinhardt@amd.com        # recalculate length in case com_pfx was modified
4897816Ssteve.reinhardt@amd.com        com_pfx_len = len(com_pfx)
4907816Ssteve.reinhardt@amd.com        def fmt(files):
4917816Ssteve.reinhardt@amd.com            f = map(lambda s: s[com_pfx_len:], files)
4927816Ssteve.reinhardt@amd.com            return ', '.join(f)
4937816Ssteve.reinhardt@amd.com        return self.format % (com_pfx, fmt(srcs), fmt(tgts))
4947816Ssteve.reinhardt@amd.com
4957816Ssteve.reinhardt@amd.comExport('Transform')
4967816Ssteve.reinhardt@amd.com
4978947Sandreas.hansson@arm.com# enable the regression script to use the termcap
4988947Sandreas.hansson@arm.commain['TERMCAP'] = termcap
4997756SAli.Saidi@ARM.com
5008120Sgblack@eecs.umich.eduif GetOption('verbose'):
5017756SAli.Saidi@ARM.com    def MakeAction(action, string, *args, **kwargs):
5027756SAli.Saidi@ARM.com        return Action(action, *args, **kwargs)
5037756SAli.Saidi@ARM.comelse:
5047756SAli.Saidi@ARM.com    MakeAction = Action
5057816Ssteve.reinhardt@amd.com    main['CCCOMSTR']        = Transform("CC")
5067816Ssteve.reinhardt@amd.com    main['CXXCOMSTR']       = Transform("CXX")
5077816Ssteve.reinhardt@amd.com    main['ASCOMSTR']        = Transform("AS")
5087816Ssteve.reinhardt@amd.com    main['SWIGCOMSTR']      = Transform("SWIG")
5097816Ssteve.reinhardt@amd.com    main['ARCOMSTR']        = Transform("AR", 0)
5107816Ssteve.reinhardt@amd.com    main['LINKCOMSTR']      = Transform("LINK", 0)
5117816Ssteve.reinhardt@amd.com    main['RANLIBCOMSTR']    = Transform("RANLIB", 0)
5127816Ssteve.reinhardt@amd.com    main['M4COMSTR']        = Transform("M4")
5137816Ssteve.reinhardt@amd.com    main['SHCCCOMSTR']      = Transform("SHCC")
5147816Ssteve.reinhardt@amd.com    main['SHCXXCOMSTR']     = Transform("SHCXX")
5157756SAli.Saidi@ARM.comExport('MakeAction')
5167756SAli.Saidi@ARM.com
5179227Sandreas.hansson@arm.com# Initialize the Link-Time Optimization (LTO) flags
5189227Sandreas.hansson@arm.commain['LTO_CCFLAGS'] = []
5199227Sandreas.hansson@arm.commain['LTO_LDFLAGS'] = []
5209227Sandreas.hansson@arm.com
5219590Sandreas@sandberg.pp.se# According to the readme, tcmalloc works best if the compiler doesn't
5229590Sandreas@sandberg.pp.se# assume that we're using the builtin malloc and friends. These flags
5239590Sandreas@sandberg.pp.se# are compiler-specific, so we need to set them after we detect which
5249590Sandreas@sandberg.pp.se# compiler we're using.
5259590Sandreas@sandberg.pp.semain['TCMALLOC_CCFLAGS'] = []
5269590Sandreas@sandberg.pp.se
5276654Snate@binkert.orgCXX_version = readCommand([main['CXX'],'--version'], exception=False)
5286654Snate@binkert.orgCXX_V = readCommand([main['CXX'],'-V'], exception=False)
5295871Snate@binkert.org
5306121Snate@binkert.orgmain['GCC'] = CXX_version and CXX_version.find('g++') >= 0
5318946Sandreas.hansson@arm.commain['CLANG'] = CXX_version and CXX_version.find('clang') >= 0
5329419Sandreas.hansson@arm.comif main['GCC'] + main['CLANG'] > 1:
5333940Ssaidi@eecs.umich.edu    print 'Error: How can we have two at the same time?'
5343918Ssaidi@eecs.umich.edu    Exit(1)
5353918Ssaidi@eecs.umich.edu
5361858SN/A# Set up default C++ compiler flags
5379556Sandreas.hansson@arm.comif main['GCC'] or main['CLANG']:
5389556Sandreas.hansson@arm.com    # As gcc and clang share many flags, do the common parts here
5399556Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-pipe'])
5409556Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-fno-strict-aliasing'])
5419556Sandreas.hansson@arm.com    # Enable -Wall and then disable the few warnings that we
5429556Sandreas.hansson@arm.com    # consistently violate
5439556Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef'])
5449556Sandreas.hansson@arm.com    # We always compile using C++11, but only gcc >= 4.7 and clang 3.1
5459556Sandreas.hansson@arm.com    # actually use that name, so we stick with c++0x
5469556Sandreas.hansson@arm.com    main.Append(CXXFLAGS=['-std=c++0x'])
5479556Sandreas.hansson@arm.com    # Add selected sanity checks from -Wextra
5489556Sandreas.hansson@arm.com    main.Append(CXXFLAGS=['-Wmissing-field-initializers',
5499556Sandreas.hansson@arm.com                          '-Woverloaded-virtual'])
5509556Sandreas.hansson@arm.comelse:
5519556Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal,
5529556Sandreas.hansson@arm.com    print "Don't know what compiler options to use for your compiler."
5539556Sandreas.hansson@arm.com    print termcap.Yellow + '       compiler:' + termcap.Normal, main['CXX']
5549556Sandreas.hansson@arm.com    print termcap.Yellow + '       version:' + termcap.Normal,
5559556Sandreas.hansson@arm.com    if not CXX_version:
5569556Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\
5579556Sandreas.hansson@arm.com               termcap.Normal
5589556Sandreas.hansson@arm.com    else:
5599556Sandreas.hansson@arm.com        print CXX_version.replace('\n', '<nl>')
5609556Sandreas.hansson@arm.com    print "       If you're trying to use a compiler other than GCC"
5619556Sandreas.hansson@arm.com    print "       or clang, there appears to be something wrong with your"
5629556Sandreas.hansson@arm.com    print "       environment."
5639556Sandreas.hansson@arm.com    print "       "
5649556Sandreas.hansson@arm.com    print "       If you are trying to use a compiler other than those listed"
5659556Sandreas.hansson@arm.com    print "       above you will need to ease fix SConstruct and "
5669556Sandreas.hansson@arm.com    print "       src/SConscript to support that compiler."
5679556Sandreas.hansson@arm.com    Exit(1)
5689556Sandreas.hansson@arm.com
5696121Snate@binkert.orgif main['GCC']:
5709420Sandreas.hansson@arm.com    # Check for a supported version of gcc, >= 4.4 is needed for c++0x
5719420Sandreas.hansson@arm.com    # support. See http://gcc.gnu.org/projects/cxx0x.html for details
5729420Sandreas.hansson@arm.com    gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False)
5739420Sandreas.hansson@arm.com    if compareVersions(gcc_version, "4.4") < 0:
5749420Sandreas.hansson@arm.com        print 'Error: gcc version 4.4 or newer required.'
5759420Sandreas.hansson@arm.com        print '       Installed version:', gcc_version
5769420Sandreas.hansson@arm.com        Exit(1)
5779420Sandreas.hansson@arm.com
5789420Sandreas.hansson@arm.com    main['GCC_VERSION'] = gcc_version
5799420Sandreas.hansson@arm.com
5809420Sandreas.hansson@arm.com    # Check for versions with bugs
5817618SAli.Saidi@arm.com    if not compareVersions(gcc_version, '4.4.1') or \
5827618SAli.Saidi@arm.com       not compareVersions(gcc_version, '4.4.2'):
5837618SAli.Saidi@arm.com        print 'Info: Tree vectorizer in GCC 4.4.1 & 4.4.2 is buggy, disabling.'
5847739Sgblack@eecs.umich.edu        main.Append(CCFLAGS=['-fno-tree-vectorize'])
5859227Sandreas.hansson@arm.com
5869227Sandreas.hansson@arm.com    # LTO support is only really working properly from 4.6 and beyond
5879227Sandreas.hansson@arm.com    if compareVersions(gcc_version, '4.6') >= 0:
5889227Sandreas.hansson@arm.com        # Add the appropriate Link-Time Optimization (LTO) flags
5899227Sandreas.hansson@arm.com        # unless LTO is explicitly turned off. Note that these flags
5909227Sandreas.hansson@arm.com        # are only used by the fast target.
5919227Sandreas.hansson@arm.com        if not GetOption('no_lto'):
5929227Sandreas.hansson@arm.com            # Pass the LTO flag when compiling to produce GIMPLE
5939227Sandreas.hansson@arm.com            # output, we merely create the flags here and only append
5949227Sandreas.hansson@arm.com            # them later/
5959227Sandreas.hansson@arm.com            main['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
5969227Sandreas.hansson@arm.com
5979227Sandreas.hansson@arm.com            # Use the same amount of jobs for LTO as we are running
5989227Sandreas.hansson@arm.com            # scons with, we hardcode the use of the linker plugin
5999227Sandreas.hansson@arm.com            # which requires either gold or GNU ld >= 2.21
6009227Sandreas.hansson@arm.com            main['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs'),
6019227Sandreas.hansson@arm.com                                   '-fuse-linker-plugin']
6029227Sandreas.hansson@arm.com
6039590Sandreas@sandberg.pp.se    main.Append(TCMALLOC_CCFLAGS=['-fno-builtin-malloc', '-fno-builtin-calloc',
6049590Sandreas@sandberg.pp.se                                  '-fno-builtin-realloc', '-fno-builtin-free'])
6059590Sandreas@sandberg.pp.se
6068737Skoansin.tan@gmail.comelif main['CLANG']:
6079420Sandreas.hansson@arm.com    # Check for a supported version of clang, >= 2.9 is needed to
6089420Sandreas.hansson@arm.com    # support similar features as gcc 4.4. See
6099420Sandreas.hansson@arm.com    # http://clang.llvm.org/cxx_status.html for details
6108737Skoansin.tan@gmail.com    clang_version_re = re.compile(".* version (\d+\.\d+)")
6118737Skoansin.tan@gmail.com    clang_version_match = clang_version_re.match(CXX_version)
6128737Skoansin.tan@gmail.com    if (clang_version_match):
6138737Skoansin.tan@gmail.com        clang_version = clang_version_match.groups()[0]
6148737Skoansin.tan@gmail.com        if compareVersions(clang_version, "2.9") < 0:
6158737Skoansin.tan@gmail.com            print 'Error: clang version 2.9 or newer required.'
6168737Skoansin.tan@gmail.com            print '       Installed version:', clang_version
6178737Skoansin.tan@gmail.com            Exit(1)
6188737Skoansin.tan@gmail.com    else:
6198737Skoansin.tan@gmail.com        print 'Error: Unable to determine clang version.'
6208737Skoansin.tan@gmail.com        Exit(1)
6218737Skoansin.tan@gmail.com
6229556Sandreas.hansson@arm.com    # clang has a few additional warnings that we disable,
6239556Sandreas.hansson@arm.com    # tautological comparisons are allowed due to unsigned integers
6249556Sandreas.hansson@arm.com    # being compared to constants that happen to be 0, and extraneous
6259556Sandreas.hansson@arm.com    # parantheses are allowed due to Ruby's printing of the AST,
6269556Sandreas.hansson@arm.com    # finally self assignments are allowed as the generated CPU code
6279556Sandreas.hansson@arm.com    # is relying on this
6289556Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-Wno-tautological-compare',
6299556Sandreas.hansson@arm.com                         '-Wno-parentheses',
6309556Sandreas.hansson@arm.com                         '-Wno-self-assign'])
6319556Sandreas.hansson@arm.com
6329590Sandreas@sandberg.pp.se    main.Append(TCMALLOC_CCFLAGS=['-fno-builtin'])
6339590Sandreas@sandberg.pp.se
6349420Sandreas.hansson@arm.com    # On Mac OS X/Darwin we need to also use libc++ (part of XCode) as
6359846Sandreas.hansson@arm.com    # opposed to libstdc++, as the later is dated.
6369846Sandreas.hansson@arm.com    if sys.platform == "darwin":
6379846Sandreas.hansson@arm.com        main.Append(CXXFLAGS=['-stdlib=libc++'])
6389846Sandreas.hansson@arm.com        main.Append(LIBS=['c++'])
6398946Sandreas.hansson@arm.com
6403918Ssaidi@eecs.umich.eduelse:
6419068SAli.Saidi@ARM.com    print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal,
6429068SAli.Saidi@ARM.com    print "Don't know what compiler options to use for your compiler."
6439068SAli.Saidi@ARM.com    print termcap.Yellow + '       compiler:' + termcap.Normal, main['CXX']
6449068SAli.Saidi@ARM.com    print termcap.Yellow + '       version:' + termcap.Normal,
6459068SAli.Saidi@ARM.com    if not CXX_version:
6469068SAli.Saidi@ARM.com        print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\
6479068SAli.Saidi@ARM.com               termcap.Normal
6489068SAli.Saidi@ARM.com    else:
6499068SAli.Saidi@ARM.com        print CXX_version.replace('\n', '<nl>')
6509419Sandreas.hansson@arm.com    print "       If you're trying to use a compiler other than GCC"
6519068SAli.Saidi@ARM.com    print "       or clang, there appears to be something wrong with your"
6529068SAli.Saidi@ARM.com    print "       environment."
6539068SAli.Saidi@ARM.com    print "       "
6549068SAli.Saidi@ARM.com    print "       If you are trying to use a compiler other than those listed"
6559068SAli.Saidi@ARM.com    print "       above you will need to ease fix SConstruct and "
6569068SAli.Saidi@ARM.com    print "       src/SConscript to support that compiler."
6573918Ssaidi@eecs.umich.edu    Exit(1)
6583918Ssaidi@eecs.umich.edu
6596157Snate@binkert.org# Set up common yacc/bison flags (needed for Ruby)
6606157Snate@binkert.orgmain['YACCFLAGS'] = '-d'
6616157Snate@binkert.orgmain['YACCHXXFILESUFFIX'] = '.hh'
6626157Snate@binkert.org
6635397Ssaidi@eecs.umich.edu# Do this after we save setting back, or else we'll tack on an
6645397Ssaidi@eecs.umich.edu# extra 'qdo' every time we run scons.
6656121Snate@binkert.orgif main['BATCH']:
6666121Snate@binkert.org    main['CC']     = main['BATCH_CMD'] + ' ' + main['CC']
6676121Snate@binkert.org    main['CXX']    = main['BATCH_CMD'] + ' ' + main['CXX']
6686121Snate@binkert.org    main['AS']     = main['BATCH_CMD'] + ' ' + main['AS']
6696121Snate@binkert.org    main['AR']     = main['BATCH_CMD'] + ' ' + main['AR']
6706121Snate@binkert.org    main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB']
6715397Ssaidi@eecs.umich.edu
6721851SN/Aif sys.platform == 'cygwin':
6731851SN/A    # cygwin has some header file issues...
6747739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=["-Wno-uninitialized"])
675955SN/A
6769396Sandreas.hansson@arm.com# Check for the protobuf compiler
6779396Sandreas.hansson@arm.comprotoc_version = readCommand([main['PROTOC'], '--version'],
6789396Sandreas.hansson@arm.com                             exception='').split()
6799396Sandreas.hansson@arm.com
6809396Sandreas.hansson@arm.com# First two words should be "libprotoc x.y.z"
6819396Sandreas.hansson@arm.comif len(protoc_version) < 2 or protoc_version[0] != 'libprotoc':
6829396Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + \
6839396Sandreas.hansson@arm.com        'Warning: Protocol buffer compiler (protoc) not found.\n' + \
6849396Sandreas.hansson@arm.com        '         Please install protobuf-compiler for tracing support.' + \
6859396Sandreas.hansson@arm.com        termcap.Normal
6869396Sandreas.hansson@arm.com    main['PROTOC'] = False
6879396Sandreas.hansson@arm.comelse:
6889396Sandreas.hansson@arm.com    # Based on the availability of the compress stream wrappers,
6899396Sandreas.hansson@arm.com    # require 2.1.0
6909396Sandreas.hansson@arm.com    min_protoc_version = '2.1.0'
6919396Sandreas.hansson@arm.com    if compareVersions(protoc_version[1], min_protoc_version) < 0:
6929477Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + \
6939477Sandreas.hansson@arm.com            'Warning: protoc version', min_protoc_version, \
6949477Sandreas.hansson@arm.com            'or newer required.\n' + \
6959477Sandreas.hansson@arm.com            '         Installed version:', protoc_version[1], \
6969477Sandreas.hansson@arm.com            termcap.Normal
6979477Sandreas.hansson@arm.com        main['PROTOC'] = False
6989477Sandreas.hansson@arm.com    else:
6999477Sandreas.hansson@arm.com        # Attempt to determine the appropriate include path and
7009477Sandreas.hansson@arm.com        # library path using pkg-config, that means we also need to
7019477Sandreas.hansson@arm.com        # check for pkg-config. Note that it is possible to use
7029477Sandreas.hansson@arm.com        # protobuf without the involvement of pkg-config. Later on we
7039477Sandreas.hansson@arm.com        # check go a library config check and at that point the test
7049477Sandreas.hansson@arm.com        # will fail if libprotobuf cannot be found.
7059477Sandreas.hansson@arm.com        if readCommand(['pkg-config', '--version'], exception=''):
7069477Sandreas.hansson@arm.com            try:
7079477Sandreas.hansson@arm.com                # Attempt to establish what linking flags to add for protobuf
7089477Sandreas.hansson@arm.com                # using pkg-config
7099477Sandreas.hansson@arm.com                main.ParseConfig('pkg-config --cflags --libs-only-L protobuf')
7109477Sandreas.hansson@arm.com            except:
7119477Sandreas.hansson@arm.com                print termcap.Yellow + termcap.Bold + \
7129477Sandreas.hansson@arm.com                    'Warning: pkg-config could not get protobuf flags.' + \
7139477Sandreas.hansson@arm.com                    termcap.Normal
7149396Sandreas.hansson@arm.com
7153053Sstever@eecs.umich.edu# Check for SWIG
7166121Snate@binkert.orgif not main.has_key('SWIG'):
7173053Sstever@eecs.umich.edu    print 'Error: SWIG utility not found.'
7183053Sstever@eecs.umich.edu    print '       Please install (see http://www.swig.org) and retry.'
7193053Sstever@eecs.umich.edu    Exit(1)
7203053Sstever@eecs.umich.edu
7213053Sstever@eecs.umich.edu# Check for appropriate SWIG version
7229072Sandreas.hansson@arm.comswig_version = readCommand([main['SWIG'], '-version'], exception='').split()
7233053Sstever@eecs.umich.edu# First 3 words should be "SWIG Version x.y.z"
7244742Sstever@eecs.umich.eduif len(swig_version) < 3 or \
7254742Sstever@eecs.umich.edu        swig_version[0] != 'SWIG' or swig_version[1] != 'Version':
7263053Sstever@eecs.umich.edu    print 'Error determining SWIG version.'
7273053Sstever@eecs.umich.edu    Exit(1)
7283053Sstever@eecs.umich.edu
7298960Ssteve.reinhardt@amd.commin_swig_version = '1.3.34'
7306654Snate@binkert.orgif compareVersions(swig_version[2], min_swig_version) < 0:
7313053Sstever@eecs.umich.edu    print 'Error: SWIG version', min_swig_version, 'or newer required.'
7323053Sstever@eecs.umich.edu    print '       Installed version:', swig_version[2]
7333053Sstever@eecs.umich.edu    Exit(1)
7343053Sstever@eecs.umich.edu
7359877Sandreas.hansson@arm.com# Older versions of swig do not play well with more recent versions of
7369877Sandreas.hansson@arm.com# gcc due to assumptions on implicit includes (cstddef) and use of
7379877Sandreas.hansson@arm.com# namespaces
7389877Sandreas.hansson@arm.comif main['GCC'] and compareVersions(gcc_version, '4.6') > 0 and \
7399877Sandreas.hansson@arm.com        compareVersions(swig_version[2], '2') < 0:
7409585Sandreas@sandberg.pp.se    print '\n' + termcap.Yellow + termcap.Bold + \
7419877Sandreas.hansson@arm.com        'Warning: SWIG 1.x cause issues with gcc 4.6 and later.\n' + \
7429585Sandreas@sandberg.pp.se        termcap.Normal + \
7439877Sandreas.hansson@arm.com        'Use SWIG 2.x to avoid assumptions on implicit includes\n' + \
7449877Sandreas.hansson@arm.com        'and use of namespaces\n'
7459585Sandreas@sandberg.pp.se
7462667Sstever@eecs.umich.edu# Set up SWIG flags & scanner
7474554Sbinkertn@umich.eduswig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
7486121Snate@binkert.orgmain.Append(SWIGFLAGS=swig_flags)
7492667Sstever@eecs.umich.edu
7504554Sbinkertn@umich.edu# filter out all existing swig scanners, they mess up the dependency
7514554Sbinkertn@umich.edu# stuff for some reason
7524554Sbinkertn@umich.eduscanners = []
7536121Snate@binkert.orgfor scanner in main['SCANNERS']:
7544554Sbinkertn@umich.edu    skeys = scanner.skeys
7554554Sbinkertn@umich.edu    if skeys == '.i':
7564554Sbinkertn@umich.edu        continue
7574781Snate@binkert.org
7584554Sbinkertn@umich.edu    if isinstance(skeys, (list, tuple)) and '.i' in skeys:
7594554Sbinkertn@umich.edu        continue
7602667Sstever@eecs.umich.edu
7614554Sbinkertn@umich.edu    scanners.append(scanner)
7624554Sbinkertn@umich.edu
7634554Sbinkertn@umich.edu# add the new swig scanner that we like better
7644554Sbinkertn@umich.edufrom SCons.Scanner import ClassicCPP as CPPScanner
7652667Sstever@eecs.umich.eduswig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
7664554Sbinkertn@umich.eduscanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re))
7672667Sstever@eecs.umich.edu
7684554Sbinkertn@umich.edu# replace the scanners list that has what we want
7696121Snate@binkert.orgmain['SCANNERS'] = scanners
7702667Sstever@eecs.umich.edu
7715522Snate@binkert.org# Add a custom Check function to the Configure context so that we can
7725522Snate@binkert.org# figure out if the compiler adds leading underscores to global
7735522Snate@binkert.org# variables.  This is needed for the autogenerated asm files that we
7745522Snate@binkert.org# use for embedding the python code.
7755522Snate@binkert.orgdef CheckLeading(context):
7765522Snate@binkert.org    context.Message("Checking for leading underscore in global variables...")
7775522Snate@binkert.org    # 1) Define a global variable called x from asm so the C compiler
7785522Snate@binkert.org    #    won't change the symbol at all.
7795522Snate@binkert.org    # 2) Declare that variable.
7805522Snate@binkert.org    # 3) Use the variable
7815522Snate@binkert.org    #
7825522Snate@binkert.org    # If the compiler prepends an underscore, this will successfully
7835522Snate@binkert.org    # link because the external symbol 'x' will be called '_x' which
7845522Snate@binkert.org    # was defined by the asm statement.  If the compiler does not
7855522Snate@binkert.org    # prepend an underscore, this will not successfully link because
7865522Snate@binkert.org    # '_x' will have been defined by assembly, while the C portion of
7875522Snate@binkert.org    # the code will be trying to use 'x'
7885522Snate@binkert.org    ret = context.TryLink('''
7895522Snate@binkert.org        asm(".globl _x; _x: .byte 0");
7905522Snate@binkert.org        extern int x;
7915522Snate@binkert.org        int main() { return x; }
7925522Snate@binkert.org        ''', extension=".c")
7935522Snate@binkert.org    context.env.Append(LEADING_UNDERSCORE=ret)
7945522Snate@binkert.org    context.Result(ret)
7955522Snate@binkert.org    return ret
7965522Snate@binkert.org
7979986Sandreas@sandberg.pp.se# Add a custom Check function to test for structure members.
7989986Sandreas@sandberg.pp.sedef CheckMember(context, include, decl, member, include_quotes="<>"):
7999986Sandreas@sandberg.pp.se    context.Message("Checking for member %s in %s..." %
8009986Sandreas@sandberg.pp.se                    (member, decl))
8019986Sandreas@sandberg.pp.se    text = """
8029986Sandreas@sandberg.pp.se#include %(header)s
8039986Sandreas@sandberg.pp.seint main(){
8049986Sandreas@sandberg.pp.se  %(decl)s test;
8059986Sandreas@sandberg.pp.se  (void)test.%(member)s;
8069986Sandreas@sandberg.pp.se  return 0;
8079986Sandreas@sandberg.pp.se};
8089986Sandreas@sandberg.pp.se""" % { "header" : include_quotes[0] + include + include_quotes[1],
8099986Sandreas@sandberg.pp.se        "decl" : decl,
8109986Sandreas@sandberg.pp.se        "member" : member,
8119986Sandreas@sandberg.pp.se        }
8129986Sandreas@sandberg.pp.se
8139986Sandreas@sandberg.pp.se    ret = context.TryCompile(text, extension=".cc")
8149986Sandreas@sandberg.pp.se    context.Result(ret)
8159986Sandreas@sandberg.pp.se    return ret
8169986Sandreas@sandberg.pp.se
8172638Sstever@eecs.umich.edu# Platform-specific configuration.  Note again that we assume that all
8182638Sstever@eecs.umich.edu# builds under a given build root run on the same host platform.
8196121Snate@binkert.orgconf = Configure(main,
8203716Sstever@eecs.umich.edu                 conf_dir = joinpath(build_root, '.scons_config'),
8215522Snate@binkert.org                 log_file = joinpath(build_root, 'scons_config.log'),
8229986Sandreas@sandberg.pp.se                 custom_tests = {
8239986Sandreas@sandberg.pp.se        'CheckLeading' : CheckLeading,
8249986Sandreas@sandberg.pp.se        'CheckMember' : CheckMember,
8259986Sandreas@sandberg.pp.se        })
8265522Snate@binkert.org
8275522Snate@binkert.org# Check for leading underscores.  Don't really need to worry either
8285522Snate@binkert.org# way so don't need to check the return code.
8295522Snate@binkert.orgconf.CheckLeading()
8301858SN/A
8315227Ssaidi@eecs.umich.edu# Check if we should compile a 64 bit binary on Mac OS X/Darwin
8325227Ssaidi@eecs.umich.edutry:
8335227Ssaidi@eecs.umich.edu    import platform
8345227Ssaidi@eecs.umich.edu    uname = platform.uname()
8356654Snate@binkert.org    if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0:
8366654Snate@binkert.org        if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
8377769SAli.Saidi@ARM.com            main.Append(CCFLAGS=['-arch', 'x86_64'])
8387769SAli.Saidi@ARM.com            main.Append(CFLAGS=['-arch', 'x86_64'])
8397769SAli.Saidi@ARM.com            main.Append(LINKFLAGS=['-arch', 'x86_64'])
8407769SAli.Saidi@ARM.com            main.Append(ASFLAGS=['-arch', 'x86_64'])
8415227Ssaidi@eecs.umich.eduexcept:
8425227Ssaidi@eecs.umich.edu    pass
8435227Ssaidi@eecs.umich.edu
8445204Sstever@gmail.com# Recent versions of scons substitute a "Null" object for Configure()
8455204Sstever@gmail.com# when configuration isn't necessary, e.g., if the "--help" option is
8465204Sstever@gmail.com# present.  Unfortuantely this Null object always returns false,
8475204Sstever@gmail.com# breaking all our configuration checks.  We replace it with our own
8485204Sstever@gmail.com# more optimistic null object that returns True instead.
8495204Sstever@gmail.comif not conf:
8505204Sstever@gmail.com    def NullCheck(*args, **kwargs):
8515204Sstever@gmail.com        return True
8525204Sstever@gmail.com
8535204Sstever@gmail.com    class NullConf:
8545204Sstever@gmail.com        def __init__(self, env):
8555204Sstever@gmail.com            self.env = env
8565204Sstever@gmail.com        def Finish(self):
8575204Sstever@gmail.com            return self.env
8585204Sstever@gmail.com        def __getattr__(self, mname):
8595204Sstever@gmail.com            return NullCheck
8605204Sstever@gmail.com
8616121Snate@binkert.org    conf = NullConf(main)
8625204Sstever@gmail.com
8637727SAli.Saidi@ARM.com# Cache build files in the supplied directory.
8647727SAli.Saidi@ARM.comif main['M5_BUILD_CACHE']:
8657727SAli.Saidi@ARM.com    print 'Using build cache located at', main['M5_BUILD_CACHE']
8667727SAli.Saidi@ARM.com    CacheDir(main['M5_BUILD_CACHE'])
8677727SAli.Saidi@ARM.com
8689812Sandreas.hansson@arm.com# Find Python include and library directories for embedding the
8699812Sandreas.hansson@arm.com# interpreter. We rely on python-config to resolve the appropriate
8709812Sandreas.hansson@arm.com# includes and linker flags. ParseConfig does not seem to understand
8719812Sandreas.hansson@arm.com# the more exotic linker flags such as -Xlinker and -export-dynamic so
8729812Sandreas.hansson@arm.com# we add them explicitly below. If you want to link in an alternate
8739812Sandreas.hansson@arm.com# version of python, see above for instructions on how to invoke
8749812Sandreas.hansson@arm.com# scons with the appropriate PATH set.
8759812Sandreas.hansson@arm.compy_includes = readCommand(['python-config', '--includes'],
8769812Sandreas.hansson@arm.com                          exception='').split()
8779812Sandreas.hansson@arm.com# Strip the -I from the include folders before adding them to the
8789812Sandreas.hansson@arm.com# CPPPATH
8799812Sandreas.hansson@arm.commain.Append(CPPPATH=map(lambda inc: inc[2:], py_includes))
8809812Sandreas.hansson@arm.com
8819812Sandreas.hansson@arm.com# Read the linker flags and split them into libraries and other link
8829812Sandreas.hansson@arm.com# flags. The libraries are added later through the call the CheckLib.
8839812Sandreas.hansson@arm.compy_ld_flags = readCommand(['python-config', '--ldflags'], exception='').split()
8849812Sandreas.hansson@arm.compy_libs = []
8859812Sandreas.hansson@arm.comfor lib in py_ld_flags:
8869812Sandreas.hansson@arm.com     if not lib.startswith('-l'):
8879812Sandreas.hansson@arm.com         main.Append(LINKFLAGS=[lib])
8889812Sandreas.hansson@arm.com     else:
8899812Sandreas.hansson@arm.com         lib = lib[2:]
8909812Sandreas.hansson@arm.com         if lib not in py_libs:
8919812Sandreas.hansson@arm.com             py_libs.append(lib)
8927727SAli.Saidi@ARM.com
8935863Snate@binkert.org# verify that this stuff works
8943118Sstever@eecs.umich.eduif not conf.CheckHeader('Python.h', '<>'):
8955863Snate@binkert.org    print "Error: can't find Python.h header in", py_includes
8969239Sandreas.hansson@arm.com    print "Install Python headers (package python-dev on Ubuntu and RedHat)"
8973118Sstever@eecs.umich.edu    Exit(1)
8983118Sstever@eecs.umich.edu
8995863Snate@binkert.orgfor lib in py_libs:
9005863Snate@binkert.org    if not conf.CheckLib(lib):
9015863Snate@binkert.org        print "Error: can't find library %s required by python" % lib
9025863Snate@binkert.org        Exit(1)
9033118Sstever@eecs.umich.edu
9043483Ssaidi@eecs.umich.edu# On Solaris you need to use libsocket for socket ops
9053494Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
9063494Ssaidi@eecs.umich.edu   if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
9073483Ssaidi@eecs.umich.edu       print "Can't find library with socket calls (e.g. accept())"
9083483Ssaidi@eecs.umich.edu       Exit(1)
9093483Ssaidi@eecs.umich.edu
9103053Sstever@eecs.umich.edu# Check for zlib.  If the check passes, libz will be automatically
9113053Sstever@eecs.umich.edu# added to the LIBS environment variable.
9123918Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
9133053Sstever@eecs.umich.edu    print 'Error: did not find needed zlib compression library '\
9143053Sstever@eecs.umich.edu          'and/or zlib.h header file.'
9153053Sstever@eecs.umich.edu    print '       Please install zlib and try again.'
9163053Sstever@eecs.umich.edu    Exit(1)
9173053Sstever@eecs.umich.edu
9189396Sandreas.hansson@arm.com# If we have the protobuf compiler, also make sure we have the
9199396Sandreas.hansson@arm.com# development libraries. If the check passes, libprotobuf will be
9209396Sandreas.hansson@arm.com# automatically added to the LIBS environment variable. After
9219396Sandreas.hansson@arm.com# this, we can use the HAVE_PROTOBUF flag to determine if we have
9229396Sandreas.hansson@arm.com# got both protoc and libprotobuf available.
9239396Sandreas.hansson@arm.commain['HAVE_PROTOBUF'] = main['PROTOC'] and \
9249396Sandreas.hansson@arm.com    conf.CheckLibWithHeader('protobuf', 'google/protobuf/message.h',
9259396Sandreas.hansson@arm.com                            'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;')
9269396Sandreas.hansson@arm.com
9279477Sandreas.hansson@arm.com# If we have the compiler but not the library, print another warning.
9289396Sandreas.hansson@arm.comif main['PROTOC'] and not main['HAVE_PROTOBUF']:
9299477Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + \
9309477Sandreas.hansson@arm.com        'Warning: did not find protocol buffer library and/or headers.\n' + \
9319477Sandreas.hansson@arm.com    '       Please install libprotobuf-dev for tracing support.' + \
9329477Sandreas.hansson@arm.com    termcap.Normal
9339396Sandreas.hansson@arm.com
9347840Snate@binkert.org# Check for librt.
9357865Sgblack@eecs.umich.eduhave_posix_clock = \
9367865Sgblack@eecs.umich.edu    conf.CheckLibWithHeader(None, 'time.h', 'C',
9377865Sgblack@eecs.umich.edu                            'clock_nanosleep(0,0,NULL,NULL);') or \
9387865Sgblack@eecs.umich.edu    conf.CheckLibWithHeader('rt', 'time.h', 'C',
9397865Sgblack@eecs.umich.edu                            'clock_nanosleep(0,0,NULL,NULL);')
9407840Snate@binkert.org
9419900Sandreas@sandberg.pp.sehave_posix_timers = \
9429900Sandreas@sandberg.pp.se    conf.CheckLibWithHeader([None, 'rt'], [ 'time.h', 'signal.h' ], 'C',
9439900Sandreas@sandberg.pp.se                            'timer_create(CLOCK_MONOTONIC, NULL, NULL);')
9449900Sandreas@sandberg.pp.se
9459591Sandreas@sandberg.pp.seif conf.CheckLib('tcmalloc'):
9469591Sandreas@sandberg.pp.se    main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS'])
9479591Sandreas@sandberg.pp.seelif conf.CheckLib('tcmalloc_minimal'):
9489590Sandreas@sandberg.pp.se    main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS'])
9499590Sandreas@sandberg.pp.seelse:
9509045SAli.Saidi@ARM.com    print termcap.Yellow + termcap.Bold + \
9519045SAli.Saidi@ARM.com          "You can get a 12% performance improvement by installing tcmalloc "\
9529071Sandreas.hansson@arm.com          "(libgoogle-perftools-dev package on Ubuntu or RedHat)." + \
9539071Sandreas.hansson@arm.com          termcap.Normal
9549045SAli.Saidi@ARM.com
9557840Snate@binkert.orgif not have_posix_clock:
9567840Snate@binkert.org    print "Can't find library for POSIX clocks."
9577840Snate@binkert.org
9581858SN/A# Check for <fenv.h> (C99 FP environment control)
9591858SN/Ahave_fenv = conf.CheckHeader('fenv.h', '<>')
9601858SN/Aif not have_fenv:
9611858SN/A    print "Warning: Header file <fenv.h> not found."
9621858SN/A    print "         This host has no IEEE FP rounding mode control."
9631858SN/A
9649903Sandreas.hansson@arm.com# Check if we should enable KVM-based hardware virtualization. The API
9659903Sandreas.hansson@arm.com# we rely on exists since version 2.6.36 of the kernel, but somehow
9669903Sandreas.hansson@arm.com# the KVM_API_VERSION does not reflect the change. We test for one of
9679903Sandreas.hansson@arm.com# the types as a fall back.
9689903Sandreas.hansson@arm.comhave_kvm = conf.CheckHeader('linux/kvm.h', '<>') and \
9699903Sandreas.hansson@arm.com    conf.CheckTypeSize('struct kvm_xsave', '#include <linux/kvm.h>') != 0
9709651SAndreas.Sandberg@ARM.comif not have_kvm:
9719903Sandreas.hansson@arm.com    print "Info: Compatible header file <linux/kvm.h> not found, " \
9729651SAndreas.Sandberg@ARM.com        "disabling KVM support."
9739651SAndreas.Sandberg@ARM.com
9749651SAndreas.Sandberg@ARM.com# Check if the requested target ISA is compatible with the host
9759651SAndreas.Sandberg@ARM.comdef is_isa_kvm_compatible(isa):
9769651SAndreas.Sandberg@ARM.com    isa_comp_table = {
9779657Sandreas.sandberg@arm.com        "arm" : ( "armv7l" ),
9789883Sandreas@sandberg.pp.se        "x86" : ( "x86_64" ),
9799651SAndreas.Sandberg@ARM.com        }
9809651SAndreas.Sandberg@ARM.com    try:
9819651SAndreas.Sandberg@ARM.com        import platform
9829651SAndreas.Sandberg@ARM.com        host_isa = platform.machine()
9839651SAndreas.Sandberg@ARM.com    except:
9849651SAndreas.Sandberg@ARM.com        print "Warning: Failed to determine host ISA."
9859651SAndreas.Sandberg@ARM.com        return False
9869651SAndreas.Sandberg@ARM.com
9879651SAndreas.Sandberg@ARM.com    return host_isa in isa_comp_table.get(isa, [])
9889651SAndreas.Sandberg@ARM.com
9899651SAndreas.Sandberg@ARM.com
9909986Sandreas@sandberg.pp.se# Check if the exclude_host attribute is available. We want this to
9919986Sandreas@sandberg.pp.se# get accurate instruction counts in KVM.
9929986Sandreas@sandberg.pp.semain['HAVE_PERF_ATTR_EXCLUDE_HOST'] = conf.CheckMember(
9939986Sandreas@sandberg.pp.se    'linux/perf_event.h', 'struct perf_event_attr', 'exclude_host')
9949986Sandreas@sandberg.pp.se
9959986Sandreas@sandberg.pp.se
9965863Snate@binkert.org######################################################################
9975863Snate@binkert.org#
9985863Snate@binkert.org# Finish the configuration
9995863Snate@binkert.org#
10006121Snate@binkert.orgmain = conf.Finish()
10011858SN/A
10025863Snate@binkert.org######################################################################
10035863Snate@binkert.org#
10045863Snate@binkert.org# Collect all non-global variables
10055863Snate@binkert.org#
10065863Snate@binkert.org
10072139SN/A# Define the universe of supported ISAs
10084202Sbinkertn@umich.eduall_isa_list = [ ]
10094202Sbinkertn@umich.eduExport('all_isa_list')
10102139SN/A
10116994Snate@binkert.orgclass CpuModel(object):
10126994Snate@binkert.org    '''The CpuModel class encapsulates everything the ISA parser needs to
10136994Snate@binkert.org    know about a particular CPU model.'''
10146994Snate@binkert.org
10156994Snate@binkert.org    # Dict of available CPU model objects.  Accessible as CpuModel.dict.
10166994Snate@binkert.org    dict = {}
10176994Snate@binkert.org    list = []
10186994Snate@binkert.org    defaults = []
10196994Snate@binkert.org
10206994Snate@binkert.org    # Constructor.  Automatically adds models to CpuModel.dict.
10216994Snate@binkert.org    def __init__(self, name, filename, includes, strings, default=False):
10226994Snate@binkert.org        self.name = name           # name of model
10236994Snate@binkert.org        self.filename = filename   # filename for output exec code
10246994Snate@binkert.org        self.includes = includes   # include files needed in exec file
10256994Snate@binkert.org        # The 'strings' dict holds all the per-CPU symbols we can
10266994Snate@binkert.org        # substitute into templates etc.
10276994Snate@binkert.org        self.strings = strings
10286994Snate@binkert.org
10296994Snate@binkert.org        # This cpu is enabled by default
10306994Snate@binkert.org        self.default = default
10316994Snate@binkert.org
10326994Snate@binkert.org        # Add self to dict
10336994Snate@binkert.org        if name in CpuModel.dict:
10346994Snate@binkert.org            raise AttributeError, "CpuModel '%s' already registered" % name
10356994Snate@binkert.org        CpuModel.dict[name] = self
10366994Snate@binkert.org        CpuModel.list.append(name)
10376994Snate@binkert.org
10386994Snate@binkert.orgExport('CpuModel')
10392155SN/A
10405863Snate@binkert.org# Sticky variables get saved in the variables file so they persist from
10411869SN/A# one invocation to the next (unless overridden, in which case the new
10421869SN/A# value becomes sticky).
10435863Snate@binkert.orgsticky_vars = Variables(args=ARGUMENTS)
10445863Snate@binkert.orgExport('sticky_vars')
10454202Sbinkertn@umich.edu
10466108Snate@binkert.org# Sticky variables that should be exported
10476108Snate@binkert.orgexport_vars = []
10486108Snate@binkert.orgExport('export_vars')
10496108Snate@binkert.org
10509219Spower.jg@gmail.com# For Ruby
10519219Spower.jg@gmail.comall_protocols = []
10529219Spower.jg@gmail.comExport('all_protocols')
10539219Spower.jg@gmail.comprotocol_dirs = []
10549219Spower.jg@gmail.comExport('protocol_dirs')
10559219Spower.jg@gmail.comslicc_includes = []
10569219Spower.jg@gmail.comExport('slicc_includes')
10579219Spower.jg@gmail.com
10584202Sbinkertn@umich.edu# Walk the tree and execute all SConsopts scripts that wil add to the
10595863Snate@binkert.org# above variables
10608474Sgblack@eecs.umich.eduif not GetOption('verbose'):
10618474Sgblack@eecs.umich.edu    print "Reading SConsopts"
10625742Snate@binkert.orgfor bdir in [ base_dir ] + extras_dir_list:
10638268Ssteve.reinhardt@amd.com    if not isdir(bdir):
10648268Ssteve.reinhardt@amd.com        print "Error: directory '%s' does not exist" % bdir
10658268Ssteve.reinhardt@amd.com        Exit(1)
10665742Snate@binkert.org    for root, dirs, files in os.walk(bdir):
10675341Sstever@gmail.com        if 'SConsopts' in files:
10688474Sgblack@eecs.umich.edu            if GetOption('verbose'):
10698474Sgblack@eecs.umich.edu                print "Reading", joinpath(root, 'SConsopts')
10705342Sstever@gmail.com            SConscript(joinpath(root, 'SConsopts'))
10714202Sbinkertn@umich.edu
10724202Sbinkertn@umich.eduall_isa_list.sort()
10734202Sbinkertn@umich.edu
10745863Snate@binkert.orgsticky_vars.AddVariables(
10755863Snate@binkert.org    EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list),
10766994Snate@binkert.org    ListVariable('CPU_MODELS', 'CPU models',
10776994Snate@binkert.org                 sorted(n for n,m in CpuModel.dict.iteritems() if m.default),
10786994Snate@binkert.org                 sorted(CpuModel.list)),
10795863Snate@binkert.org    BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
10805863Snate@binkert.org                 False),
10815863Snate@binkert.org    BoolVariable('SS_COMPATIBLE_FP',
10825863Snate@binkert.org                 'Make floating-point results compatible with SimpleScalar',
10835863Snate@binkert.org                 False),
10845863Snate@binkert.org    BoolVariable('USE_SSE2',
10855863Snate@binkert.org                 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
10865863Snate@binkert.org                 False),
10877840Snate@binkert.org    BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock),
10885863Snate@binkert.org    BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
10895952Ssaidi@eecs.umich.edu    BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False),
10909651SAndreas.Sandberg@ARM.com    BoolVariable('USE_KVM', 'Enable hardware virtualized (KVM) CPU models', have_kvm),
10919219Spower.jg@gmail.com    EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None',
10929219Spower.jg@gmail.com                  all_protocols),
10931869SN/A    )
10941858SN/A
10955863Snate@binkert.org# These variables get exported to #defines in config/*.hh (see src/SConscript).
10969420Sandreas.hansson@arm.comexport_vars += ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'CP_ANNOTATE',
10979986Sandreas@sandberg.pp.se                'USE_POSIX_CLOCK', 'PROTOCOL', 'HAVE_PROTOBUF',
10989986Sandreas@sandberg.pp.se                'HAVE_PERF_ATTR_EXCLUDE_HOST']
10991858SN/A
1100955SN/A###################################################
1101955SN/A#
11021869SN/A# Define a SCons builder for configuration flag headers.
11031869SN/A#
11041869SN/A###################################################
11051869SN/A
11061869SN/A# This function generates a config header file that #defines the
11075863Snate@binkert.org# variable symbol to the current variable setting (0 or 1).  The source
11085863Snate@binkert.org# operands are the name of the variable and a Value node containing the
11095863Snate@binkert.org# value of the variable.
11101869SN/Adef build_config_file(target, source, env):
11115863Snate@binkert.org    (variable, value) = [s.get_contents() for s in source]
11121869SN/A    f = file(str(target[0]), 'w')
11135863Snate@binkert.org    print >> f, '#define', variable, value
11141869SN/A    f.close()
11151869SN/A    return None
11161869SN/A
11171869SN/A# Combine the two functions into a scons Action object.
11188483Sgblack@eecs.umich.educonfig_action = MakeAction(build_config_file, Transform("CONFIG H", 2))
11191869SN/A
11201869SN/A# The emitter munges the source & target node lists to reflect what
11211869SN/A# we're really doing.
11221869SN/Adef config_emitter(target, source, env):
11235863Snate@binkert.org    # extract variable name from Builder arg
11245863Snate@binkert.org    variable = str(target[0])
11251869SN/A    # True target is config header file
11265863Snate@binkert.org    target = joinpath('config', variable.lower() + '.hh')
11275863Snate@binkert.org    val = env[variable]
11283356Sbinkertn@umich.edu    if isinstance(val, bool):
11293356Sbinkertn@umich.edu        # Force value to 0/1
11303356Sbinkertn@umich.edu        val = int(val)
11313356Sbinkertn@umich.edu    elif isinstance(val, str):
11323356Sbinkertn@umich.edu        val = '"' + val + '"'
11334781Snate@binkert.org
11345863Snate@binkert.org    # Sources are variable name & value (packaged in SCons Value nodes)
11355863Snate@binkert.org    return ([target], [Value(variable), Value(val)])
11361869SN/A
11371869SN/Aconfig_builder = Builder(emitter = config_emitter, action = config_action)
11381869SN/A
11396121Snate@binkert.orgmain.Append(BUILDERS = { 'ConfigFile' : config_builder })
11401869SN/A
11412638Sstever@eecs.umich.edu# libelf build is shared across all configs in the build root.
11426121Snate@binkert.orgmain.SConscript('ext/libelf/SConscript',
11436121Snate@binkert.org                variant_dir = joinpath(build_root, 'libelf'))
11442638Sstever@eecs.umich.edu
11455749Scws3k@cs.virginia.edu# gzstream build is shared across all configs in the build root.
11466121Snate@binkert.orgmain.SConscript('ext/gzstream/SConscript',
11476121Snate@binkert.org                variant_dir = joinpath(build_root, 'gzstream'))
11485749Scws3k@cs.virginia.edu
11499537Satgutier@umich.edu# libfdt build is shared across all configs in the build root.
11509537Satgutier@umich.edumain.SConscript('ext/libfdt/SConscript',
11519537Satgutier@umich.edu                variant_dir = joinpath(build_root, 'libfdt'))
11529537Satgutier@umich.edu
11539888Sandreas@sandberg.pp.se# fputils build is shared across all configs in the build root.
11549888Sandreas@sandberg.pp.semain.SConscript('ext/fputils/SConscript',
11559888Sandreas@sandberg.pp.se                variant_dir = joinpath(build_root, 'fputils'))
11569888Sandreas@sandberg.pp.se
115710066Sandreas.hansson@arm.com# DRAMSim2 build is shared across all configs in the build root.
115810066Sandreas.hansson@arm.commain.SConscript('ext/dramsim2/SConscript',
115910066Sandreas.hansson@arm.com                variant_dir = joinpath(build_root, 'dramsim2'))
116010066Sandreas.hansson@arm.com
11611869SN/A###################################################
11621869SN/A#
11633546Sgblack@eecs.umich.edu# This function is used to set up a directory with switching headers
11643546Sgblack@eecs.umich.edu#
11653546Sgblack@eecs.umich.edu###################################################
11663546Sgblack@eecs.umich.edu
11676121Snate@binkert.orgmain['ALL_ISA_LIST'] = all_isa_list
11685863Snate@binkert.orgdef make_switching_dir(dname, switch_headers, env):
11693546Sgblack@eecs.umich.edu    # Generate the header.  target[0] is the full path of the output
11703546Sgblack@eecs.umich.edu    # header to generate.  'source' is a dummy variable, since we get the
11713546Sgblack@eecs.umich.edu    # list of ISAs from env['ALL_ISA_LIST'].
11723546Sgblack@eecs.umich.edu    def gen_switch_hdr(target, source, env):
11734781Snate@binkert.org        fname = str(target[0])
11744781Snate@binkert.org        f = open(fname, 'w')
11756658Snate@binkert.org        isa = env['TARGET_ISA'].lower()
11766658Snate@binkert.org        print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname))
11774781Snate@binkert.org        f.close()
11783546Sgblack@eecs.umich.edu
11793546Sgblack@eecs.umich.edu    # Build SCons Action object. 'varlist' specifies env vars that this
11803546Sgblack@eecs.umich.edu    # action depends on; when env['ALL_ISA_LIST'] changes these actions
11813546Sgblack@eecs.umich.edu    # should get re-executed.
11827756SAli.Saidi@ARM.com    switch_hdr_action = MakeAction(gen_switch_hdr,
11837816Ssteve.reinhardt@amd.com                          Transform("GENERATE"), varlist=['ALL_ISA_LIST'])
11843546Sgblack@eecs.umich.edu
11853546Sgblack@eecs.umich.edu    # Instantiate actions for each header
11863546Sgblack@eecs.umich.edu    for hdr in switch_headers:
11873546Sgblack@eecs.umich.edu        env.Command(hdr, [], switch_hdr_action)
11884202Sbinkertn@umich.eduExport('make_switching_dir')
11893546Sgblack@eecs.umich.edu
11903546Sgblack@eecs.umich.edu###################################################
11913546Sgblack@eecs.umich.edu#
1192955SN/A# Define build environments for selected configurations.
1193955SN/A#
1194955SN/A###################################################
1195955SN/A
11965863Snate@binkert.orgfor variant_path in variant_paths:
11975863Snate@binkert.org    print "Building in", variant_path
11985343Sstever@gmail.com
11995343Sstever@gmail.com    # Make a copy of the build-root environment to use for this config.
12006121Snate@binkert.org    env = main.Clone()
12015863Snate@binkert.org    env['BUILDDIR'] = variant_path
12024773Snate@binkert.org
12035863Snate@binkert.org    # variant_dir is the tail component of build path, and is used to
12042632Sstever@eecs.umich.edu    # determine the build parameters (e.g., 'ALPHA_SE')
12055863Snate@binkert.org    (build_root, variant_dir) = splitpath(variant_path)
12062023SN/A
12075863Snate@binkert.org    # Set env variables according to the build directory config.
12085863Snate@binkert.org    sticky_vars.files = []
12095863Snate@binkert.org    # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
12105863Snate@binkert.org    # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
12115863Snate@binkert.org    # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
12125863Snate@binkert.org    current_vars_file = joinpath(build_root, 'variables', variant_dir)
12135863Snate@binkert.org    if isfile(current_vars_file):
12145863Snate@binkert.org        sticky_vars.files.append(current_vars_file)
12155863Snate@binkert.org        print "Using saved variables file %s" % current_vars_file
12162632Sstever@eecs.umich.edu    else:
12175863Snate@binkert.org        # Build dir-specific variables file doesn't exist.
12182023SN/A
12192632Sstever@eecs.umich.edu        # Make sure the directory is there so we can create it later
12205863Snate@binkert.org        opt_dir = dirname(current_vars_file)
12215342Sstever@gmail.com        if not isdir(opt_dir):
12225863Snate@binkert.org            mkdir(opt_dir)
12232632Sstever@eecs.umich.edu
12245863Snate@binkert.org        # Get default build variables from source tree.  Variables are
12255863Snate@binkert.org        # normally determined by name of $VARIANT_DIR, but can be
12268267Ssteve.reinhardt@amd.com        # overridden by '--default=' arg on command line.
12278120Sgblack@eecs.umich.edu        default = GetOption('default')
12288267Ssteve.reinhardt@amd.com        opts_dir = joinpath(main.root.abspath, 'build_opts')
12298267Ssteve.reinhardt@amd.com        if default:
12308267Ssteve.reinhardt@amd.com            default_vars_files = [joinpath(build_root, 'variables', default),
12318267Ssteve.reinhardt@amd.com                                  joinpath(opts_dir, default)]
12328267Ssteve.reinhardt@amd.com        else:
12338267Ssteve.reinhardt@amd.com            default_vars_files = [joinpath(opts_dir, variant_dir)]
12348267Ssteve.reinhardt@amd.com        existing_files = filter(isfile, default_vars_files)
12358267Ssteve.reinhardt@amd.com        if existing_files:
12368267Ssteve.reinhardt@amd.com            default_vars_file = existing_files[0]
12375863Snate@binkert.org            sticky_vars.files.append(default_vars_file)
12385863Snate@binkert.org            print "Variables file %s not found,\n  using defaults in %s" \
12395863Snate@binkert.org                  % (current_vars_file, default_vars_file)
12402632Sstever@eecs.umich.edu        else:
12418267Ssteve.reinhardt@amd.com            print "Error: cannot find variables file %s or " \
12428267Ssteve.reinhardt@amd.com                  "default file(s) %s" \
12438267Ssteve.reinhardt@amd.com                  % (current_vars_file, ' or '.join(default_vars_files))
12442632Sstever@eecs.umich.edu            Exit(1)
12451888SN/A
12465863Snate@binkert.org    # Apply current variable settings to env
12475863Snate@binkert.org    sticky_vars.Update(env)
12481858SN/A
12498120Sgblack@eecs.umich.edu    help_texts["local_vars"] += \
12508120Sgblack@eecs.umich.edu        "Build variables for %s:\n" % variant_dir \
12517756SAli.Saidi@ARM.com                 + sticky_vars.GenerateHelpText(env)
12522598SN/A
12535863Snate@binkert.org    # Process variable settings.
12541858SN/A
12551858SN/A    if not have_fenv and env['USE_FENV']:
12561858SN/A        print "Warning: <fenv.h> not available; " \
12575863Snate@binkert.org              "forcing USE_FENV to False in", variant_dir + "."
12581858SN/A        env['USE_FENV'] = False
12591858SN/A
12601858SN/A    if not env['USE_FENV']:
12615863Snate@binkert.org        print "Warning: No IEEE FP rounding mode control in", variant_dir + "."
12621871SN/A        print "         FP results may deviate slightly from other platforms."
12631858SN/A
12641858SN/A    if env['EFENCE']:
12651858SN/A        env.Append(LIBS=['efence'])
12661858SN/A
12679651SAndreas.Sandberg@ARM.com    if env['USE_KVM']:
12689651SAndreas.Sandberg@ARM.com        if not have_kvm:
12699651SAndreas.Sandberg@ARM.com            print "Warning: Can not enable KVM, host seems to lack KVM support"
12709651SAndreas.Sandberg@ARM.com            env['USE_KVM'] = False
12719900Sandreas@sandberg.pp.se        elif not have_posix_timers:
12729900Sandreas@sandberg.pp.se            print "Warning: Can not enable KVM, host seems to lack support " \
12739900Sandreas@sandberg.pp.se                "for POSIX timers"
12749900Sandreas@sandberg.pp.se            env['USE_KVM'] = False
12759651SAndreas.Sandberg@ARM.com        elif not is_isa_kvm_compatible(env['TARGET_ISA']):
12769651SAndreas.Sandberg@ARM.com            print "Info: KVM support disabled due to unsupported host and " \
12779651SAndreas.Sandberg@ARM.com                "target ISA combination"
12789651SAndreas.Sandberg@ARM.com            env['USE_KVM'] = False
12799651SAndreas.Sandberg@ARM.com
12809986Sandreas@sandberg.pp.se    # Warn about missing optional functionality
12819986Sandreas@sandberg.pp.se    if env['USE_KVM']:
12829986Sandreas@sandberg.pp.se        if not main['HAVE_PERF_ATTR_EXCLUDE_HOST']:
12839986Sandreas@sandberg.pp.se            print "Warning: perf_event headers lack support for the " \
12849986Sandreas@sandberg.pp.se                "exclude_host attribute. KVM instruction counts will " \
12859986Sandreas@sandberg.pp.se                "be inaccurate."
12869986Sandreas@sandberg.pp.se
12875863Snate@binkert.org    # Save sticky variable settings back to current variables file
12885863Snate@binkert.org    sticky_vars.Save(current_vars_file, env)
12891869SN/A
12901965SN/A    if env['USE_SSE2']:
12917739Sgblack@eecs.umich.edu        env.Append(CCFLAGS=['-msse2'])
12921965SN/A
12932761Sstever@eecs.umich.edu    # The src/SConscript file sets up the build rules in 'env' according
12945863Snate@binkert.org    # to the configured variables.  It returns a list of environments,
12951869SN/A    # one for each variant build (debug, opt, etc.)
12965863Snate@binkert.org    envList = SConscript('src/SConscript', variant_dir = variant_path,
12972667Sstever@eecs.umich.edu                         exports = 'env')
12981869SN/A
12991869SN/A    # Set up the regression tests for each build.
13002929Sktlim@umich.edu    for e in envList:
13012929Sktlim@umich.edu        SConscript('tests/SConscript',
13025863Snate@binkert.org                   variant_dir = joinpath(variant_path, 'tests', e.Label),
13032929Sktlim@umich.edu                   exports = { 'env' : e }, duplicate = False)
1304955SN/A
13058120Sgblack@eecs.umich.edu# base help text
13068120Sgblack@eecs.umich.eduHelp('''
13078120Sgblack@eecs.umich.eduUsage: scons [scons options] [build variables] [target(s)]
13088120Sgblack@eecs.umich.edu
13098120Sgblack@eecs.umich.eduExtra scons options:
13108120Sgblack@eecs.umich.edu%(options)s
13118120Sgblack@eecs.umich.edu
13128120Sgblack@eecs.umich.eduGlobal build variables:
13138120Sgblack@eecs.umich.edu%(global_vars)s
13148120Sgblack@eecs.umich.edu
13158120Sgblack@eecs.umich.edu%(local_vars)s
13168120Sgblack@eecs.umich.edu''' % help_texts)
1317