SConstruct revision 9239
1955SN/A# -*- mode:python -*-
2955SN/A
37816Ssteve.reinhardt@amd.com# Copyright (c) 2011 Advanced Micro Devices, Inc.
45871Snate@binkert.org# Copyright (c) 2009 The Hewlett-Packard Development Company
51762SN/A# Copyright (c) 2004-2005 The Regents of The University of Michigan
6955SN/A# All rights reserved.
7955SN/A#
8955SN/A# Redistribution and use in source and binary forms, with or without
9955SN/A# modification, are permitted provided that the following conditions are
10955SN/A# met: redistributions of source code must retain the above copyright
11955SN/A# notice, this list of conditions and the following disclaimer;
12955SN/A# redistributions in binary form must reproduce the above copyright
13955SN/A# notice, this list of conditions and the following disclaimer in the
14955SN/A# documentation and/or other materials provided with the distribution;
15955SN/A# neither the name of the copyright holders nor the names of its
16955SN/A# contributors may be used to endorse or promote products derived from
17955SN/A# this software without specific prior written permission.
18955SN/A#
19955SN/A# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20955SN/A# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21955SN/A# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22955SN/A# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23955SN/A# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24955SN/A# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25955SN/A# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26955SN/A# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27955SN/A# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28955SN/A# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29955SN/A# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
302665Ssaidi@eecs.umich.edu#
312665Ssaidi@eecs.umich.edu# Authors: Steve Reinhardt
325863Snate@binkert.org#          Nathan Binkert
33955SN/A
34955SN/A###################################################
35955SN/A#
36955SN/A# SCons top-level build description (SConstruct) file.
37955SN/A#
388878Ssteve.reinhardt@amd.com# While in this directory ('gem5'), just type 'scons' to build the default
392632Sstever@eecs.umich.edu# configuration (see below), or type 'scons build/<CONFIG>/<binary>'
408878Ssteve.reinhardt@amd.com# to build some other configuration (e.g., 'build/ALPHA/gem5.opt' for
412632Sstever@eecs.umich.edu# the optimized full-system version).
42955SN/A#
438878Ssteve.reinhardt@amd.com# You can build gem5 in a different directory as long as there is a
442632Sstever@eecs.umich.edu# 'build/<CONFIG>' somewhere along the target path.  The build system
452761Sstever@eecs.umich.edu# expects that all configs under the same build directory are being
462632Sstever@eecs.umich.edu# built for the same host system.
472632Sstever@eecs.umich.edu#
482632Sstever@eecs.umich.edu# Examples:
492761Sstever@eecs.umich.edu#
502761Sstever@eecs.umich.edu#   The following two commands are equivalent.  The '-u' option tells
512761Sstever@eecs.umich.edu#   scons to search up the directory tree for this SConstruct file.
528878Ssteve.reinhardt@amd.com#   % cd <path-to-src>/gem5 ; scons build/ALPHA/gem5.debug
538878Ssteve.reinhardt@amd.com#   % cd <path-to-src>/gem5/build/ALPHA; scons -u gem5.debug
542761Sstever@eecs.umich.edu#
552761Sstever@eecs.umich.edu#   The following two commands are equivalent and demonstrate building
562761Sstever@eecs.umich.edu#   in a directory outside of the source tree.  The '-C' option tells
572761Sstever@eecs.umich.edu#   scons to chdir to the specified directory to find this SConstruct
582761Sstever@eecs.umich.edu#   file.
598878Ssteve.reinhardt@amd.com#   % cd <path-to-src>/gem5 ; scons /local/foo/build/ALPHA/gem5.debug
608878Ssteve.reinhardt@amd.com#   % cd /local/foo/build/ALPHA; scons -C <path-to-src>/gem5 gem5.debug
612632Sstever@eecs.umich.edu#
622632Sstever@eecs.umich.edu# You can use 'scons -H' to print scons options.  If you're in this
638878Ssteve.reinhardt@amd.com# 'gem5' directory (or use -u or -C to tell scons where to find this
648878Ssteve.reinhardt@amd.com# file), you can use 'scons -h' to print all the gem5-specific build
652632Sstever@eecs.umich.edu# options as well.
66955SN/A#
67955SN/A###################################################
68955SN/A
695863Snate@binkert.org# Check for recent-enough Python and SCons versions.
705863Snate@binkert.orgtry:
715863Snate@binkert.org    # Really old versions of scons only take two options for the
725863Snate@binkert.org    # function, so check once without the revision and once with the
735863Snate@binkert.org    # revision, the first instance will fail for stuff other than
745863Snate@binkert.org    # 0.98, and the second will fail for 0.98.0
755863Snate@binkert.org    EnsureSConsVersion(0, 98)
765863Snate@binkert.org    EnsureSConsVersion(0, 98, 1)
775863Snate@binkert.orgexcept SystemExit, e:
785863Snate@binkert.org    print """
795863Snate@binkert.orgFor more details, see:
808878Ssteve.reinhardt@amd.com    http://gem5.org/Dependencies
815863Snate@binkert.org"""
825863Snate@binkert.org    raise
835863Snate@binkert.org
845863Snate@binkert.org# We ensure the python version early because we have stuff that
855863Snate@binkert.org# requires python 2.4
865863Snate@binkert.orgtry:
875863Snate@binkert.org    EnsurePythonVersion(2, 4)
885863Snate@binkert.orgexcept SystemExit, e:
895863Snate@binkert.org    print """
905863Snate@binkert.orgYou can use a non-default installation of the Python interpreter by
915863Snate@binkert.orgeither (1) rearranging your PATH so that scons finds the non-default
925863Snate@binkert.org'python' first or (2) explicitly invoking an alternative interpreter
935863Snate@binkert.orgon the scons script.
945863Snate@binkert.org
955863Snate@binkert.orgFor more details, see:
968878Ssteve.reinhardt@amd.com    http://gem5.org/wiki/index.php/Using_a_non-default_Python_installation
975863Snate@binkert.org"""
985863Snate@binkert.org    raise
995863Snate@binkert.org
1006654Snate@binkert.org# Global Python includes
101955SN/Aimport os
1025396Ssaidi@eecs.umich.eduimport re
1035863Snate@binkert.orgimport subprocess
1045863Snate@binkert.orgimport sys
1054202Sbinkertn@umich.edu
1065863Snate@binkert.orgfrom os import mkdir, environ
1075863Snate@binkert.orgfrom os.path import abspath, basename, dirname, expanduser, normpath
1085863Snate@binkert.orgfrom os.path import exists,  isdir, isfile
1095863Snate@binkert.orgfrom os.path import join as joinpath, split as splitpath
110955SN/A
1116654Snate@binkert.org# SCons includes
1125273Sstever@gmail.comimport SCons
1135871Snate@binkert.orgimport SCons.Node
1145273Sstever@gmail.com
1156655Snate@binkert.orgextra_python_paths = [
1168878Ssteve.reinhardt@amd.com    Dir('src/python').srcnode().abspath, # gem5 includes
1176655Snate@binkert.org    Dir('ext/ply').srcnode().abspath, # ply is used by several files
1186655Snate@binkert.org    ]
1199219Spower.jg@gmail.com
1206655Snate@binkert.orgsys.path[1:1] = extra_python_paths
1215871Snate@binkert.org
1226654Snate@binkert.orgfrom m5.util import compareVersions, readCommand
1238947Sandreas.hansson@arm.comfrom m5.util.terminal import get_termcap
1245396Ssaidi@eecs.umich.edu
1258120Sgblack@eecs.umich.eduhelp_texts = {
1268120Sgblack@eecs.umich.edu    "options" : "",
1278120Sgblack@eecs.umich.edu    "global_vars" : "",
1288120Sgblack@eecs.umich.edu    "local_vars" : ""
1298120Sgblack@eecs.umich.edu}
1308120Sgblack@eecs.umich.edu
1318120Sgblack@eecs.umich.eduExport("help_texts")
1328120Sgblack@eecs.umich.edu
1338879Ssteve.reinhardt@amd.com
1348879Ssteve.reinhardt@amd.com# There's a bug in scons in that (1) by default, the help texts from
1358879Ssteve.reinhardt@amd.com# AddOption() are supposed to be displayed when you type 'scons -h'
1368879Ssteve.reinhardt@amd.com# and (2) you can override the help displayed by 'scons -h' using the
1378879Ssteve.reinhardt@amd.com# Help() function, but these two features are incompatible: once
1388879Ssteve.reinhardt@amd.com# you've overridden the help text using Help(), there's no way to get
1398879Ssteve.reinhardt@amd.com# at the help texts from AddOptions.  See:
1408879Ssteve.reinhardt@amd.com#     http://scons.tigris.org/issues/show_bug.cgi?id=2356
1418879Ssteve.reinhardt@amd.com#     http://scons.tigris.org/issues/show_bug.cgi?id=2611
1428879Ssteve.reinhardt@amd.com# This hack lets us extract the help text from AddOptions and
1438879Ssteve.reinhardt@amd.com# re-inject it via Help().  Ideally someday this bug will be fixed and
1448879Ssteve.reinhardt@amd.com# we can just use AddOption directly.
1458879Ssteve.reinhardt@amd.comdef AddLocalOption(*args, **kwargs):
1468120Sgblack@eecs.umich.edu    col_width = 30
1478120Sgblack@eecs.umich.edu
1488120Sgblack@eecs.umich.edu    help = "  " + ", ".join(args)
1498120Sgblack@eecs.umich.edu    if "help" in kwargs:
1508120Sgblack@eecs.umich.edu        length = len(help)
1518120Sgblack@eecs.umich.edu        if length >= col_width:
1528120Sgblack@eecs.umich.edu            help += "\n" + " " * col_width
1538120Sgblack@eecs.umich.edu        else:
1548120Sgblack@eecs.umich.edu            help += " " * (col_width - length)
1558120Sgblack@eecs.umich.edu        help += kwargs["help"]
1568120Sgblack@eecs.umich.edu    help_texts["options"] += help + "\n"
1578120Sgblack@eecs.umich.edu
1588120Sgblack@eecs.umich.edu    AddOption(*args, **kwargs)
1598120Sgblack@eecs.umich.edu
1608879Ssteve.reinhardt@amd.comAddLocalOption('--colors', dest='use_colors', action='store_true',
1618879Ssteve.reinhardt@amd.com               help="Add color to abbreviated scons output")
1628879Ssteve.reinhardt@amd.comAddLocalOption('--no-colors', dest='use_colors', action='store_false',
1638879Ssteve.reinhardt@amd.com               help="Don't add color to abbreviated scons output")
1648879Ssteve.reinhardt@amd.comAddLocalOption('--default', dest='default', type='string', action='store',
1658879Ssteve.reinhardt@amd.com               help='Override which build_opts file to use for defaults')
1668879Ssteve.reinhardt@amd.comAddLocalOption('--ignore-style', dest='ignore_style', action='store_true',
1678879Ssteve.reinhardt@amd.com               help='Disable style checking hooks')
1689227Sandreas.hansson@arm.comAddLocalOption('--no-lto', dest='no_lto', action='store_true',
1699227Sandreas.hansson@arm.com               help='Disable Link-Time Optimization for fast')
1708879Ssteve.reinhardt@amd.comAddLocalOption('--update-ref', dest='update_ref', action='store_true',
1718879Ssteve.reinhardt@amd.com               help='Update test reference outputs')
1728879Ssteve.reinhardt@amd.comAddLocalOption('--verbose', dest='verbose', action='store_true',
1738879Ssteve.reinhardt@amd.com               help='Print full tool command lines')
1748120Sgblack@eecs.umich.edu
1758947Sandreas.hansson@arm.comtermcap = get_termcap(GetOption('use_colors'))
1767816Ssteve.reinhardt@amd.com
1775871Snate@binkert.org########################################################################
1785871Snate@binkert.org#
1796121Snate@binkert.org# Set up the main build environment.
1805871Snate@binkert.org#
1815871Snate@binkert.org########################################################################
1829119Sandreas.hansson@arm.comuse_vars = set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH',
1839119Sandreas.hansson@arm.com                 'LIBRARY_PATH', 'PATH', 'PYTHONPATH', 'RANLIB', 'SWIG' ])
184955SN/A
1855871Snate@binkert.orguse_env = {}
1865871Snate@binkert.orgfor key,val in os.environ.iteritems():
1875871Snate@binkert.org    if key in use_vars or key.startswith("M5"):
1885871Snate@binkert.org        use_env[key] = val
189955SN/A
1906121Snate@binkert.orgmain = Environment(ENV=use_env)
1918881Smarc.orr@gmail.commain.Decider('MD5-timestamp')
1926121Snate@binkert.orgmain.root = Dir(".")         # The current directory (where this file lives).
1936121Snate@binkert.orgmain.srcdir = Dir("src")     # The source directory
1941533SN/A
1959239Sandreas.hansson@arm.commain_dict_keys = main.Dictionary().keys()
1969239Sandreas.hansson@arm.com
1979239Sandreas.hansson@arm.com# Check that we have a C/C++ compiler
1989239Sandreas.hansson@arm.comif not ('CC' in main_dict_keys and 'CXX' in main_dict_keys):
1999239Sandreas.hansson@arm.com    print "No C++ compiler installed (package g++ on Ubuntu and RedHat)"
2009239Sandreas.hansson@arm.com    Exit(1)
2019239Sandreas.hansson@arm.com
2029239Sandreas.hansson@arm.com# Check that swig is present
2039239Sandreas.hansson@arm.comif not 'SWIG' in main_dict_keys:
2049239Sandreas.hansson@arm.com    print "swig is not installed (package swig on Ubuntu and RedHat)"
2059239Sandreas.hansson@arm.com    Exit(1)
2069239Sandreas.hansson@arm.com
2076655Snate@binkert.org# add useful python code PYTHONPATH so it can be used by subprocesses
2086655Snate@binkert.org# as well
2096655Snate@binkert.orgmain.AppendENVPath('PYTHONPATH', extra_python_paths)
2106655Snate@binkert.org
2115871Snate@binkert.org########################################################################
2125871Snate@binkert.org#
2135863Snate@binkert.org# Mercurial Stuff.
2145871Snate@binkert.org#
2158878Ssteve.reinhardt@amd.com# If the gem5 directory is a mercurial repository, we should do some
2165871Snate@binkert.org# extra things.
2175871Snate@binkert.org#
2185871Snate@binkert.org########################################################################
2195863Snate@binkert.org
2206121Snate@binkert.orghgdir = main.root.Dir(".hg")
2215863Snate@binkert.org
2225871Snate@binkert.orgmercurial_style_message = """
2238336Ssteve.reinhardt@amd.comYou're missing the gem5 style hook, which automatically checks your code
2248336Ssteve.reinhardt@amd.comagainst the gem5 style rules on hg commit and qrefresh commands.  This
2258336Ssteve.reinhardt@amd.comscript will now install the hook in your .hg/hgrc file.
2268336Ssteve.reinhardt@amd.comPress enter to continue, or ctrl-c to abort: """
2274678Snate@binkert.org
2288336Ssteve.reinhardt@amd.commercurial_style_hook = """
2298336Ssteve.reinhardt@amd.com# The following lines were automatically added by gem5/SConstruct
2308336Ssteve.reinhardt@amd.com# to provide the gem5 style-checking hooks
2314678Snate@binkert.org[extensions]
2324678Snate@binkert.orgstyle = %s/util/style.py
2334678Snate@binkert.org
2344678Snate@binkert.org[hooks]
2357827Snate@binkert.orgpretxncommit.style = python:style.check_style
2367827Snate@binkert.orgpre-qrefresh.style = python:style.check_style
2378336Ssteve.reinhardt@amd.com# End of SConstruct additions
2384678Snate@binkert.org
2398336Ssteve.reinhardt@amd.com""" % (main.root.abspath)
2408336Ssteve.reinhardt@amd.com
2418336Ssteve.reinhardt@amd.commercurial_lib_not_found = """
2428336Ssteve.reinhardt@amd.comMercurial libraries cannot be found, ignoring style hook.  If
2438336Ssteve.reinhardt@amd.comyou are a gem5 developer, please fix this and run the style
2448336Ssteve.reinhardt@amd.comhook. It is important.
2455871Snate@binkert.org"""
2465871Snate@binkert.org
2478336Ssteve.reinhardt@amd.com# Check for style hook and prompt for installation if it's not there.
2488336Ssteve.reinhardt@amd.com# Skip this if --ignore-style was specified, there's no .hg dir to
2498336Ssteve.reinhardt@amd.com# install a hook in, or there's no interactive terminal to prompt.
2508336Ssteve.reinhardt@amd.comif not GetOption('ignore_style') and hgdir.exists() and sys.stdin.isatty():
2518336Ssteve.reinhardt@amd.com    style_hook = True
2525871Snate@binkert.org    try:
2538336Ssteve.reinhardt@amd.com        from mercurial import ui
2548336Ssteve.reinhardt@amd.com        ui = ui.ui()
2558336Ssteve.reinhardt@amd.com        ui.readconfig(hgdir.File('hgrc').abspath)
2568336Ssteve.reinhardt@amd.com        style_hook = ui.config('hooks', 'pretxncommit.style', None) and \
2578336Ssteve.reinhardt@amd.com                     ui.config('hooks', 'pre-qrefresh.style', None)
2584678Snate@binkert.org    except ImportError:
2595871Snate@binkert.org        print mercurial_lib_not_found
2604678Snate@binkert.org
2618336Ssteve.reinhardt@amd.com    if not style_hook:
2628336Ssteve.reinhardt@amd.com        print mercurial_style_message,
2638336Ssteve.reinhardt@amd.com        # continue unless user does ctrl-c/ctrl-d etc.
2648336Ssteve.reinhardt@amd.com        try:
2658336Ssteve.reinhardt@amd.com            raw_input()
2668336Ssteve.reinhardt@amd.com        except:
2678336Ssteve.reinhardt@amd.com            print "Input exception, exiting scons.\n"
2688336Ssteve.reinhardt@amd.com            sys.exit(1)
2698336Ssteve.reinhardt@amd.com        hgrc_path = '%s/.hg/hgrc' % main.root.abspath
2708336Ssteve.reinhardt@amd.com        print "Adding style hook to", hgrc_path, "\n"
2718336Ssteve.reinhardt@amd.com        try:
2728336Ssteve.reinhardt@amd.com            hgrc = open(hgrc_path, 'a')
2738336Ssteve.reinhardt@amd.com            hgrc.write(mercurial_style_hook)
2748336Ssteve.reinhardt@amd.com            hgrc.close()
2758336Ssteve.reinhardt@amd.com        except:
2768336Ssteve.reinhardt@amd.com            print "Error updating", hgrc_path
2778336Ssteve.reinhardt@amd.com            sys.exit(1)
2785871Snate@binkert.org
2796121Snate@binkert.org
280955SN/A###################################################
281955SN/A#
2822632Sstever@eecs.umich.edu# Figure out which configurations to set up based on the path(s) of
2832632Sstever@eecs.umich.edu# the target(s).
284955SN/A#
285955SN/A###################################################
286955SN/A
287955SN/A# Find default configuration & binary.
2888878Ssteve.reinhardt@amd.comDefault(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug'))
289955SN/A
2902632Sstever@eecs.umich.edu# helper function: find last occurrence of element in list
2912632Sstever@eecs.umich.edudef rfind(l, elt, offs = -1):
2922632Sstever@eecs.umich.edu    for i in range(len(l)+offs, 0, -1):
2932632Sstever@eecs.umich.edu        if l[i] == elt:
2942632Sstever@eecs.umich.edu            return i
2952632Sstever@eecs.umich.edu    raise ValueError, "element not found"
2962632Sstever@eecs.umich.edu
2978268Ssteve.reinhardt@amd.com# Take a list of paths (or SCons Nodes) and return a list with all
2988268Ssteve.reinhardt@amd.com# paths made absolute and ~-expanded.  Paths will be interpreted
2998268Ssteve.reinhardt@amd.com# relative to the launch directory unless a different root is provided
3008268Ssteve.reinhardt@amd.comdef makePathListAbsolute(path_list, root=GetLaunchDir()):
3018268Ssteve.reinhardt@amd.com    return [abspath(joinpath(root, expanduser(str(p))))
3028268Ssteve.reinhardt@amd.com            for p in path_list]
3038268Ssteve.reinhardt@amd.com
3042632Sstever@eecs.umich.edu# Each target must have 'build' in the interior of the path; the
3052632Sstever@eecs.umich.edu# directory below this will determine the build parameters.  For
3062632Sstever@eecs.umich.edu# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
3072632Sstever@eecs.umich.edu# recognize that ALPHA_SE specifies the configuration because it
3088268Ssteve.reinhardt@amd.com# follow 'build' in the build path.
3092632Sstever@eecs.umich.edu
3108268Ssteve.reinhardt@amd.com# The funky assignment to "[:]" is needed to replace the list contents
3118268Ssteve.reinhardt@amd.com# in place rather than reassign the symbol to a new list, which
3128268Ssteve.reinhardt@amd.com# doesn't work (obviously!).
3138268Ssteve.reinhardt@amd.comBUILD_TARGETS[:] = makePathListAbsolute(BUILD_TARGETS)
3143718Sstever@eecs.umich.edu
3152634Sstever@eecs.umich.edu# Generate a list of the unique build roots and configs that the
3162634Sstever@eecs.umich.edu# collected targets reference.
3175863Snate@binkert.orgvariant_paths = []
3182638Sstever@eecs.umich.edubuild_root = None
3198268Ssteve.reinhardt@amd.comfor t in BUILD_TARGETS:
3202632Sstever@eecs.umich.edu    path_dirs = t.split('/')
3212632Sstever@eecs.umich.edu    try:
3222632Sstever@eecs.umich.edu        build_top = rfind(path_dirs, 'build', -2)
3232632Sstever@eecs.umich.edu    except:
3242632Sstever@eecs.umich.edu        print "Error: no non-leaf 'build' dir found on target path", t
3251858SN/A        Exit(1)
3263716Sstever@eecs.umich.edu    this_build_root = joinpath('/',*path_dirs[:build_top+1])
3272638Sstever@eecs.umich.edu    if not build_root:
3282638Sstever@eecs.umich.edu        build_root = this_build_root
3292638Sstever@eecs.umich.edu    else:
3302638Sstever@eecs.umich.edu        if this_build_root != build_root:
3312638Sstever@eecs.umich.edu            print "Error: build targets not under same build root\n"\
3322638Sstever@eecs.umich.edu                  "  %s\n  %s" % (build_root, this_build_root)
3332638Sstever@eecs.umich.edu            Exit(1)
3345863Snate@binkert.org    variant_path = joinpath('/',*path_dirs[:build_top+2])
3355863Snate@binkert.org    if variant_path not in variant_paths:
3365863Snate@binkert.org        variant_paths.append(variant_path)
337955SN/A
3385341Sstever@gmail.com# Make sure build_root exists (might not if this is the first build there)
3395341Sstever@gmail.comif not isdir(build_root):
3405863Snate@binkert.org    mkdir(build_root)
3417756SAli.Saidi@ARM.commain['BUILDROOT'] = build_root
3425341Sstever@gmail.com
3436121Snate@binkert.orgExport('main')
3444494Ssaidi@eecs.umich.edu
3456121Snate@binkert.orgmain.SConsignFile(joinpath(build_root, "sconsign"))
3461105SN/A
3472667Sstever@eecs.umich.edu# Default duplicate option is to use hard links, but this messes up
3482667Sstever@eecs.umich.edu# when you use emacs to edit a file in the target dir, as emacs moves
3492667Sstever@eecs.umich.edu# file to file~ then copies to file, breaking the link.  Symbolic
3502667Sstever@eecs.umich.edu# (soft) links work better.
3516121Snate@binkert.orgmain.SetOption('duplicate', 'soft-copy')
3522667Sstever@eecs.umich.edu
3535341Sstever@gmail.com#
3545863Snate@binkert.org# Set up global sticky variables... these are common to an entire build
3555341Sstever@gmail.com# tree (not specific to a particular build like ALPHA_SE)
3565341Sstever@gmail.com#
3575341Sstever@gmail.com
3588120Sgblack@eecs.umich.eduglobal_vars_file = joinpath(build_root, 'variables.global')
3595341Sstever@gmail.com
3608120Sgblack@eecs.umich.eduglobal_vars = Variables(global_vars_file, args=ARGUMENTS)
3615341Sstever@gmail.com
3628120Sgblack@eecs.umich.eduglobal_vars.AddVariables(
3636121Snate@binkert.org    ('CC', 'C compiler', environ.get('CC', main['CC'])),
3646121Snate@binkert.org    ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])),
3658980Ssteve.reinhardt@amd.com    ('SWIG', 'SWIG tool', environ.get('SWIG', main['SWIG'])),
3665397Ssaidi@eecs.umich.edu    ('BATCH', 'Use batch pool for build and tests', False),
3675397Ssaidi@eecs.umich.edu    ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
3687727SAli.Saidi@ARM.com    ('M5_BUILD_CACHE', 'Cache built objects in this directory', False),
3698268Ssteve.reinhardt@amd.com    ('EXTRAS', 'Add extra directories to the compilation', '')
3706168Snate@binkert.org    )
3715341Sstever@gmail.com
3728120Sgblack@eecs.umich.edu# Update main environment with values from ARGUMENTS & global_vars_file
3738120Sgblack@eecs.umich.eduglobal_vars.Update(main)
3748120Sgblack@eecs.umich.eduhelp_texts["global_vars"] += global_vars.GenerateHelpText(main)
3756814Sgblack@eecs.umich.edu
3765863Snate@binkert.org# Save sticky variable settings back to current variables file
3778120Sgblack@eecs.umich.eduglobal_vars.Save(global_vars_file, main)
3785341Sstever@gmail.com
3795863Snate@binkert.org# Parse EXTRAS variable to build list of all directories where we're
3808268Ssteve.reinhardt@amd.com# look for sources etc.  This list is exported as extras_dir_list.
3816121Snate@binkert.orgbase_dir = main.srcdir.abspath
3826121Snate@binkert.orgif main['EXTRAS']:
3838268Ssteve.reinhardt@amd.com    extras_dir_list = makePathListAbsolute(main['EXTRAS'].split(':'))
3845742Snate@binkert.orgelse:
3855742Snate@binkert.org    extras_dir_list = []
3865341Sstever@gmail.com
3875742Snate@binkert.orgExport('base_dir')
3885742Snate@binkert.orgExport('extras_dir_list')
3895341Sstever@gmail.com
3906017Snate@binkert.org# the ext directory should be on the #includes path
3916121Snate@binkert.orgmain.Append(CPPPATH=[Dir('ext')])
3926017Snate@binkert.org
3937816Ssteve.reinhardt@amd.comdef strip_build_path(path, env):
3947756SAli.Saidi@ARM.com    path = str(path)
3957756SAli.Saidi@ARM.com    variant_base = env['BUILDROOT'] + os.path.sep
3967756SAli.Saidi@ARM.com    if path.startswith(variant_base):
3977756SAli.Saidi@ARM.com        path = path[len(variant_base):]
3987756SAli.Saidi@ARM.com    elif path.startswith('build/'):
3997756SAli.Saidi@ARM.com        path = path[6:]
4007756SAli.Saidi@ARM.com    return path
4017756SAli.Saidi@ARM.com
4027816Ssteve.reinhardt@amd.com# Generate a string of the form:
4037816Ssteve.reinhardt@amd.com#   common/path/prefix/src1, src2 -> tgt1, tgt2
4047816Ssteve.reinhardt@amd.com# to print while building.
4057816Ssteve.reinhardt@amd.comclass Transform(object):
4067816Ssteve.reinhardt@amd.com    # all specific color settings should be here and nowhere else
4077816Ssteve.reinhardt@amd.com    tool_color = termcap.Normal
4087816Ssteve.reinhardt@amd.com    pfx_color = termcap.Yellow
4097816Ssteve.reinhardt@amd.com    srcs_color = termcap.Yellow + termcap.Bold
4107816Ssteve.reinhardt@amd.com    arrow_color = termcap.Blue + termcap.Bold
4117816Ssteve.reinhardt@amd.com    tgts_color = termcap.Yellow + termcap.Bold
4127756SAli.Saidi@ARM.com
4137816Ssteve.reinhardt@amd.com    def __init__(self, tool, max_sources=99):
4147816Ssteve.reinhardt@amd.com        self.format = self.tool_color + (" [%8s] " % tool) \
4157816Ssteve.reinhardt@amd.com                      + self.pfx_color + "%s" \
4167816Ssteve.reinhardt@amd.com                      + self.srcs_color + "%s" \
4177816Ssteve.reinhardt@amd.com                      + self.arrow_color + " -> " \
4187816Ssteve.reinhardt@amd.com                      + self.tgts_color + "%s" \
4197816Ssteve.reinhardt@amd.com                      + termcap.Normal
4207816Ssteve.reinhardt@amd.com        self.max_sources = max_sources
4217816Ssteve.reinhardt@amd.com
4227816Ssteve.reinhardt@amd.com    def __call__(self, target, source, env, for_signature=None):
4237816Ssteve.reinhardt@amd.com        # truncate source list according to max_sources param
4247816Ssteve.reinhardt@amd.com        source = source[0:self.max_sources]
4257816Ssteve.reinhardt@amd.com        def strip(f):
4267816Ssteve.reinhardt@amd.com            return strip_build_path(str(f), env)
4277816Ssteve.reinhardt@amd.com        if len(source) > 0:
4287816Ssteve.reinhardt@amd.com            srcs = map(strip, source)
4297816Ssteve.reinhardt@amd.com        else:
4307816Ssteve.reinhardt@amd.com            srcs = ['']
4317816Ssteve.reinhardt@amd.com        tgts = map(strip, target)
4327816Ssteve.reinhardt@amd.com        # surprisingly, os.path.commonprefix is a dumb char-by-char string
4337816Ssteve.reinhardt@amd.com        # operation that has nothing to do with paths.
4347816Ssteve.reinhardt@amd.com        com_pfx = os.path.commonprefix(srcs + tgts)
4357816Ssteve.reinhardt@amd.com        com_pfx_len = len(com_pfx)
4367816Ssteve.reinhardt@amd.com        if com_pfx:
4377816Ssteve.reinhardt@amd.com            # do some cleanup and sanity checking on common prefix
4387816Ssteve.reinhardt@amd.com            if com_pfx[-1] == ".":
4397816Ssteve.reinhardt@amd.com                # prefix matches all but file extension: ok
4407816Ssteve.reinhardt@amd.com                # back up one to change 'foo.cc -> o' to 'foo.cc -> .o'
4417816Ssteve.reinhardt@amd.com                com_pfx = com_pfx[0:-1]
4427816Ssteve.reinhardt@amd.com            elif com_pfx[-1] == "/":
4437816Ssteve.reinhardt@amd.com                # common prefix is directory path: OK
4447816Ssteve.reinhardt@amd.com                pass
4457816Ssteve.reinhardt@amd.com            else:
4467816Ssteve.reinhardt@amd.com                src0_len = len(srcs[0])
4477816Ssteve.reinhardt@amd.com                tgt0_len = len(tgts[0])
4487816Ssteve.reinhardt@amd.com                if src0_len == com_pfx_len:
4497816Ssteve.reinhardt@amd.com                    # source is a substring of target, OK
4507816Ssteve.reinhardt@amd.com                    pass
4517816Ssteve.reinhardt@amd.com                elif tgt0_len == com_pfx_len:
4527816Ssteve.reinhardt@amd.com                    # target is a substring of source, need to back up to
4537816Ssteve.reinhardt@amd.com                    # avoid empty string on RHS of arrow
4547816Ssteve.reinhardt@amd.com                    sep_idx = com_pfx.rfind(".")
4557816Ssteve.reinhardt@amd.com                    if sep_idx != -1:
4567816Ssteve.reinhardt@amd.com                        com_pfx = com_pfx[0:sep_idx]
4577816Ssteve.reinhardt@amd.com                    else:
4587816Ssteve.reinhardt@amd.com                        com_pfx = ''
4597816Ssteve.reinhardt@amd.com                elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".":
4607816Ssteve.reinhardt@amd.com                    # still splitting at file extension: ok
4617816Ssteve.reinhardt@amd.com                    pass
4627816Ssteve.reinhardt@amd.com                else:
4637816Ssteve.reinhardt@amd.com                    # probably a fluke; ignore it
4647816Ssteve.reinhardt@amd.com                    com_pfx = ''
4657816Ssteve.reinhardt@amd.com        # recalculate length in case com_pfx was modified
4667816Ssteve.reinhardt@amd.com        com_pfx_len = len(com_pfx)
4677816Ssteve.reinhardt@amd.com        def fmt(files):
4687816Ssteve.reinhardt@amd.com            f = map(lambda s: s[com_pfx_len:], files)
4697816Ssteve.reinhardt@amd.com            return ', '.join(f)
4707816Ssteve.reinhardt@amd.com        return self.format % (com_pfx, fmt(srcs), fmt(tgts))
4717816Ssteve.reinhardt@amd.com
4727816Ssteve.reinhardt@amd.comExport('Transform')
4737816Ssteve.reinhardt@amd.com
4748947Sandreas.hansson@arm.com# enable the regression script to use the termcap
4758947Sandreas.hansson@arm.commain['TERMCAP'] = termcap
4767756SAli.Saidi@ARM.com
4778120Sgblack@eecs.umich.eduif GetOption('verbose'):
4787756SAli.Saidi@ARM.com    def MakeAction(action, string, *args, **kwargs):
4797756SAli.Saidi@ARM.com        return Action(action, *args, **kwargs)
4807756SAli.Saidi@ARM.comelse:
4817756SAli.Saidi@ARM.com    MakeAction = Action
4827816Ssteve.reinhardt@amd.com    main['CCCOMSTR']        = Transform("CC")
4837816Ssteve.reinhardt@amd.com    main['CXXCOMSTR']       = Transform("CXX")
4847816Ssteve.reinhardt@amd.com    main['ASCOMSTR']        = Transform("AS")
4857816Ssteve.reinhardt@amd.com    main['SWIGCOMSTR']      = Transform("SWIG")
4867816Ssteve.reinhardt@amd.com    main['ARCOMSTR']        = Transform("AR", 0)
4877816Ssteve.reinhardt@amd.com    main['LINKCOMSTR']      = Transform("LINK", 0)
4887816Ssteve.reinhardt@amd.com    main['RANLIBCOMSTR']    = Transform("RANLIB", 0)
4897816Ssteve.reinhardt@amd.com    main['M4COMSTR']        = Transform("M4")
4907816Ssteve.reinhardt@amd.com    main['SHCCCOMSTR']      = Transform("SHCC")
4917816Ssteve.reinhardt@amd.com    main['SHCXXCOMSTR']     = Transform("SHCXX")
4927756SAli.Saidi@ARM.comExport('MakeAction')
4937756SAli.Saidi@ARM.com
4949227Sandreas.hansson@arm.com# Initialize the Link-Time Optimization (LTO) flags
4959227Sandreas.hansson@arm.commain['LTO_CCFLAGS'] = []
4969227Sandreas.hansson@arm.commain['LTO_LDFLAGS'] = []
4979227Sandreas.hansson@arm.com
4986654Snate@binkert.orgCXX_version = readCommand([main['CXX'],'--version'], exception=False)
4996654Snate@binkert.orgCXX_V = readCommand([main['CXX'],'-V'], exception=False)
5005871Snate@binkert.org
5016121Snate@binkert.orgmain['GCC'] = CXX_version and CXX_version.find('g++') >= 0
5026121Snate@binkert.orgmain['SUNCC'] = CXX_V and CXX_V.find('Sun C++') >= 0
5036121Snate@binkert.orgmain['ICC'] = CXX_V and CXX_V.find('Intel') >= 0
5048946Sandreas.hansson@arm.commain['CLANG'] = CXX_version and CXX_version.find('clang') >= 0
5058737Skoansin.tan@gmail.comif main['GCC'] + main['SUNCC'] + main['ICC'] + main['CLANG'] > 1:
5063940Ssaidi@eecs.umich.edu    print 'Error: How can we have two at the same time?'
5073918Ssaidi@eecs.umich.edu    Exit(1)
5083918Ssaidi@eecs.umich.edu
5091858SN/A# Set up default C++ compiler flags
5106121Snate@binkert.orgif main['GCC']:
5117739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=['-pipe'])
5127739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=['-fno-strict-aliasing'])
5136143Snate@binkert.org    main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef'])
5147618SAli.Saidi@arm.com    # Read the GCC version to check for versions with bugs
5157618SAli.Saidi@arm.com    # Note CCVERSION doesn't work here because it is run with the CC
5167618SAli.Saidi@arm.com    # before we override it from the command line
5177618SAli.Saidi@arm.com    gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False)
5188614Sgblack@eecs.umich.edu    main['GCC_VERSION'] = gcc_version
5197618SAli.Saidi@arm.com    if not compareVersions(gcc_version, '4.4.1') or \
5207618SAli.Saidi@arm.com       not compareVersions(gcc_version, '4.4.2'):
5217618SAli.Saidi@arm.com        print 'Info: Tree vectorizer in GCC 4.4.1 & 4.4.2 is buggy, disabling.'
5227739Sgblack@eecs.umich.edu        main.Append(CCFLAGS=['-fno-tree-vectorize'])
5239224Sandreas.hansson@arm.com    # c++0x support in gcc is useful already from 4.4, see
5249224Sandreas.hansson@arm.com    # http://gcc.gnu.org/projects/cxx0x.html for details
5259224Sandreas.hansson@arm.com    if compareVersions(gcc_version, '4.4') >= 0:
5268946Sandreas.hansson@arm.com        main.Append(CXXFLAGS=['-std=c++0x'])
5279227Sandreas.hansson@arm.com
5289227Sandreas.hansson@arm.com    # LTO support is only really working properly from 4.6 and beyond
5299227Sandreas.hansson@arm.com    if compareVersions(gcc_version, '4.6') >= 0:
5309227Sandreas.hansson@arm.com        # Add the appropriate Link-Time Optimization (LTO) flags
5319227Sandreas.hansson@arm.com        # unless LTO is explicitly turned off. Note that these flags
5329227Sandreas.hansson@arm.com        # are only used by the fast target.
5339227Sandreas.hansson@arm.com        if not GetOption('no_lto'):
5349227Sandreas.hansson@arm.com            # Pass the LTO flag when compiling to produce GIMPLE
5359227Sandreas.hansson@arm.com            # output, we merely create the flags here and only append
5369227Sandreas.hansson@arm.com            # them later/
5379227Sandreas.hansson@arm.com            main['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
5389227Sandreas.hansson@arm.com
5399227Sandreas.hansson@arm.com            # Use the same amount of jobs for LTO as we are running
5409227Sandreas.hansson@arm.com            # scons with, we hardcode the use of the linker plugin
5419227Sandreas.hansson@arm.com            # which requires either gold or GNU ld >= 2.21
5429227Sandreas.hansson@arm.com            main['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs'),
5439227Sandreas.hansson@arm.com                                   '-fuse-linker-plugin']
5449227Sandreas.hansson@arm.com
5456121Snate@binkert.orgelif main['ICC']:
5463940Ssaidi@eecs.umich.edu    pass #Fix me... add warning flags once we clean up icc warnings
5476121Snate@binkert.orgelif main['SUNCC']:
5487739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=['-Qoption ccfe'])
5497739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=['-features=gcc'])
5507739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=['-features=extensions'])
5517739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=['-library=stlport4'])
5527739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=['-xar'])
5537739Sgblack@eecs.umich.edu    #main.Append(CCFLAGS=['-instances=semiexplicit'])
5548737Skoansin.tan@gmail.comelif main['CLANG']:
5558737Skoansin.tan@gmail.com    clang_version_re = re.compile(".* version (\d+\.\d+)")
5568737Skoansin.tan@gmail.com    clang_version_match = clang_version_re.match(CXX_version)
5578737Skoansin.tan@gmail.com    if (clang_version_match):
5588737Skoansin.tan@gmail.com        clang_version = clang_version_match.groups()[0]
5598737Skoansin.tan@gmail.com        if compareVersions(clang_version, "2.9") < 0:
5608737Skoansin.tan@gmail.com            print 'Error: clang version 2.9 or newer required.'
5618737Skoansin.tan@gmail.com            print '       Installed version:', clang_version
5628737Skoansin.tan@gmail.com            Exit(1)
5638737Skoansin.tan@gmail.com    else:
5648737Skoansin.tan@gmail.com        print 'Error: Unable to determine clang version.'
5658737Skoansin.tan@gmail.com        Exit(1)
5668737Skoansin.tan@gmail.com
5678737Skoansin.tan@gmail.com    main.Append(CCFLAGS=['-pipe'])
5688737Skoansin.tan@gmail.com    main.Append(CCFLAGS=['-fno-strict-aliasing'])
5698737Skoansin.tan@gmail.com    main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef'])
5708737Skoansin.tan@gmail.com    main.Append(CCFLAGS=['-Wno-tautological-compare'])
5718737Skoansin.tan@gmail.com    main.Append(CCFLAGS=['-Wno-self-assign'])
5728946Sandreas.hansson@arm.com    # Ruby makes frequent use of extraneous parantheses in the printing
5738946Sandreas.hansson@arm.com    # of if-statements
5748946Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-Wno-parentheses'])
5758946Sandreas.hansson@arm.com
5769224Sandreas.hansson@arm.com    # clang 2.9 does not play well with c++0x as it ships with C++
5779224Sandreas.hansson@arm.com    # headers that produce errors, this was fixed in 3.0
5788946Sandreas.hansson@arm.com    if compareVersions(clang_version, "3") >= 0:
5798946Sandreas.hansson@arm.com        main.Append(CXXFLAGS=['-std=c++0x'])
5803918Ssaidi@eecs.umich.eduelse:
5819068SAli.Saidi@ARM.com    print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal,
5829068SAli.Saidi@ARM.com    print "Don't know what compiler options to use for your compiler."
5839068SAli.Saidi@ARM.com    print termcap.Yellow + '       compiler:' + termcap.Normal, main['CXX']
5849068SAli.Saidi@ARM.com    print termcap.Yellow + '       version:' + termcap.Normal,
5859068SAli.Saidi@ARM.com    if not CXX_version:
5869068SAli.Saidi@ARM.com        print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\
5879068SAli.Saidi@ARM.com               termcap.Normal
5889068SAli.Saidi@ARM.com    else:
5899068SAli.Saidi@ARM.com        print CXX_version.replace('\n', '<nl>')
5909068SAli.Saidi@ARM.com    print "       If you're trying to use a compiler other than GCC, ICC, SunCC,"
5919068SAli.Saidi@ARM.com    print "       or clang, there appears to be something wrong with your"
5929068SAli.Saidi@ARM.com    print "       environment."
5939068SAli.Saidi@ARM.com    print "       "
5949068SAli.Saidi@ARM.com    print "       If you are trying to use a compiler other than those listed"
5959068SAli.Saidi@ARM.com    print "       above you will need to ease fix SConstruct and "
5969068SAli.Saidi@ARM.com    print "       src/SConscript to support that compiler."
5973918Ssaidi@eecs.umich.edu    Exit(1)
5983918Ssaidi@eecs.umich.edu
5996157Snate@binkert.org# Set up common yacc/bison flags (needed for Ruby)
6006157Snate@binkert.orgmain['YACCFLAGS'] = '-d'
6016157Snate@binkert.orgmain['YACCHXXFILESUFFIX'] = '.hh'
6026157Snate@binkert.org
6035397Ssaidi@eecs.umich.edu# Do this after we save setting back, or else we'll tack on an
6045397Ssaidi@eecs.umich.edu# extra 'qdo' every time we run scons.
6056121Snate@binkert.orgif main['BATCH']:
6066121Snate@binkert.org    main['CC']     = main['BATCH_CMD'] + ' ' + main['CC']
6076121Snate@binkert.org    main['CXX']    = main['BATCH_CMD'] + ' ' + main['CXX']
6086121Snate@binkert.org    main['AS']     = main['BATCH_CMD'] + ' ' + main['AS']
6096121Snate@binkert.org    main['AR']     = main['BATCH_CMD'] + ' ' + main['AR']
6106121Snate@binkert.org    main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB']
6115397Ssaidi@eecs.umich.edu
6121851SN/Aif sys.platform == 'cygwin':
6131851SN/A    # cygwin has some header file issues...
6147739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=["-Wno-uninitialized"])
615955SN/A
6163053Sstever@eecs.umich.edu# Check for SWIG
6176121Snate@binkert.orgif not main.has_key('SWIG'):
6183053Sstever@eecs.umich.edu    print 'Error: SWIG utility not found.'
6193053Sstever@eecs.umich.edu    print '       Please install (see http://www.swig.org) and retry.'
6203053Sstever@eecs.umich.edu    Exit(1)
6213053Sstever@eecs.umich.edu
6223053Sstever@eecs.umich.edu# Check for appropriate SWIG version
6239072Sandreas.hansson@arm.comswig_version = readCommand([main['SWIG'], '-version'], exception='').split()
6243053Sstever@eecs.umich.edu# First 3 words should be "SWIG Version x.y.z"
6254742Sstever@eecs.umich.eduif len(swig_version) < 3 or \
6264742Sstever@eecs.umich.edu        swig_version[0] != 'SWIG' or swig_version[1] != 'Version':
6273053Sstever@eecs.umich.edu    print 'Error determining SWIG version.'
6283053Sstever@eecs.umich.edu    Exit(1)
6293053Sstever@eecs.umich.edu
6308960Ssteve.reinhardt@amd.commin_swig_version = '1.3.34'
6316654Snate@binkert.orgif compareVersions(swig_version[2], min_swig_version) < 0:
6323053Sstever@eecs.umich.edu    print 'Error: SWIG version', min_swig_version, 'or newer required.'
6333053Sstever@eecs.umich.edu    print '       Installed version:', swig_version[2]
6343053Sstever@eecs.umich.edu    Exit(1)
6353053Sstever@eecs.umich.edu
6362667Sstever@eecs.umich.edu# Set up SWIG flags & scanner
6374554Sbinkertn@umich.eduswig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
6386121Snate@binkert.orgmain.Append(SWIGFLAGS=swig_flags)
6392667Sstever@eecs.umich.edu
6404554Sbinkertn@umich.edu# filter out all existing swig scanners, they mess up the dependency
6414554Sbinkertn@umich.edu# stuff for some reason
6424554Sbinkertn@umich.eduscanners = []
6436121Snate@binkert.orgfor scanner in main['SCANNERS']:
6444554Sbinkertn@umich.edu    skeys = scanner.skeys
6454554Sbinkertn@umich.edu    if skeys == '.i':
6464554Sbinkertn@umich.edu        continue
6474781Snate@binkert.org
6484554Sbinkertn@umich.edu    if isinstance(skeys, (list, tuple)) and '.i' in skeys:
6494554Sbinkertn@umich.edu        continue
6502667Sstever@eecs.umich.edu
6514554Sbinkertn@umich.edu    scanners.append(scanner)
6524554Sbinkertn@umich.edu
6534554Sbinkertn@umich.edu# add the new swig scanner that we like better
6544554Sbinkertn@umich.edufrom SCons.Scanner import ClassicCPP as CPPScanner
6552667Sstever@eecs.umich.eduswig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
6564554Sbinkertn@umich.eduscanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re))
6572667Sstever@eecs.umich.edu
6584554Sbinkertn@umich.edu# replace the scanners list that has what we want
6596121Snate@binkert.orgmain['SCANNERS'] = scanners
6602667Sstever@eecs.umich.edu
6615522Snate@binkert.org# Add a custom Check function to the Configure context so that we can
6625522Snate@binkert.org# figure out if the compiler adds leading underscores to global
6635522Snate@binkert.org# variables.  This is needed for the autogenerated asm files that we
6645522Snate@binkert.org# use for embedding the python code.
6655522Snate@binkert.orgdef CheckLeading(context):
6665522Snate@binkert.org    context.Message("Checking for leading underscore in global variables...")
6675522Snate@binkert.org    # 1) Define a global variable called x from asm so the C compiler
6685522Snate@binkert.org    #    won't change the symbol at all.
6695522Snate@binkert.org    # 2) Declare that variable.
6705522Snate@binkert.org    # 3) Use the variable
6715522Snate@binkert.org    #
6725522Snate@binkert.org    # If the compiler prepends an underscore, this will successfully
6735522Snate@binkert.org    # link because the external symbol 'x' will be called '_x' which
6745522Snate@binkert.org    # was defined by the asm statement.  If the compiler does not
6755522Snate@binkert.org    # prepend an underscore, this will not successfully link because
6765522Snate@binkert.org    # '_x' will have been defined by assembly, while the C portion of
6775522Snate@binkert.org    # the code will be trying to use 'x'
6785522Snate@binkert.org    ret = context.TryLink('''
6795522Snate@binkert.org        asm(".globl _x; _x: .byte 0");
6805522Snate@binkert.org        extern int x;
6815522Snate@binkert.org        int main() { return x; }
6825522Snate@binkert.org        ''', extension=".c")
6835522Snate@binkert.org    context.env.Append(LEADING_UNDERSCORE=ret)
6845522Snate@binkert.org    context.Result(ret)
6855522Snate@binkert.org    return ret
6865522Snate@binkert.org
6872638Sstever@eecs.umich.edu# Platform-specific configuration.  Note again that we assume that all
6882638Sstever@eecs.umich.edu# builds under a given build root run on the same host platform.
6896121Snate@binkert.orgconf = Configure(main,
6903716Sstever@eecs.umich.edu                 conf_dir = joinpath(build_root, '.scons_config'),
6915522Snate@binkert.org                 log_file = joinpath(build_root, 'scons_config.log'),
6925522Snate@binkert.org                 custom_tests = { 'CheckLeading' : CheckLeading })
6935522Snate@binkert.org
6945522Snate@binkert.org# Check for leading underscores.  Don't really need to worry either
6955522Snate@binkert.org# way so don't need to check the return code.
6965522Snate@binkert.orgconf.CheckLeading()
6971858SN/A
6985227Ssaidi@eecs.umich.edu# Check if we should compile a 64 bit binary on Mac OS X/Darwin
6995227Ssaidi@eecs.umich.edutry:
7005227Ssaidi@eecs.umich.edu    import platform
7015227Ssaidi@eecs.umich.edu    uname = platform.uname()
7026654Snate@binkert.org    if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0:
7036654Snate@binkert.org        if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
7047769SAli.Saidi@ARM.com            main.Append(CCFLAGS=['-arch', 'x86_64'])
7057769SAli.Saidi@ARM.com            main.Append(CFLAGS=['-arch', 'x86_64'])
7067769SAli.Saidi@ARM.com            main.Append(LINKFLAGS=['-arch', 'x86_64'])
7077769SAli.Saidi@ARM.com            main.Append(ASFLAGS=['-arch', 'x86_64'])
7085227Ssaidi@eecs.umich.eduexcept:
7095227Ssaidi@eecs.umich.edu    pass
7105227Ssaidi@eecs.umich.edu
7115204Sstever@gmail.com# Recent versions of scons substitute a "Null" object for Configure()
7125204Sstever@gmail.com# when configuration isn't necessary, e.g., if the "--help" option is
7135204Sstever@gmail.com# present.  Unfortuantely this Null object always returns false,
7145204Sstever@gmail.com# breaking all our configuration checks.  We replace it with our own
7155204Sstever@gmail.com# more optimistic null object that returns True instead.
7165204Sstever@gmail.comif not conf:
7175204Sstever@gmail.com    def NullCheck(*args, **kwargs):
7185204Sstever@gmail.com        return True
7195204Sstever@gmail.com
7205204Sstever@gmail.com    class NullConf:
7215204Sstever@gmail.com        def __init__(self, env):
7225204Sstever@gmail.com            self.env = env
7235204Sstever@gmail.com        def Finish(self):
7245204Sstever@gmail.com            return self.env
7255204Sstever@gmail.com        def __getattr__(self, mname):
7265204Sstever@gmail.com            return NullCheck
7275204Sstever@gmail.com
7286121Snate@binkert.org    conf = NullConf(main)
7295204Sstever@gmail.com
7303118Sstever@eecs.umich.edu# Find Python include and library directories for embedding the
7313118Sstever@eecs.umich.edu# interpreter.  For consistency, we will use the same Python
7323118Sstever@eecs.umich.edu# installation used to run scons (and thus this script).  If you want
7333118Sstever@eecs.umich.edu# to link in an alternate version, see above for instructions on how
7343118Sstever@eecs.umich.edu# to invoke scons with a different copy of the Python interpreter.
7355863Snate@binkert.orgfrom distutils import sysconfig
7363118Sstever@eecs.umich.edu
7375863Snate@binkert.orgpy_getvar = sysconfig.get_config_var
7383118Sstever@eecs.umich.edu
7397457Snate@binkert.orgpy_debug = getattr(sys, 'pydebug', False)
7407457Snate@binkert.orgpy_version = 'python' + py_getvar('VERSION') + (py_debug and "_d" or "")
7415863Snate@binkert.org
7425863Snate@binkert.orgpy_general_include = sysconfig.get_python_inc()
7435863Snate@binkert.orgpy_platform_include = sysconfig.get_python_inc(plat_specific=True)
7445863Snate@binkert.orgpy_includes = [ py_general_include ]
7455863Snate@binkert.orgif py_platform_include != py_general_include:
7465863Snate@binkert.org    py_includes.append(py_platform_include)
7475863Snate@binkert.org
7486003Snate@binkert.orgpy_lib_path = [ py_getvar('LIBDIR') ]
7495863Snate@binkert.org# add the prefix/lib/pythonX.Y/config dir, but only if there is no
7505863Snate@binkert.org# shared library in prefix/lib/.
7515863Snate@binkert.orgif not py_getvar('Py_ENABLE_SHARED'):
7526120Snate@binkert.org    py_lib_path.append(py_getvar('LIBPL'))
7535863Snate@binkert.org
7545863Snate@binkert.orgpy_libs = []
7555863Snate@binkert.orgfor lib in py_getvar('LIBS').split() + py_getvar('SYSLIBS').split():
7568655Sandreas.hansson@arm.com    if not lib.startswith('-l'):
7578655Sandreas.hansson@arm.com        # Python requires some special flags to link (e.g. -framework
7588655Sandreas.hansson@arm.com        # common on OS X systems), assume appending preserves order
7598655Sandreas.hansson@arm.com        main.Append(LINKFLAGS=[lib])
7608655Sandreas.hansson@arm.com    else:
7618655Sandreas.hansson@arm.com        lib = lib[2:]
7628655Sandreas.hansson@arm.com        if lib not in py_libs:
7638655Sandreas.hansson@arm.com            py_libs.append(lib)
7646120Snate@binkert.orgpy_libs.append(py_version)
7655863Snate@binkert.org
7666121Snate@binkert.orgmain.Append(CPPPATH=py_includes)
7676121Snate@binkert.orgmain.Append(LIBPATH=py_lib_path)
7685863Snate@binkert.org
7697727SAli.Saidi@ARM.com# Cache build files in the supplied directory.
7707727SAli.Saidi@ARM.comif main['M5_BUILD_CACHE']:
7717727SAli.Saidi@ARM.com    print 'Using build cache located at', main['M5_BUILD_CACHE']
7727727SAli.Saidi@ARM.com    CacheDir(main['M5_BUILD_CACHE'])
7737727SAli.Saidi@ARM.com
7747727SAli.Saidi@ARM.com
7755863Snate@binkert.org# verify that this stuff works
7763118Sstever@eecs.umich.eduif not conf.CheckHeader('Python.h', '<>'):
7775863Snate@binkert.org    print "Error: can't find Python.h header in", py_includes
7789239Sandreas.hansson@arm.com    print "Install Python headers (package python-dev on Ubuntu and RedHat)"
7793118Sstever@eecs.umich.edu    Exit(1)
7803118Sstever@eecs.umich.edu
7815863Snate@binkert.orgfor lib in py_libs:
7825863Snate@binkert.org    if not conf.CheckLib(lib):
7835863Snate@binkert.org        print "Error: can't find library %s required by python" % lib
7845863Snate@binkert.org        Exit(1)
7853118Sstever@eecs.umich.edu
7863483Ssaidi@eecs.umich.edu# On Solaris you need to use libsocket for socket ops
7873494Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
7883494Ssaidi@eecs.umich.edu   if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
7893483Ssaidi@eecs.umich.edu       print "Can't find library with socket calls (e.g. accept())"
7903483Ssaidi@eecs.umich.edu       Exit(1)
7913483Ssaidi@eecs.umich.edu
7923053Sstever@eecs.umich.edu# Check for zlib.  If the check passes, libz will be automatically
7933053Sstever@eecs.umich.edu# added to the LIBS environment variable.
7943918Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
7953053Sstever@eecs.umich.edu    print 'Error: did not find needed zlib compression library '\
7963053Sstever@eecs.umich.edu          'and/or zlib.h header file.'
7973053Sstever@eecs.umich.edu    print '       Please install zlib and try again.'
7983053Sstever@eecs.umich.edu    Exit(1)
7993053Sstever@eecs.umich.edu
8007840Snate@binkert.org# Check for librt.
8017865Sgblack@eecs.umich.eduhave_posix_clock = \
8027865Sgblack@eecs.umich.edu    conf.CheckLibWithHeader(None, 'time.h', 'C',
8037865Sgblack@eecs.umich.edu                            'clock_nanosleep(0,0,NULL,NULL);') or \
8047865Sgblack@eecs.umich.edu    conf.CheckLibWithHeader('rt', 'time.h', 'C',
8057865Sgblack@eecs.umich.edu                            'clock_nanosleep(0,0,NULL,NULL);')
8067840Snate@binkert.org
8079045SAli.Saidi@ARM.comif conf.CheckLib('tcmalloc_minimal'):
8089045SAli.Saidi@ARM.com    have_tcmalloc = True
8099045SAli.Saidi@ARM.comelse:
8109045SAli.Saidi@ARM.com    have_tcmalloc = False
8119045SAli.Saidi@ARM.com    print termcap.Yellow + termcap.Bold + \
8129045SAli.Saidi@ARM.com          "You can get a 12% performance improvement by installing tcmalloc "\
8139071Sandreas.hansson@arm.com          "(libgoogle-perftools-dev package on Ubuntu or RedHat)." + \
8149071Sandreas.hansson@arm.com          termcap.Normal
8159045SAli.Saidi@ARM.com
8167840Snate@binkert.orgif not have_posix_clock:
8177840Snate@binkert.org    print "Can't find library for POSIX clocks."
8187840Snate@binkert.org
8191858SN/A# Check for <fenv.h> (C99 FP environment control)
8201858SN/Ahave_fenv = conf.CheckHeader('fenv.h', '<>')
8211858SN/Aif not have_fenv:
8221858SN/A    print "Warning: Header file <fenv.h> not found."
8231858SN/A    print "         This host has no IEEE FP rounding mode control."
8241858SN/A
8255863Snate@binkert.org######################################################################
8265863Snate@binkert.org#
8275863Snate@binkert.org# Finish the configuration
8285863Snate@binkert.org#
8296121Snate@binkert.orgmain = conf.Finish()
8301858SN/A
8315863Snate@binkert.org######################################################################
8325863Snate@binkert.org#
8335863Snate@binkert.org# Collect all non-global variables
8345863Snate@binkert.org#
8355863Snate@binkert.org
8362139SN/A# Define the universe of supported ISAs
8374202Sbinkertn@umich.eduall_isa_list = [ ]
8384202Sbinkertn@umich.eduExport('all_isa_list')
8392139SN/A
8406994Snate@binkert.orgclass CpuModel(object):
8416994Snate@binkert.org    '''The CpuModel class encapsulates everything the ISA parser needs to
8426994Snate@binkert.org    know about a particular CPU model.'''
8436994Snate@binkert.org
8446994Snate@binkert.org    # Dict of available CPU model objects.  Accessible as CpuModel.dict.
8456994Snate@binkert.org    dict = {}
8466994Snate@binkert.org    list = []
8476994Snate@binkert.org    defaults = []
8486994Snate@binkert.org
8496994Snate@binkert.org    # Constructor.  Automatically adds models to CpuModel.dict.
8506994Snate@binkert.org    def __init__(self, name, filename, includes, strings, default=False):
8516994Snate@binkert.org        self.name = name           # name of model
8526994Snate@binkert.org        self.filename = filename   # filename for output exec code
8536994Snate@binkert.org        self.includes = includes   # include files needed in exec file
8546994Snate@binkert.org        # The 'strings' dict holds all the per-CPU symbols we can
8556994Snate@binkert.org        # substitute into templates etc.
8566994Snate@binkert.org        self.strings = strings
8576994Snate@binkert.org
8586994Snate@binkert.org        # This cpu is enabled by default
8596994Snate@binkert.org        self.default = default
8606994Snate@binkert.org
8616994Snate@binkert.org        # Add self to dict
8626994Snate@binkert.org        if name in CpuModel.dict:
8636994Snate@binkert.org            raise AttributeError, "CpuModel '%s' already registered" % name
8646994Snate@binkert.org        CpuModel.dict[name] = self
8656994Snate@binkert.org        CpuModel.list.append(name)
8666994Snate@binkert.org
8676994Snate@binkert.orgExport('CpuModel')
8682155SN/A
8695863Snate@binkert.org# Sticky variables get saved in the variables file so they persist from
8701869SN/A# one invocation to the next (unless overridden, in which case the new
8711869SN/A# value becomes sticky).
8725863Snate@binkert.orgsticky_vars = Variables(args=ARGUMENTS)
8735863Snate@binkert.orgExport('sticky_vars')
8744202Sbinkertn@umich.edu
8756108Snate@binkert.org# Sticky variables that should be exported
8766108Snate@binkert.orgexport_vars = []
8776108Snate@binkert.orgExport('export_vars')
8786108Snate@binkert.org
8799219Spower.jg@gmail.com# For Ruby
8809219Spower.jg@gmail.comall_protocols = []
8819219Spower.jg@gmail.comExport('all_protocols')
8829219Spower.jg@gmail.comprotocol_dirs = []
8839219Spower.jg@gmail.comExport('protocol_dirs')
8849219Spower.jg@gmail.comslicc_includes = []
8859219Spower.jg@gmail.comExport('slicc_includes')
8869219Spower.jg@gmail.com
8874202Sbinkertn@umich.edu# Walk the tree and execute all SConsopts scripts that wil add to the
8885863Snate@binkert.org# above variables
8898474Sgblack@eecs.umich.eduif not GetOption('verbose'):
8908474Sgblack@eecs.umich.edu    print "Reading SConsopts"
8915742Snate@binkert.orgfor bdir in [ base_dir ] + extras_dir_list:
8928268Ssteve.reinhardt@amd.com    if not isdir(bdir):
8938268Ssteve.reinhardt@amd.com        print "Error: directory '%s' does not exist" % bdir
8948268Ssteve.reinhardt@amd.com        Exit(1)
8955742Snate@binkert.org    for root, dirs, files in os.walk(bdir):
8965341Sstever@gmail.com        if 'SConsopts' in files:
8978474Sgblack@eecs.umich.edu            if GetOption('verbose'):
8988474Sgblack@eecs.umich.edu                print "Reading", joinpath(root, 'SConsopts')
8995342Sstever@gmail.com            SConscript(joinpath(root, 'SConsopts'))
9004202Sbinkertn@umich.edu
9014202Sbinkertn@umich.eduall_isa_list.sort()
9024202Sbinkertn@umich.edu
9035863Snate@binkert.orgsticky_vars.AddVariables(
9045863Snate@binkert.org    EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list),
9056994Snate@binkert.org    ListVariable('CPU_MODELS', 'CPU models',
9066994Snate@binkert.org                 sorted(n for n,m in CpuModel.dict.iteritems() if m.default),
9076994Snate@binkert.org                 sorted(CpuModel.list)),
9085863Snate@binkert.org    BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
9095863Snate@binkert.org                 False),
9105863Snate@binkert.org    BoolVariable('SS_COMPATIBLE_FP',
9115863Snate@binkert.org                 'Make floating-point results compatible with SimpleScalar',
9125863Snate@binkert.org                 False),
9135863Snate@binkert.org    BoolVariable('USE_SSE2',
9145863Snate@binkert.org                 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
9155863Snate@binkert.org                 False),
9167840Snate@binkert.org    BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock),
9175863Snate@binkert.org    BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
9185952Ssaidi@eecs.umich.edu    BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False),
9199219Spower.jg@gmail.com    EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None',
9209219Spower.jg@gmail.com                  all_protocols),
9211869SN/A    )
9221858SN/A
9235863Snate@binkert.org# These variables get exported to #defines in config/*.hh (see src/SConscript).
9249044SAli.Saidi@ARM.comexport_vars += ['USE_FENV', 'SS_COMPATIBLE_FP',
9259219Spower.jg@gmail.com                'TARGET_ISA', 'CP_ANNOTATE', 'USE_POSIX_CLOCK', 'PROTOCOL',
9269219Spower.jg@gmail.com               ]
9271858SN/A
928955SN/A###################################################
929955SN/A#
9301869SN/A# Define a SCons builder for configuration flag headers.
9311869SN/A#
9321869SN/A###################################################
9331869SN/A
9341869SN/A# This function generates a config header file that #defines the
9355863Snate@binkert.org# variable symbol to the current variable setting (0 or 1).  The source
9365863Snate@binkert.org# operands are the name of the variable and a Value node containing the
9375863Snate@binkert.org# value of the variable.
9381869SN/Adef build_config_file(target, source, env):
9395863Snate@binkert.org    (variable, value) = [s.get_contents() for s in source]
9401869SN/A    f = file(str(target[0]), 'w')
9415863Snate@binkert.org    print >> f, '#define', variable, value
9421869SN/A    f.close()
9431869SN/A    return None
9441869SN/A
9451869SN/A# Combine the two functions into a scons Action object.
9468483Sgblack@eecs.umich.educonfig_action = MakeAction(build_config_file, Transform("CONFIG H", 2))
9471869SN/A
9481869SN/A# The emitter munges the source & target node lists to reflect what
9491869SN/A# we're really doing.
9501869SN/Adef config_emitter(target, source, env):
9515863Snate@binkert.org    # extract variable name from Builder arg
9525863Snate@binkert.org    variable = str(target[0])
9531869SN/A    # True target is config header file
9545863Snate@binkert.org    target = joinpath('config', variable.lower() + '.hh')
9555863Snate@binkert.org    val = env[variable]
9563356Sbinkertn@umich.edu    if isinstance(val, bool):
9573356Sbinkertn@umich.edu        # Force value to 0/1
9583356Sbinkertn@umich.edu        val = int(val)
9593356Sbinkertn@umich.edu    elif isinstance(val, str):
9603356Sbinkertn@umich.edu        val = '"' + val + '"'
9614781Snate@binkert.org
9625863Snate@binkert.org    # Sources are variable name & value (packaged in SCons Value nodes)
9635863Snate@binkert.org    return ([target], [Value(variable), Value(val)])
9641869SN/A
9651869SN/Aconfig_builder = Builder(emitter = config_emitter, action = config_action)
9661869SN/A
9676121Snate@binkert.orgmain.Append(BUILDERS = { 'ConfigFile' : config_builder })
9681869SN/A
9692638Sstever@eecs.umich.edu# libelf build is shared across all configs in the build root.
9706121Snate@binkert.orgmain.SConscript('ext/libelf/SConscript',
9716121Snate@binkert.org                variant_dir = joinpath(build_root, 'libelf'))
9722638Sstever@eecs.umich.edu
9735749Scws3k@cs.virginia.edu# gzstream build is shared across all configs in the build root.
9746121Snate@binkert.orgmain.SConscript('ext/gzstream/SConscript',
9756121Snate@binkert.org                variant_dir = joinpath(build_root, 'gzstream'))
9765749Scws3k@cs.virginia.edu
9771869SN/A###################################################
9781869SN/A#
9793546Sgblack@eecs.umich.edu# This function is used to set up a directory with switching headers
9803546Sgblack@eecs.umich.edu#
9813546Sgblack@eecs.umich.edu###################################################
9823546Sgblack@eecs.umich.edu
9836121Snate@binkert.orgmain['ALL_ISA_LIST'] = all_isa_list
9845863Snate@binkert.orgdef make_switching_dir(dname, switch_headers, env):
9853546Sgblack@eecs.umich.edu    # Generate the header.  target[0] is the full path of the output
9863546Sgblack@eecs.umich.edu    # header to generate.  'source' is a dummy variable, since we get the
9873546Sgblack@eecs.umich.edu    # list of ISAs from env['ALL_ISA_LIST'].
9883546Sgblack@eecs.umich.edu    def gen_switch_hdr(target, source, env):
9894781Snate@binkert.org        fname = str(target[0])
9904781Snate@binkert.org        f = open(fname, 'w')
9916658Snate@binkert.org        isa = env['TARGET_ISA'].lower()
9926658Snate@binkert.org        print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname))
9934781Snate@binkert.org        f.close()
9943546Sgblack@eecs.umich.edu
9953546Sgblack@eecs.umich.edu    # Build SCons Action object. 'varlist' specifies env vars that this
9963546Sgblack@eecs.umich.edu    # action depends on; when env['ALL_ISA_LIST'] changes these actions
9973546Sgblack@eecs.umich.edu    # should get re-executed.
9987756SAli.Saidi@ARM.com    switch_hdr_action = MakeAction(gen_switch_hdr,
9997816Ssteve.reinhardt@amd.com                          Transform("GENERATE"), varlist=['ALL_ISA_LIST'])
10003546Sgblack@eecs.umich.edu
10013546Sgblack@eecs.umich.edu    # Instantiate actions for each header
10023546Sgblack@eecs.umich.edu    for hdr in switch_headers:
10033546Sgblack@eecs.umich.edu        env.Command(hdr, [], switch_hdr_action)
10044202Sbinkertn@umich.eduExport('make_switching_dir')
10053546Sgblack@eecs.umich.edu
10063546Sgblack@eecs.umich.edu###################################################
10073546Sgblack@eecs.umich.edu#
1008955SN/A# Define build environments for selected configurations.
1009955SN/A#
1010955SN/A###################################################
1011955SN/A
10125863Snate@binkert.orgfor variant_path in variant_paths:
10135863Snate@binkert.org    print "Building in", variant_path
10145343Sstever@gmail.com
10155343Sstever@gmail.com    # Make a copy of the build-root environment to use for this config.
10166121Snate@binkert.org    env = main.Clone()
10175863Snate@binkert.org    env['BUILDDIR'] = variant_path
10184773Snate@binkert.org
10195863Snate@binkert.org    # variant_dir is the tail component of build path, and is used to
10202632Sstever@eecs.umich.edu    # determine the build parameters (e.g., 'ALPHA_SE')
10215863Snate@binkert.org    (build_root, variant_dir) = splitpath(variant_path)
10222023SN/A
10235863Snate@binkert.org    # Set env variables according to the build directory config.
10245863Snate@binkert.org    sticky_vars.files = []
10255863Snate@binkert.org    # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
10265863Snate@binkert.org    # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
10275863Snate@binkert.org    # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
10285863Snate@binkert.org    current_vars_file = joinpath(build_root, 'variables', variant_dir)
10295863Snate@binkert.org    if isfile(current_vars_file):
10305863Snate@binkert.org        sticky_vars.files.append(current_vars_file)
10315863Snate@binkert.org        print "Using saved variables file %s" % current_vars_file
10322632Sstever@eecs.umich.edu    else:
10335863Snate@binkert.org        # Build dir-specific variables file doesn't exist.
10342023SN/A
10352632Sstever@eecs.umich.edu        # Make sure the directory is there so we can create it later
10365863Snate@binkert.org        opt_dir = dirname(current_vars_file)
10375342Sstever@gmail.com        if not isdir(opt_dir):
10385863Snate@binkert.org            mkdir(opt_dir)
10392632Sstever@eecs.umich.edu
10405863Snate@binkert.org        # Get default build variables from source tree.  Variables are
10415863Snate@binkert.org        # normally determined by name of $VARIANT_DIR, but can be
10428267Ssteve.reinhardt@amd.com        # overridden by '--default=' arg on command line.
10438120Sgblack@eecs.umich.edu        default = GetOption('default')
10448267Ssteve.reinhardt@amd.com        opts_dir = joinpath(main.root.abspath, 'build_opts')
10458267Ssteve.reinhardt@amd.com        if default:
10468267Ssteve.reinhardt@amd.com            default_vars_files = [joinpath(build_root, 'variables', default),
10478267Ssteve.reinhardt@amd.com                                  joinpath(opts_dir, default)]
10488267Ssteve.reinhardt@amd.com        else:
10498267Ssteve.reinhardt@amd.com            default_vars_files = [joinpath(opts_dir, variant_dir)]
10508267Ssteve.reinhardt@amd.com        existing_files = filter(isfile, default_vars_files)
10518267Ssteve.reinhardt@amd.com        if existing_files:
10528267Ssteve.reinhardt@amd.com            default_vars_file = existing_files[0]
10535863Snate@binkert.org            sticky_vars.files.append(default_vars_file)
10545863Snate@binkert.org            print "Variables file %s not found,\n  using defaults in %s" \
10555863Snate@binkert.org                  % (current_vars_file, default_vars_file)
10562632Sstever@eecs.umich.edu        else:
10578267Ssteve.reinhardt@amd.com            print "Error: cannot find variables file %s or " \
10588267Ssteve.reinhardt@amd.com                  "default file(s) %s" \
10598267Ssteve.reinhardt@amd.com                  % (current_vars_file, ' or '.join(default_vars_files))
10602632Sstever@eecs.umich.edu            Exit(1)
10611888SN/A
10625863Snate@binkert.org    # Apply current variable settings to env
10635863Snate@binkert.org    sticky_vars.Update(env)
10641858SN/A
10658120Sgblack@eecs.umich.edu    help_texts["local_vars"] += \
10668120Sgblack@eecs.umich.edu        "Build variables for %s:\n" % variant_dir \
10677756SAli.Saidi@ARM.com                 + sticky_vars.GenerateHelpText(env)
10682598SN/A
10695863Snate@binkert.org    # Process variable settings.
10701858SN/A
10711858SN/A    if not have_fenv and env['USE_FENV']:
10721858SN/A        print "Warning: <fenv.h> not available; " \
10735863Snate@binkert.org              "forcing USE_FENV to False in", variant_dir + "."
10741858SN/A        env['USE_FENV'] = False
10751858SN/A
10761858SN/A    if not env['USE_FENV']:
10775863Snate@binkert.org        print "Warning: No IEEE FP rounding mode control in", variant_dir + "."
10781871SN/A        print "         FP results may deviate slightly from other platforms."
10791858SN/A
10801858SN/A    if env['EFENCE']:
10811858SN/A        env.Append(LIBS=['efence'])
10821858SN/A
10835863Snate@binkert.org    # Save sticky variable settings back to current variables file
10845863Snate@binkert.org    sticky_vars.Save(current_vars_file, env)
10851869SN/A
10861965SN/A    if env['USE_SSE2']:
10877739Sgblack@eecs.umich.edu        env.Append(CCFLAGS=['-msse2'])
10881965SN/A
10899045SAli.Saidi@ARM.com    if have_tcmalloc:
10909045SAli.Saidi@ARM.com        env.Append(LIBS=['tcmalloc_minimal'])
10919045SAli.Saidi@ARM.com
10922761Sstever@eecs.umich.edu    # The src/SConscript file sets up the build rules in 'env' according
10935863Snate@binkert.org    # to the configured variables.  It returns a list of environments,
10941869SN/A    # one for each variant build (debug, opt, etc.)
10955863Snate@binkert.org    envList = SConscript('src/SConscript', variant_dir = variant_path,
10962667Sstever@eecs.umich.edu                         exports = 'env')
10971869SN/A
10981869SN/A    # Set up the regression tests for each build.
10992929Sktlim@umich.edu    for e in envList:
11002929Sktlim@umich.edu        SConscript('tests/SConscript',
11015863Snate@binkert.org                   variant_dir = joinpath(variant_path, 'tests', e.Label),
11022929Sktlim@umich.edu                   exports = { 'env' : e }, duplicate = False)
1103955SN/A
11048120Sgblack@eecs.umich.edu# base help text
11058120Sgblack@eecs.umich.eduHelp('''
11068120Sgblack@eecs.umich.eduUsage: scons [scons options] [build variables] [target(s)]
11078120Sgblack@eecs.umich.edu
11088120Sgblack@eecs.umich.eduExtra scons options:
11098120Sgblack@eecs.umich.edu%(options)s
11108120Sgblack@eecs.umich.edu
11118120Sgblack@eecs.umich.eduGlobal build variables:
11128120Sgblack@eecs.umich.edu%(global_vars)s
11138120Sgblack@eecs.umich.edu
11148120Sgblack@eecs.umich.edu%(local_vars)s
11158120Sgblack@eecs.umich.edu''' % help_texts)
1116