SConstruct revision 9227:c208c904ab13
17119Sgblack@eecs.umich.edu# -*- mode:python -*-
27119Sgblack@eecs.umich.edu
310037SARM gem5 Developers# Copyright (c) 2011 Advanced Micro Devices, Inc.
47119Sgblack@eecs.umich.edu# Copyright (c) 2009 The Hewlett-Packard Development Company
57119Sgblack@eecs.umich.edu# Copyright (c) 2004-2005 The Regents of The University of Michigan
67119Sgblack@eecs.umich.edu# All rights reserved.
77119Sgblack@eecs.umich.edu#
87119Sgblack@eecs.umich.edu# Redistribution and use in source and binary forms, with or without
97119Sgblack@eecs.umich.edu# modification, are permitted provided that the following conditions are
107119Sgblack@eecs.umich.edu# met: redistributions of source code must retain the above copyright
117119Sgblack@eecs.umich.edu# notice, this list of conditions and the following disclaimer;
127119Sgblack@eecs.umich.edu# redistributions in binary form must reproduce the above copyright
137119Sgblack@eecs.umich.edu# notice, this list of conditions and the following disclaimer in the
147119Sgblack@eecs.umich.edu# documentation and/or other materials provided with the distribution;
157119Sgblack@eecs.umich.edu# neither the name of the copyright holders nor the names of its
167119Sgblack@eecs.umich.edu# contributors may be used to endorse or promote products derived from
177119Sgblack@eecs.umich.edu# this software without specific prior written permission.
187119Sgblack@eecs.umich.edu#
197119Sgblack@eecs.umich.edu# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
207119Sgblack@eecs.umich.edu# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
217119Sgblack@eecs.umich.edu# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
227119Sgblack@eecs.umich.edu# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
237119Sgblack@eecs.umich.edu# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
247119Sgblack@eecs.umich.edu# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
257119Sgblack@eecs.umich.edu# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
267119Sgblack@eecs.umich.edu# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
277119Sgblack@eecs.umich.edu# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
287119Sgblack@eecs.umich.edu# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
297119Sgblack@eecs.umich.edu# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
307119Sgblack@eecs.umich.edu#
317119Sgblack@eecs.umich.edu# Authors: Steve Reinhardt
327119Sgblack@eecs.umich.edu#          Nathan Binkert
337119Sgblack@eecs.umich.edu
347119Sgblack@eecs.umich.edu###################################################
357119Sgblack@eecs.umich.edu#
367119Sgblack@eecs.umich.edu# SCons top-level build description (SConstruct) file.
377119Sgblack@eecs.umich.edu#
387119Sgblack@eecs.umich.edu# While in this directory ('gem5'), just type 'scons' to build the default
397119Sgblack@eecs.umich.edu# configuration (see below), or type 'scons build/<CONFIG>/<binary>'
407119Sgblack@eecs.umich.edu# to build some other configuration (e.g., 'build/ALPHA/gem5.opt' for
4110037SARM gem5 Developers# the optimized full-system version).
427119Sgblack@eecs.umich.edu#
437119Sgblack@eecs.umich.edu# You can build gem5 in a different directory as long as there is a
447119Sgblack@eecs.umich.edu# 'build/<CONFIG>' somewhere along the target path.  The build system
457119Sgblack@eecs.umich.edu# expects that all configs under the same build directory are being
467119Sgblack@eecs.umich.edu# built for the same host system.
477590Sgblack@eecs.umich.edu#
487590Sgblack@eecs.umich.edu# Examples:
497119Sgblack@eecs.umich.edu#
507590Sgblack@eecs.umich.edu#   The following two commands are equivalent.  The '-u' option tells
517590Sgblack@eecs.umich.edu#   scons to search up the directory tree for this SConstruct file.
527590Sgblack@eecs.umich.edu#   % cd <path-to-src>/gem5 ; scons build/ALPHA/gem5.debug
537590Sgblack@eecs.umich.edu#   % cd <path-to-src>/gem5/build/ALPHA; scons -u gem5.debug
547590Sgblack@eecs.umich.edu#
557590Sgblack@eecs.umich.edu#   The following two commands are equivalent and demonstrate building
567590Sgblack@eecs.umich.edu#   in a directory outside of the source tree.  The '-C' option tells
577590Sgblack@eecs.umich.edu#   scons to chdir to the specified directory to find this SConstruct
587590Sgblack@eecs.umich.edu#   file.
597590Sgblack@eecs.umich.edu#   % cd <path-to-src>/gem5 ; scons /local/foo/build/ALPHA/gem5.debug
607590Sgblack@eecs.umich.edu#   % cd /local/foo/build/ALPHA; scons -C <path-to-src>/gem5 gem5.debug
617590Sgblack@eecs.umich.edu#
628203SAli.Saidi@ARM.com# You can use 'scons -H' to print scons options.  If you're in this
637590Sgblack@eecs.umich.edu# 'gem5' directory (or use -u or -C to tell scons where to find this
647590Sgblack@eecs.umich.edu# file), you can use 'scons -h' to print all the gem5-specific build
657590Sgblack@eecs.umich.edu# options as well.
667590Sgblack@eecs.umich.edu#
677590Sgblack@eecs.umich.edu###################################################
687590Sgblack@eecs.umich.edu
697590Sgblack@eecs.umich.edu# Check for recent-enough Python and SCons versions.
707590Sgblack@eecs.umich.edutry:
717590Sgblack@eecs.umich.edu    # Really old versions of scons only take two options for the
728140SMatt.Horsnell@arm.com    # function, so check once without the revision and once with the
737590Sgblack@eecs.umich.edu    # revision, the first instance will fail for stuff other than
747590Sgblack@eecs.umich.edu    # 0.98, and the second will fail for 0.98.0
757590Sgblack@eecs.umich.edu    EnsureSConsVersion(0, 98)
767590Sgblack@eecs.umich.edu    EnsureSConsVersion(0, 98, 1)
777590Sgblack@eecs.umich.eduexcept SystemExit, e:
787590Sgblack@eecs.umich.edu    print """
797590Sgblack@eecs.umich.eduFor more details, see:
807590Sgblack@eecs.umich.edu    http://gem5.org/Dependencies
818140SMatt.Horsnell@arm.com"""
8210037SARM gem5 Developers    raise
8310037SARM gem5 Developers
847590Sgblack@eecs.umich.edu# We ensure the python version early because we have stuff that
857590Sgblack@eecs.umich.edu# requires python 2.4
867590Sgblack@eecs.umich.edutry:
877590Sgblack@eecs.umich.edu    EnsurePythonVersion(2, 4)
887590Sgblack@eecs.umich.eduexcept SystemExit, e:
897590Sgblack@eecs.umich.edu    print """
907590Sgblack@eecs.umich.eduYou can use a non-default installation of the Python interpreter by
917590Sgblack@eecs.umich.edueither (1) rearranging your PATH so that scons finds the non-default
927590Sgblack@eecs.umich.edu'python' first or (2) explicitly invoking an alternative interpreter
937590Sgblack@eecs.umich.eduon the scons script.
947590Sgblack@eecs.umich.edu
957590Sgblack@eecs.umich.eduFor more details, see:
967590Sgblack@eecs.umich.edu    http://gem5.org/wiki/index.php/Using_a_non-default_Python_installation
977590Sgblack@eecs.umich.edu"""
987590Sgblack@eecs.umich.edu    raise
997590Sgblack@eecs.umich.edu
1007590Sgblack@eecs.umich.edu# Global Python includes
1017590Sgblack@eecs.umich.eduimport os
1027590Sgblack@eecs.umich.eduimport re
1037590Sgblack@eecs.umich.eduimport subprocess
1047590Sgblack@eecs.umich.eduimport sys
1057590Sgblack@eecs.umich.edu
1067590Sgblack@eecs.umich.edufrom os import mkdir, environ
1077590Sgblack@eecs.umich.edufrom os.path import abspath, basename, dirname, expanduser, normpath
1087590Sgblack@eecs.umich.edufrom os.path import exists,  isdir, isfile
1097590Sgblack@eecs.umich.edufrom os.path import join as joinpath, split as splitpath
1107590Sgblack@eecs.umich.edu
1118303SAli.Saidi@ARM.com# SCons includes
1128303SAli.Saidi@ARM.comimport SCons
1138303SAli.Saidi@ARM.comimport SCons.Node
1148303SAli.Saidi@ARM.com
1158303SAli.Saidi@ARM.comextra_python_paths = [
1168588Sgblack@eecs.umich.edu    Dir('src/python').srcnode().abspath, # gem5 includes
1178588Sgblack@eecs.umich.edu    Dir('ext/ply').srcnode().abspath, # ply is used by several files
1187590Sgblack@eecs.umich.edu    ]
1197590Sgblack@eecs.umich.edu
1207590Sgblack@eecs.umich.edusys.path[1:1] = extra_python_paths
1217646Sgene.wu@arm.com
1228140SMatt.Horsnell@arm.comfrom m5.util import compareVersions, readCommand
1238140SMatt.Horsnell@arm.comfrom m5.util.terminal import get_termcap
1247646Sgene.wu@arm.com
1257646Sgene.wu@arm.comhelp_texts = {
1268140SMatt.Horsnell@arm.com    "options" : "",
1277590Sgblack@eecs.umich.edu    "global_vars" : "",
1287590Sgblack@eecs.umich.edu    "local_vars" : ""
1297590Sgblack@eecs.umich.edu}
1307590Sgblack@eecs.umich.edu
1317590Sgblack@eecs.umich.eduExport("help_texts")
1327590Sgblack@eecs.umich.edu
1337646Sgene.wu@arm.com
1347646Sgene.wu@arm.com# There's a bug in scons in that (1) by default, the help texts from
1357646Sgene.wu@arm.com# AddOption() are supposed to be displayed when you type 'scons -h'
1367646Sgene.wu@arm.com# and (2) you can override the help displayed by 'scons -h' using the
1377646Sgene.wu@arm.com# Help() function, but these two features are incompatible: once
1388203SAli.Saidi@ARM.com# you've overridden the help text using Help(), there's no way to get
1398203SAli.Saidi@ARM.com# at the help texts from AddOptions.  See:
1408203SAli.Saidi@ARM.com#     http://scons.tigris.org/issues/show_bug.cgi?id=2356
1418203SAli.Saidi@ARM.com#     http://scons.tigris.org/issues/show_bug.cgi?id=2611
1427590Sgblack@eecs.umich.edu# This hack lets us extract the help text from AddOptions and
1437590Sgblack@eecs.umich.edu# re-inject it via Help().  Ideally someday this bug will be fixed and
1447590Sgblack@eecs.umich.edu# we can just use AddOption directly.
1457590Sgblack@eecs.umich.edudef AddLocalOption(*args, **kwargs):
1468304SAli.Saidi@ARM.com    col_width = 30
1477646Sgene.wu@arm.com
1487646Sgene.wu@arm.com    help = "  " + ", ".join(args)
1497646Sgene.wu@arm.com    if "help" in kwargs:
1507646Sgene.wu@arm.com        length = len(help)
1517646Sgene.wu@arm.com        if length >= col_width:
1527646Sgene.wu@arm.com            help += "\n" + " " * col_width
1537646Sgene.wu@arm.com        else:
1547646Sgene.wu@arm.com            help += " " * (col_width - length)
1557590Sgblack@eecs.umich.edu        help += kwargs["help"]
1567590Sgblack@eecs.umich.edu    help_texts["options"] += help + "\n"
1577590Sgblack@eecs.umich.edu
1587590Sgblack@eecs.umich.edu    AddOption(*args, **kwargs)
1597590Sgblack@eecs.umich.edu
1607590Sgblack@eecs.umich.eduAddLocalOption('--colors', dest='use_colors', action='store_true',
1617590Sgblack@eecs.umich.edu               help="Add color to abbreviated scons output")
1627590Sgblack@eecs.umich.eduAddLocalOption('--no-colors', dest='use_colors', action='store_false',
1637590Sgblack@eecs.umich.edu               help="Don't add color to abbreviated scons output")
1647590Sgblack@eecs.umich.eduAddLocalOption('--default', dest='default', type='string', action='store',
16510037SARM gem5 Developers               help='Override which build_opts file to use for defaults')
1667590Sgblack@eecs.umich.eduAddLocalOption('--ignore-style', dest='ignore_style', action='store_true',
1677590Sgblack@eecs.umich.edu               help='Disable style checking hooks')
1687590Sgblack@eecs.umich.eduAddLocalOption('--no-lto', dest='no_lto', action='store_true',
1697725SAli.Saidi@ARM.com               help='Disable Link-Time Optimization for fast')
1707725SAli.Saidi@ARM.comAddLocalOption('--update-ref', dest='update_ref', action='store_true',
1717590Sgblack@eecs.umich.edu               help='Update test reference outputs')
1727725SAli.Saidi@ARM.comAddLocalOption('--verbose', dest='verbose', action='store_true',
1737725SAli.Saidi@ARM.com               help='Print full tool command lines')
1747725SAli.Saidi@ARM.com
1757725SAli.Saidi@ARM.comtermcap = get_termcap(GetOption('use_colors'))
1767590Sgblack@eecs.umich.edu
1777590Sgblack@eecs.umich.edu########################################################################
1787590Sgblack@eecs.umich.edu#
1797590Sgblack@eecs.umich.edu# Set up the main build environment.
1807590Sgblack@eecs.umich.edu#
1817590Sgblack@eecs.umich.edu########################################################################
1827590Sgblack@eecs.umich.eduuse_vars = set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH',
1837590Sgblack@eecs.umich.edu                 'LIBRARY_PATH', 'PATH', 'PYTHONPATH', 'RANLIB', 'SWIG' ])
1847590Sgblack@eecs.umich.edu
1857590Sgblack@eecs.umich.eduuse_env = {}
1867590Sgblack@eecs.umich.edufor key,val in os.environ.iteritems():
1877590Sgblack@eecs.umich.edu    if key in use_vars or key.startswith("M5"):
1887590Sgblack@eecs.umich.edu        use_env[key] = val
1897590Sgblack@eecs.umich.edu
1907590Sgblack@eecs.umich.edumain = Environment(ENV=use_env)
1917644Sali.saidi@arm.commain.Decider('MD5-timestamp')
1927644Sali.saidi@arm.commain.root = Dir(".")         # The current directory (where this file lives).
1937644Sali.saidi@arm.commain.srcdir = Dir("src")     # The source directory
1947644Sali.saidi@arm.com
1957590Sgblack@eecs.umich.edu# add useful python code PYTHONPATH so it can be used by subprocesses
1967590Sgblack@eecs.umich.edu# as well
1977590Sgblack@eecs.umich.edumain.AppendENVPath('PYTHONPATH', extra_python_paths)
1987725SAli.Saidi@ARM.com
1997590Sgblack@eecs.umich.edu########################################################################
2007590Sgblack@eecs.umich.edu#
2018588Sgblack@eecs.umich.edu# Mercurial Stuff.
2027590Sgblack@eecs.umich.edu#
2037590Sgblack@eecs.umich.edu# If the gem5 directory is a mercurial repository, we should do some
2047590Sgblack@eecs.umich.edu# extra things.
2057590Sgblack@eecs.umich.edu#
2067590Sgblack@eecs.umich.edu########################################################################
2077590Sgblack@eecs.umich.edu
2087590Sgblack@eecs.umich.eduhgdir = main.root.Dir(".hg")
2097590Sgblack@eecs.umich.edu
2107646Sgene.wu@arm.commercurial_style_message = """
2117646Sgene.wu@arm.comYou're missing the gem5 style hook, which automatically checks your code
2127646Sgene.wu@arm.comagainst the gem5 style rules on hg commit and qrefresh commands.  This
2137725SAli.Saidi@ARM.comscript will now install the hook in your .hg/hgrc file.
2147590Sgblack@eecs.umich.eduPress enter to continue, or ctrl-c to abort: """
2157590Sgblack@eecs.umich.edu
2167590Sgblack@eecs.umich.edumercurial_style_hook = """
2177590Sgblack@eecs.umich.edu# The following lines were automatically added by gem5/SConstruct
2187590Sgblack@eecs.umich.edu# to provide the gem5 style-checking hooks
2197646Sgene.wu@arm.com[extensions]
2207590Sgblack@eecs.umich.edustyle = %s/util/style.py
2217590Sgblack@eecs.umich.edu
2227590Sgblack@eecs.umich.edu[hooks]
2237590Sgblack@eecs.umich.edupretxncommit.style = python:style.check_style
2247590Sgblack@eecs.umich.edupre-qrefresh.style = python:style.check_style
2257590Sgblack@eecs.umich.edu# End of SConstruct additions
2267590Sgblack@eecs.umich.edu
2277646Sgene.wu@arm.com""" % (main.root.abspath)
2287590Sgblack@eecs.umich.edu
2297590Sgblack@eecs.umich.edumercurial_lib_not_found = """
2307590Sgblack@eecs.umich.eduMercurial libraries cannot be found, ignoring style hook.  If
2317590Sgblack@eecs.umich.eduyou are a gem5 developer, please fix this and run the style
2327590Sgblack@eecs.umich.eduhook. It is important.
2337590Sgblack@eecs.umich.edu"""
2347590Sgblack@eecs.umich.edu
2357590Sgblack@eecs.umich.edu# Check for style hook and prompt for installation if it's not there.
2367590Sgblack@eecs.umich.edu# Skip this if --ignore-style was specified, there's no .hg dir to
2377590Sgblack@eecs.umich.edu# install a hook in, or there's no interactive terminal to prompt.
2387590Sgblack@eecs.umich.eduif not GetOption('ignore_style') and hgdir.exists() and sys.stdin.isatty():
2397590Sgblack@eecs.umich.edu    style_hook = True
2407590Sgblack@eecs.umich.edu    try:
2417593SAli.Saidi@arm.com        from mercurial import ui
2427593SAli.Saidi@arm.com        ui = ui.ui()
2437593SAli.Saidi@arm.com        ui.readconfig(hgdir.File('hgrc').abspath)
2447590Sgblack@eecs.umich.edu        style_hook = ui.config('hooks', 'pretxncommit.style', None) and \
2457590Sgblack@eecs.umich.edu                     ui.config('hooks', 'pre-qrefresh.style', None)
2467590Sgblack@eecs.umich.edu    except ImportError:
2477590Sgblack@eecs.umich.edu        print mercurial_lib_not_found
2487590Sgblack@eecs.umich.edu
2497590Sgblack@eecs.umich.edu    if not style_hook:
2507590Sgblack@eecs.umich.edu        print mercurial_style_message,
2517590Sgblack@eecs.umich.edu        # continue unless user does ctrl-c/ctrl-d etc.
2527590Sgblack@eecs.umich.edu        try:
2537590Sgblack@eecs.umich.edu            raw_input()
2547590Sgblack@eecs.umich.edu        except:
2557644Sali.saidi@arm.com            print "Input exception, exiting scons.\n"
2567644Sali.saidi@arm.com            sys.exit(1)
2577644Sali.saidi@arm.com        hgrc_path = '%s/.hg/hgrc' % main.root.abspath
2587644Sali.saidi@arm.com        print "Adding style hook to", hgrc_path, "\n"
2597590Sgblack@eecs.umich.edu        try:
2607590Sgblack@eecs.umich.edu            hgrc = open(hgrc_path, 'a')
2617590Sgblack@eecs.umich.edu            hgrc.write(mercurial_style_hook)
2627590Sgblack@eecs.umich.edu            hgrc.close()
2637590Sgblack@eecs.umich.edu        except:
2647590Sgblack@eecs.umich.edu            print "Error updating", hgrc_path
2658588Sgblack@eecs.umich.edu            sys.exit(1)
2668588Sgblack@eecs.umich.edu
2677590Sgblack@eecs.umich.edu
2687590Sgblack@eecs.umich.edu###################################################
2697590Sgblack@eecs.umich.edu#
2708588Sgblack@eecs.umich.edu# Figure out which configurations to set up based on the path(s) of
2718588Sgblack@eecs.umich.edu# the target(s).
2728588Sgblack@eecs.umich.edu#
2737590Sgblack@eecs.umich.edu###################################################
2747590Sgblack@eecs.umich.edu
2757590Sgblack@eecs.umich.edu# Find default configuration & binary.
2767590Sgblack@eecs.umich.eduDefault(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug'))
2777590Sgblack@eecs.umich.edu
2787590Sgblack@eecs.umich.edu# helper function: find last occurrence of element in list
2797646Sgene.wu@arm.comdef rfind(l, elt, offs = -1):
2807646Sgene.wu@arm.com    for i in range(len(l)+offs, 0, -1):
2817646Sgene.wu@arm.com        if l[i] == elt:
2827646Sgene.wu@arm.com            return i
2837119Sgblack@eecs.umich.edu    raise ValueError, "element not found"
2847128Sgblack@eecs.umich.edu
2857128Sgblack@eecs.umich.edu# Take a list of paths (or SCons Nodes) and return a list with all
2867128Sgblack@eecs.umich.edu# paths made absolute and ~-expanded.  Paths will be interpreted
2877590Sgblack@eecs.umich.edu# relative to the launch directory unless a different root is provided
2887590Sgblack@eecs.umich.edudef makePathListAbsolute(path_list, root=GetLaunchDir()):
2897590Sgblack@eecs.umich.edu    return [abspath(joinpath(root, expanduser(str(p))))
2907590Sgblack@eecs.umich.edu            for p in path_list]
2917590Sgblack@eecs.umich.edu
2927128Sgblack@eecs.umich.edu# Each target must have 'build' in the interior of the path; the
2937128Sgblack@eecs.umich.edu# directory below this will determine the build parameters.  For
2947128Sgblack@eecs.umich.edu# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
2957590Sgblack@eecs.umich.edu# recognize that ALPHA_SE specifies the configuration because it
2967646Sgene.wu@arm.com# follow 'build' in the build path.
2977590Sgblack@eecs.umich.edu
2987590Sgblack@eecs.umich.edu# The funky assignment to "[:]" is needed to replace the list contents
2997128Sgblack@eecs.umich.edu# in place rather than reassign the symbol to a new list, which
3007119Sgblack@eecs.umich.edu# doesn't work (obviously!).
3017590Sgblack@eecs.umich.eduBUILD_TARGETS[:] = makePathListAbsolute(BUILD_TARGETS)
3027590Sgblack@eecs.umich.edu
3037590Sgblack@eecs.umich.edu# Generate a list of the unique build roots and configs that the
3047590Sgblack@eecs.umich.edu# collected targets reference.
3057590Sgblack@eecs.umich.eduvariant_paths = []
3067590Sgblack@eecs.umich.edubuild_root = None
3077590Sgblack@eecs.umich.edufor t in BUILD_TARGETS:
3087590Sgblack@eecs.umich.edu    path_dirs = t.split('/')
3097590Sgblack@eecs.umich.edu    try:
3107590Sgblack@eecs.umich.edu        build_top = rfind(path_dirs, 'build', -2)
3117590Sgblack@eecs.umich.edu    except:
3127590Sgblack@eecs.umich.edu        print "Error: no non-leaf 'build' dir found on target path", t
3137119Sgblack@eecs.umich.edu        Exit(1)
3147128Sgblack@eecs.umich.edu    this_build_root = joinpath('/',*path_dirs[:build_top+1])
3157590Sgblack@eecs.umich.edu    if not build_root:
3167590Sgblack@eecs.umich.edu        build_root = this_build_root
3177590Sgblack@eecs.umich.edu    else:
3187590Sgblack@eecs.umich.edu        if this_build_root != build_root:
3197590Sgblack@eecs.umich.edu            print "Error: build targets not under same build root\n"\
3207590Sgblack@eecs.umich.edu                  "  %s\n  %s" % (build_root, this_build_root)
3217590Sgblack@eecs.umich.edu            Exit(1)
3227590Sgblack@eecs.umich.edu    variant_path = joinpath('/',*path_dirs[:build_top+2])
3237590Sgblack@eecs.umich.edu    if variant_path not in variant_paths:
3247590Sgblack@eecs.umich.edu        variant_paths.append(variant_path)
3257590Sgblack@eecs.umich.edu
3267590Sgblack@eecs.umich.edu# Make sure build_root exists (might not if this is the first build there)
3277128Sgblack@eecs.umich.eduif not isdir(build_root):
3287292Sgblack@eecs.umich.edu    mkdir(build_root)
3297590Sgblack@eecs.umich.edumain['BUILDROOT'] = build_root
3307590Sgblack@eecs.umich.edu
3317590Sgblack@eecs.umich.eduExport('main')
3327590Sgblack@eecs.umich.edu
3337590Sgblack@eecs.umich.edumain.SConsignFile(joinpath(build_root, "sconsign"))
3347590Sgblack@eecs.umich.edu
3357590Sgblack@eecs.umich.edu# Default duplicate option is to use hard links, but this messes up
3367590Sgblack@eecs.umich.edu# when you use emacs to edit a file in the target dir, as emacs moves
3377292Sgblack@eecs.umich.edu# file to file~ then copies to file, breaking the link.  Symbolic
3387725SAli.Saidi@ARM.com# (soft) links work better.
3397725SAli.Saidi@ARM.commain.SetOption('duplicate', 'soft-copy')
3407725SAli.Saidi@ARM.com
3417725SAli.Saidi@ARM.com#
3427725SAli.Saidi@ARM.com# Set up global sticky variables... these are common to an entire build
3437192Sgblack@eecs.umich.edu# tree (not specific to a particular build like ALPHA_SE)
3447119Sgblack@eecs.umich.edu#
3457119Sgblack@eecs.umich.edu
3467119Sgblack@eecs.umich.eduglobal_vars_file = joinpath(build_root, 'variables.global')
3477119Sgblack@eecs.umich.edu
3487119Sgblack@eecs.umich.eduglobal_vars = Variables(global_vars_file, args=ARGUMENTS)
3497119Sgblack@eecs.umich.edu
3507119Sgblack@eecs.umich.eduglobal_vars.AddVariables(
3517119Sgblack@eecs.umich.edu    ('CC', 'C compiler', environ.get('CC', main['CC'])),
3527119Sgblack@eecs.umich.edu    ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])),
3537119Sgblack@eecs.umich.edu    ('SWIG', 'SWIG tool', environ.get('SWIG', main['SWIG'])),
3547128Sgblack@eecs.umich.edu    ('BATCH', 'Use batch pool for build and tests', False),
3557128Sgblack@eecs.umich.edu    ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
3567192Sgblack@eecs.umich.edu    ('M5_BUILD_CACHE', 'Cache built objects in this directory', False),
3577292Sgblack@eecs.umich.edu    ('EXTRAS', 'Add extra directories to the compilation', '')
3587292Sgblack@eecs.umich.edu    )
3597725SAli.Saidi@ARM.com
3607725SAli.Saidi@ARM.com# Update main environment with values from ARGUMENTS & global_vars_file
3617725SAli.Saidi@ARM.comglobal_vars.Update(main)
3627244Sgblack@eecs.umich.eduhelp_texts["global_vars"] += global_vars.GenerateHelpText(main)
3637590Sgblack@eecs.umich.edu
3647590Sgblack@eecs.umich.edu# Save sticky variable settings back to current variables file
3657590Sgblack@eecs.umich.eduglobal_vars.Save(global_vars_file, main)
3667590Sgblack@eecs.umich.edu
3677336Sgblack@eecs.umich.edu# Parse EXTRAS variable to build list of all directories where we're
3687590Sgblack@eecs.umich.edu# look for sources etc.  This list is exported as extras_dir_list.
3697590Sgblack@eecs.umich.edubase_dir = main.srcdir.abspath
3707590Sgblack@eecs.umich.eduif main['EXTRAS']:
3717590Sgblack@eecs.umich.edu    extras_dir_list = makePathListAbsolute(main['EXTRAS'].split(':'))
3727119Sgblack@eecs.umich.eduelse:
373    extras_dir_list = []
374
375Export('base_dir')
376Export('extras_dir_list')
377
378# the ext directory should be on the #includes path
379main.Append(CPPPATH=[Dir('ext')])
380
381def strip_build_path(path, env):
382    path = str(path)
383    variant_base = env['BUILDROOT'] + os.path.sep
384    if path.startswith(variant_base):
385        path = path[len(variant_base):]
386    elif path.startswith('build/'):
387        path = path[6:]
388    return path
389
390# Generate a string of the form:
391#   common/path/prefix/src1, src2 -> tgt1, tgt2
392# to print while building.
393class Transform(object):
394    # all specific color settings should be here and nowhere else
395    tool_color = termcap.Normal
396    pfx_color = termcap.Yellow
397    srcs_color = termcap.Yellow + termcap.Bold
398    arrow_color = termcap.Blue + termcap.Bold
399    tgts_color = termcap.Yellow + termcap.Bold
400
401    def __init__(self, tool, max_sources=99):
402        self.format = self.tool_color + (" [%8s] " % tool) \
403                      + self.pfx_color + "%s" \
404                      + self.srcs_color + "%s" \
405                      + self.arrow_color + " -> " \
406                      + self.tgts_color + "%s" \
407                      + termcap.Normal
408        self.max_sources = max_sources
409
410    def __call__(self, target, source, env, for_signature=None):
411        # truncate source list according to max_sources param
412        source = source[0:self.max_sources]
413        def strip(f):
414            return strip_build_path(str(f), env)
415        if len(source) > 0:
416            srcs = map(strip, source)
417        else:
418            srcs = ['']
419        tgts = map(strip, target)
420        # surprisingly, os.path.commonprefix is a dumb char-by-char string
421        # operation that has nothing to do with paths.
422        com_pfx = os.path.commonprefix(srcs + tgts)
423        com_pfx_len = len(com_pfx)
424        if com_pfx:
425            # do some cleanup and sanity checking on common prefix
426            if com_pfx[-1] == ".":
427                # prefix matches all but file extension: ok
428                # back up one to change 'foo.cc -> o' to 'foo.cc -> .o'
429                com_pfx = com_pfx[0:-1]
430            elif com_pfx[-1] == "/":
431                # common prefix is directory path: OK
432                pass
433            else:
434                src0_len = len(srcs[0])
435                tgt0_len = len(tgts[0])
436                if src0_len == com_pfx_len:
437                    # source is a substring of target, OK
438                    pass
439                elif tgt0_len == com_pfx_len:
440                    # target is a substring of source, need to back up to
441                    # avoid empty string on RHS of arrow
442                    sep_idx = com_pfx.rfind(".")
443                    if sep_idx != -1:
444                        com_pfx = com_pfx[0:sep_idx]
445                    else:
446                        com_pfx = ''
447                elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".":
448                    # still splitting at file extension: ok
449                    pass
450                else:
451                    # probably a fluke; ignore it
452                    com_pfx = ''
453        # recalculate length in case com_pfx was modified
454        com_pfx_len = len(com_pfx)
455        def fmt(files):
456            f = map(lambda s: s[com_pfx_len:], files)
457            return ', '.join(f)
458        return self.format % (com_pfx, fmt(srcs), fmt(tgts))
459
460Export('Transform')
461
462# enable the regression script to use the termcap
463main['TERMCAP'] = termcap
464
465if GetOption('verbose'):
466    def MakeAction(action, string, *args, **kwargs):
467        return Action(action, *args, **kwargs)
468else:
469    MakeAction = Action
470    main['CCCOMSTR']        = Transform("CC")
471    main['CXXCOMSTR']       = Transform("CXX")
472    main['ASCOMSTR']        = Transform("AS")
473    main['SWIGCOMSTR']      = Transform("SWIG")
474    main['ARCOMSTR']        = Transform("AR", 0)
475    main['LINKCOMSTR']      = Transform("LINK", 0)
476    main['RANLIBCOMSTR']    = Transform("RANLIB", 0)
477    main['M4COMSTR']        = Transform("M4")
478    main['SHCCCOMSTR']      = Transform("SHCC")
479    main['SHCXXCOMSTR']     = Transform("SHCXX")
480Export('MakeAction')
481
482# Initialize the Link-Time Optimization (LTO) flags
483main['LTO_CCFLAGS'] = []
484main['LTO_LDFLAGS'] = []
485
486CXX_version = readCommand([main['CXX'],'--version'], exception=False)
487CXX_V = readCommand([main['CXX'],'-V'], exception=False)
488
489main['GCC'] = CXX_version and CXX_version.find('g++') >= 0
490main['SUNCC'] = CXX_V and CXX_V.find('Sun C++') >= 0
491main['ICC'] = CXX_V and CXX_V.find('Intel') >= 0
492main['CLANG'] = CXX_version and CXX_version.find('clang') >= 0
493if main['GCC'] + main['SUNCC'] + main['ICC'] + main['CLANG'] > 1:
494    print 'Error: How can we have two at the same time?'
495    Exit(1)
496
497# Set up default C++ compiler flags
498if main['GCC']:
499    main.Append(CCFLAGS=['-pipe'])
500    main.Append(CCFLAGS=['-fno-strict-aliasing'])
501    main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef'])
502    # Read the GCC version to check for versions with bugs
503    # Note CCVERSION doesn't work here because it is run with the CC
504    # before we override it from the command line
505    gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False)
506    main['GCC_VERSION'] = gcc_version
507    if not compareVersions(gcc_version, '4.4.1') or \
508       not compareVersions(gcc_version, '4.4.2'):
509        print 'Info: Tree vectorizer in GCC 4.4.1 & 4.4.2 is buggy, disabling.'
510        main.Append(CCFLAGS=['-fno-tree-vectorize'])
511    # c++0x support in gcc is useful already from 4.4, see
512    # http://gcc.gnu.org/projects/cxx0x.html for details
513    if compareVersions(gcc_version, '4.4') >= 0:
514        main.Append(CXXFLAGS=['-std=c++0x'])
515
516    # LTO support is only really working properly from 4.6 and beyond
517    if compareVersions(gcc_version, '4.6') >= 0:
518        # Add the appropriate Link-Time Optimization (LTO) flags
519        # unless LTO is explicitly turned off. Note that these flags
520        # are only used by the fast target.
521        if not GetOption('no_lto'):
522            # Pass the LTO flag when compiling to produce GIMPLE
523            # output, we merely create the flags here and only append
524            # them later/
525            main['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
526
527            # Use the same amount of jobs for LTO as we are running
528            # scons with, we hardcode the use of the linker plugin
529            # which requires either gold or GNU ld >= 2.21
530            main['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs'),
531                                   '-fuse-linker-plugin']
532
533elif main['ICC']:
534    pass #Fix me... add warning flags once we clean up icc warnings
535elif main['SUNCC']:
536    main.Append(CCFLAGS=['-Qoption ccfe'])
537    main.Append(CCFLAGS=['-features=gcc'])
538    main.Append(CCFLAGS=['-features=extensions'])
539    main.Append(CCFLAGS=['-library=stlport4'])
540    main.Append(CCFLAGS=['-xar'])
541    #main.Append(CCFLAGS=['-instances=semiexplicit'])
542elif main['CLANG']:
543    clang_version_re = re.compile(".* version (\d+\.\d+)")
544    clang_version_match = clang_version_re.match(CXX_version)
545    if (clang_version_match):
546        clang_version = clang_version_match.groups()[0]
547        if compareVersions(clang_version, "2.9") < 0:
548            print 'Error: clang version 2.9 or newer required.'
549            print '       Installed version:', clang_version
550            Exit(1)
551    else:
552        print 'Error: Unable to determine clang version.'
553        Exit(1)
554
555    main.Append(CCFLAGS=['-pipe'])
556    main.Append(CCFLAGS=['-fno-strict-aliasing'])
557    main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef'])
558    main.Append(CCFLAGS=['-Wno-tautological-compare'])
559    main.Append(CCFLAGS=['-Wno-self-assign'])
560    # Ruby makes frequent use of extraneous parantheses in the printing
561    # of if-statements
562    main.Append(CCFLAGS=['-Wno-parentheses'])
563
564    # clang 2.9 does not play well with c++0x as it ships with C++
565    # headers that produce errors, this was fixed in 3.0
566    if compareVersions(clang_version, "3") >= 0:
567        main.Append(CXXFLAGS=['-std=c++0x'])
568else:
569    print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal,
570    print "Don't know what compiler options to use for your compiler."
571    print termcap.Yellow + '       compiler:' + termcap.Normal, main['CXX']
572    print termcap.Yellow + '       version:' + termcap.Normal,
573    if not CXX_version:
574        print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\
575               termcap.Normal
576    else:
577        print CXX_version.replace('\n', '<nl>')
578    print "       If you're trying to use a compiler other than GCC, ICC, SunCC,"
579    print "       or clang, there appears to be something wrong with your"
580    print "       environment."
581    print "       "
582    print "       If you are trying to use a compiler other than those listed"
583    print "       above you will need to ease fix SConstruct and "
584    print "       src/SConscript to support that compiler."
585    Exit(1)
586
587# Set up common yacc/bison flags (needed for Ruby)
588main['YACCFLAGS'] = '-d'
589main['YACCHXXFILESUFFIX'] = '.hh'
590
591# Do this after we save setting back, or else we'll tack on an
592# extra 'qdo' every time we run scons.
593if main['BATCH']:
594    main['CC']     = main['BATCH_CMD'] + ' ' + main['CC']
595    main['CXX']    = main['BATCH_CMD'] + ' ' + main['CXX']
596    main['AS']     = main['BATCH_CMD'] + ' ' + main['AS']
597    main['AR']     = main['BATCH_CMD'] + ' ' + main['AR']
598    main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB']
599
600if sys.platform == 'cygwin':
601    # cygwin has some header file issues...
602    main.Append(CCFLAGS=["-Wno-uninitialized"])
603
604# Check for SWIG
605if not main.has_key('SWIG'):
606    print 'Error: SWIG utility not found.'
607    print '       Please install (see http://www.swig.org) and retry.'
608    Exit(1)
609
610# Check for appropriate SWIG version
611swig_version = readCommand([main['SWIG'], '-version'], exception='').split()
612# First 3 words should be "SWIG Version x.y.z"
613if len(swig_version) < 3 or \
614        swig_version[0] != 'SWIG' or swig_version[1] != 'Version':
615    print 'Error determining SWIG version.'
616    Exit(1)
617
618min_swig_version = '1.3.34'
619if compareVersions(swig_version[2], min_swig_version) < 0:
620    print 'Error: SWIG version', min_swig_version, 'or newer required.'
621    print '       Installed version:', swig_version[2]
622    Exit(1)
623
624# Set up SWIG flags & scanner
625swig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
626main.Append(SWIGFLAGS=swig_flags)
627
628# filter out all existing swig scanners, they mess up the dependency
629# stuff for some reason
630scanners = []
631for scanner in main['SCANNERS']:
632    skeys = scanner.skeys
633    if skeys == '.i':
634        continue
635
636    if isinstance(skeys, (list, tuple)) and '.i' in skeys:
637        continue
638
639    scanners.append(scanner)
640
641# add the new swig scanner that we like better
642from SCons.Scanner import ClassicCPP as CPPScanner
643swig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
644scanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re))
645
646# replace the scanners list that has what we want
647main['SCANNERS'] = scanners
648
649# Add a custom Check function to the Configure context so that we can
650# figure out if the compiler adds leading underscores to global
651# variables.  This is needed for the autogenerated asm files that we
652# use for embedding the python code.
653def CheckLeading(context):
654    context.Message("Checking for leading underscore in global variables...")
655    # 1) Define a global variable called x from asm so the C compiler
656    #    won't change the symbol at all.
657    # 2) Declare that variable.
658    # 3) Use the variable
659    #
660    # If the compiler prepends an underscore, this will successfully
661    # link because the external symbol 'x' will be called '_x' which
662    # was defined by the asm statement.  If the compiler does not
663    # prepend an underscore, this will not successfully link because
664    # '_x' will have been defined by assembly, while the C portion of
665    # the code will be trying to use 'x'
666    ret = context.TryLink('''
667        asm(".globl _x; _x: .byte 0");
668        extern int x;
669        int main() { return x; }
670        ''', extension=".c")
671    context.env.Append(LEADING_UNDERSCORE=ret)
672    context.Result(ret)
673    return ret
674
675# Platform-specific configuration.  Note again that we assume that all
676# builds under a given build root run on the same host platform.
677conf = Configure(main,
678                 conf_dir = joinpath(build_root, '.scons_config'),
679                 log_file = joinpath(build_root, 'scons_config.log'),
680                 custom_tests = { 'CheckLeading' : CheckLeading })
681
682# Check for leading underscores.  Don't really need to worry either
683# way so don't need to check the return code.
684conf.CheckLeading()
685
686# Check if we should compile a 64 bit binary on Mac OS X/Darwin
687try:
688    import platform
689    uname = platform.uname()
690    if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0:
691        if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
692            main.Append(CCFLAGS=['-arch', 'x86_64'])
693            main.Append(CFLAGS=['-arch', 'x86_64'])
694            main.Append(LINKFLAGS=['-arch', 'x86_64'])
695            main.Append(ASFLAGS=['-arch', 'x86_64'])
696except:
697    pass
698
699# Recent versions of scons substitute a "Null" object for Configure()
700# when configuration isn't necessary, e.g., if the "--help" option is
701# present.  Unfortuantely this Null object always returns false,
702# breaking all our configuration checks.  We replace it with our own
703# more optimistic null object that returns True instead.
704if not conf:
705    def NullCheck(*args, **kwargs):
706        return True
707
708    class NullConf:
709        def __init__(self, env):
710            self.env = env
711        def Finish(self):
712            return self.env
713        def __getattr__(self, mname):
714            return NullCheck
715
716    conf = NullConf(main)
717
718# Find Python include and library directories for embedding the
719# interpreter.  For consistency, we will use the same Python
720# installation used to run scons (and thus this script).  If you want
721# to link in an alternate version, see above for instructions on how
722# to invoke scons with a different copy of the Python interpreter.
723from distutils import sysconfig
724
725py_getvar = sysconfig.get_config_var
726
727py_debug = getattr(sys, 'pydebug', False)
728py_version = 'python' + py_getvar('VERSION') + (py_debug and "_d" or "")
729
730py_general_include = sysconfig.get_python_inc()
731py_platform_include = sysconfig.get_python_inc(plat_specific=True)
732py_includes = [ py_general_include ]
733if py_platform_include != py_general_include:
734    py_includes.append(py_platform_include)
735
736py_lib_path = [ py_getvar('LIBDIR') ]
737# add the prefix/lib/pythonX.Y/config dir, but only if there is no
738# shared library in prefix/lib/.
739if not py_getvar('Py_ENABLE_SHARED'):
740    py_lib_path.append(py_getvar('LIBPL'))
741
742py_libs = []
743for lib in py_getvar('LIBS').split() + py_getvar('SYSLIBS').split():
744    if not lib.startswith('-l'):
745        # Python requires some special flags to link (e.g. -framework
746        # common on OS X systems), assume appending preserves order
747        main.Append(LINKFLAGS=[lib])
748    else:
749        lib = lib[2:]
750        if lib not in py_libs:
751            py_libs.append(lib)
752py_libs.append(py_version)
753
754main.Append(CPPPATH=py_includes)
755main.Append(LIBPATH=py_lib_path)
756
757# Cache build files in the supplied directory.
758if main['M5_BUILD_CACHE']:
759    print 'Using build cache located at', main['M5_BUILD_CACHE']
760    CacheDir(main['M5_BUILD_CACHE'])
761
762
763# verify that this stuff works
764if not conf.CheckHeader('Python.h', '<>'):
765    print "Error: can't find Python.h header in", py_includes
766    Exit(1)
767
768for lib in py_libs:
769    if not conf.CheckLib(lib):
770        print "Error: can't find library %s required by python" % lib
771        Exit(1)
772
773# On Solaris you need to use libsocket for socket ops
774if not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
775   if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
776       print "Can't find library with socket calls (e.g. accept())"
777       Exit(1)
778
779# Check for zlib.  If the check passes, libz will be automatically
780# added to the LIBS environment variable.
781if not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
782    print 'Error: did not find needed zlib compression library '\
783          'and/or zlib.h header file.'
784    print '       Please install zlib and try again.'
785    Exit(1)
786
787# Check for librt.
788have_posix_clock = \
789    conf.CheckLibWithHeader(None, 'time.h', 'C',
790                            'clock_nanosleep(0,0,NULL,NULL);') or \
791    conf.CheckLibWithHeader('rt', 'time.h', 'C',
792                            'clock_nanosleep(0,0,NULL,NULL);')
793
794if conf.CheckLib('tcmalloc_minimal'):
795    have_tcmalloc = True
796else:
797    have_tcmalloc = False
798    print termcap.Yellow + termcap.Bold + \
799          "You can get a 12% performance improvement by installing tcmalloc "\
800          "(libgoogle-perftools-dev package on Ubuntu or RedHat)." + \
801          termcap.Normal
802
803if not have_posix_clock:
804    print "Can't find library for POSIX clocks."
805
806# Check for <fenv.h> (C99 FP environment control)
807have_fenv = conf.CheckHeader('fenv.h', '<>')
808if not have_fenv:
809    print "Warning: Header file <fenv.h> not found."
810    print "         This host has no IEEE FP rounding mode control."
811
812######################################################################
813#
814# Finish the configuration
815#
816main = conf.Finish()
817
818######################################################################
819#
820# Collect all non-global variables
821#
822
823# Define the universe of supported ISAs
824all_isa_list = [ ]
825Export('all_isa_list')
826
827class CpuModel(object):
828    '''The CpuModel class encapsulates everything the ISA parser needs to
829    know about a particular CPU model.'''
830
831    # Dict of available CPU model objects.  Accessible as CpuModel.dict.
832    dict = {}
833    list = []
834    defaults = []
835
836    # Constructor.  Automatically adds models to CpuModel.dict.
837    def __init__(self, name, filename, includes, strings, default=False):
838        self.name = name           # name of model
839        self.filename = filename   # filename for output exec code
840        self.includes = includes   # include files needed in exec file
841        # The 'strings' dict holds all the per-CPU symbols we can
842        # substitute into templates etc.
843        self.strings = strings
844
845        # This cpu is enabled by default
846        self.default = default
847
848        # Add self to dict
849        if name in CpuModel.dict:
850            raise AttributeError, "CpuModel '%s' already registered" % name
851        CpuModel.dict[name] = self
852        CpuModel.list.append(name)
853
854Export('CpuModel')
855
856# Sticky variables get saved in the variables file so they persist from
857# one invocation to the next (unless overridden, in which case the new
858# value becomes sticky).
859sticky_vars = Variables(args=ARGUMENTS)
860Export('sticky_vars')
861
862# Sticky variables that should be exported
863export_vars = []
864Export('export_vars')
865
866# For Ruby
867all_protocols = []
868Export('all_protocols')
869protocol_dirs = []
870Export('protocol_dirs')
871slicc_includes = []
872Export('slicc_includes')
873
874# Walk the tree and execute all SConsopts scripts that wil add to the
875# above variables
876if not GetOption('verbose'):
877    print "Reading SConsopts"
878for bdir in [ base_dir ] + extras_dir_list:
879    if not isdir(bdir):
880        print "Error: directory '%s' does not exist" % bdir
881        Exit(1)
882    for root, dirs, files in os.walk(bdir):
883        if 'SConsopts' in files:
884            if GetOption('verbose'):
885                print "Reading", joinpath(root, 'SConsopts')
886            SConscript(joinpath(root, 'SConsopts'))
887
888all_isa_list.sort()
889
890sticky_vars.AddVariables(
891    EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list),
892    ListVariable('CPU_MODELS', 'CPU models',
893                 sorted(n for n,m in CpuModel.dict.iteritems() if m.default),
894                 sorted(CpuModel.list)),
895    BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
896                 False),
897    BoolVariable('SS_COMPATIBLE_FP',
898                 'Make floating-point results compatible with SimpleScalar',
899                 False),
900    BoolVariable('USE_SSE2',
901                 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
902                 False),
903    BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock),
904    BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
905    BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False),
906    EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None',
907                  all_protocols),
908    )
909
910# These variables get exported to #defines in config/*.hh (see src/SConscript).
911export_vars += ['USE_FENV', 'SS_COMPATIBLE_FP',
912                'TARGET_ISA', 'CP_ANNOTATE', 'USE_POSIX_CLOCK', 'PROTOCOL',
913               ]
914
915###################################################
916#
917# Define a SCons builder for configuration flag headers.
918#
919###################################################
920
921# This function generates a config header file that #defines the
922# variable symbol to the current variable setting (0 or 1).  The source
923# operands are the name of the variable and a Value node containing the
924# value of the variable.
925def build_config_file(target, source, env):
926    (variable, value) = [s.get_contents() for s in source]
927    f = file(str(target[0]), 'w')
928    print >> f, '#define', variable, value
929    f.close()
930    return None
931
932# Combine the two functions into a scons Action object.
933config_action = MakeAction(build_config_file, Transform("CONFIG H", 2))
934
935# The emitter munges the source & target node lists to reflect what
936# we're really doing.
937def config_emitter(target, source, env):
938    # extract variable name from Builder arg
939    variable = str(target[0])
940    # True target is config header file
941    target = joinpath('config', variable.lower() + '.hh')
942    val = env[variable]
943    if isinstance(val, bool):
944        # Force value to 0/1
945        val = int(val)
946    elif isinstance(val, str):
947        val = '"' + val + '"'
948
949    # Sources are variable name & value (packaged in SCons Value nodes)
950    return ([target], [Value(variable), Value(val)])
951
952config_builder = Builder(emitter = config_emitter, action = config_action)
953
954main.Append(BUILDERS = { 'ConfigFile' : config_builder })
955
956# libelf build is shared across all configs in the build root.
957main.SConscript('ext/libelf/SConscript',
958                variant_dir = joinpath(build_root, 'libelf'))
959
960# gzstream build is shared across all configs in the build root.
961main.SConscript('ext/gzstream/SConscript',
962                variant_dir = joinpath(build_root, 'gzstream'))
963
964###################################################
965#
966# This function is used to set up a directory with switching headers
967#
968###################################################
969
970main['ALL_ISA_LIST'] = all_isa_list
971def make_switching_dir(dname, switch_headers, env):
972    # Generate the header.  target[0] is the full path of the output
973    # header to generate.  'source' is a dummy variable, since we get the
974    # list of ISAs from env['ALL_ISA_LIST'].
975    def gen_switch_hdr(target, source, env):
976        fname = str(target[0])
977        f = open(fname, 'w')
978        isa = env['TARGET_ISA'].lower()
979        print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname))
980        f.close()
981
982    # Build SCons Action object. 'varlist' specifies env vars that this
983    # action depends on; when env['ALL_ISA_LIST'] changes these actions
984    # should get re-executed.
985    switch_hdr_action = MakeAction(gen_switch_hdr,
986                          Transform("GENERATE"), varlist=['ALL_ISA_LIST'])
987
988    # Instantiate actions for each header
989    for hdr in switch_headers:
990        env.Command(hdr, [], switch_hdr_action)
991Export('make_switching_dir')
992
993###################################################
994#
995# Define build environments for selected configurations.
996#
997###################################################
998
999for variant_path in variant_paths:
1000    print "Building in", variant_path
1001
1002    # Make a copy of the build-root environment to use for this config.
1003    env = main.Clone()
1004    env['BUILDDIR'] = variant_path
1005
1006    # variant_dir is the tail component of build path, and is used to
1007    # determine the build parameters (e.g., 'ALPHA_SE')
1008    (build_root, variant_dir) = splitpath(variant_path)
1009
1010    # Set env variables according to the build directory config.
1011    sticky_vars.files = []
1012    # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
1013    # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
1014    # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
1015    current_vars_file = joinpath(build_root, 'variables', variant_dir)
1016    if isfile(current_vars_file):
1017        sticky_vars.files.append(current_vars_file)
1018        print "Using saved variables file %s" % current_vars_file
1019    else:
1020        # Build dir-specific variables file doesn't exist.
1021
1022        # Make sure the directory is there so we can create it later
1023        opt_dir = dirname(current_vars_file)
1024        if not isdir(opt_dir):
1025            mkdir(opt_dir)
1026
1027        # Get default build variables from source tree.  Variables are
1028        # normally determined by name of $VARIANT_DIR, but can be
1029        # overridden by '--default=' arg on command line.
1030        default = GetOption('default')
1031        opts_dir = joinpath(main.root.abspath, 'build_opts')
1032        if default:
1033            default_vars_files = [joinpath(build_root, 'variables', default),
1034                                  joinpath(opts_dir, default)]
1035        else:
1036            default_vars_files = [joinpath(opts_dir, variant_dir)]
1037        existing_files = filter(isfile, default_vars_files)
1038        if existing_files:
1039            default_vars_file = existing_files[0]
1040            sticky_vars.files.append(default_vars_file)
1041            print "Variables file %s not found,\n  using defaults in %s" \
1042                  % (current_vars_file, default_vars_file)
1043        else:
1044            print "Error: cannot find variables file %s or " \
1045                  "default file(s) %s" \
1046                  % (current_vars_file, ' or '.join(default_vars_files))
1047            Exit(1)
1048
1049    # Apply current variable settings to env
1050    sticky_vars.Update(env)
1051
1052    help_texts["local_vars"] += \
1053        "Build variables for %s:\n" % variant_dir \
1054                 + sticky_vars.GenerateHelpText(env)
1055
1056    # Process variable settings.
1057
1058    if not have_fenv and env['USE_FENV']:
1059        print "Warning: <fenv.h> not available; " \
1060              "forcing USE_FENV to False in", variant_dir + "."
1061        env['USE_FENV'] = False
1062
1063    if not env['USE_FENV']:
1064        print "Warning: No IEEE FP rounding mode control in", variant_dir + "."
1065        print "         FP results may deviate slightly from other platforms."
1066
1067    if env['EFENCE']:
1068        env.Append(LIBS=['efence'])
1069
1070    # Save sticky variable settings back to current variables file
1071    sticky_vars.Save(current_vars_file, env)
1072
1073    if env['USE_SSE2']:
1074        env.Append(CCFLAGS=['-msse2'])
1075
1076    if have_tcmalloc:
1077        env.Append(LIBS=['tcmalloc_minimal'])
1078
1079    # The src/SConscript file sets up the build rules in 'env' according
1080    # to the configured variables.  It returns a list of environments,
1081    # one for each variant build (debug, opt, etc.)
1082    envList = SConscript('src/SConscript', variant_dir = variant_path,
1083                         exports = 'env')
1084
1085    # Set up the regression tests for each build.
1086    for e in envList:
1087        SConscript('tests/SConscript',
1088                   variant_dir = joinpath(variant_path, 'tests', e.Label),
1089                   exports = { 'env' : e }, duplicate = False)
1090
1091# base help text
1092Help('''
1093Usage: scons [scons options] [build variables] [target(s)]
1094
1095Extra scons options:
1096%(options)s
1097
1098Global build variables:
1099%(global_vars)s
1100
1101%(local_vars)s
1102''' % help_texts)
1103