SConstruct revision 7739
1955SN/A# -*- mode:python -*-
2955SN/A
35871Snate@binkert.org# Copyright (c) 2009 The Hewlett-Packard Development Company
41762SN/A# Copyright (c) 2004-2005 The Regents of The University of Michigan
5955SN/A# All rights reserved.
6955SN/A#
7955SN/A# Redistribution and use in source and binary forms, with or without
8955SN/A# modification, are permitted provided that the following conditions are
9955SN/A# met: redistributions of source code must retain the above copyright
10955SN/A# notice, this list of conditions and the following disclaimer;
11955SN/A# redistributions in binary form must reproduce the above copyright
12955SN/A# notice, this list of conditions and the following disclaimer in the
13955SN/A# documentation and/or other materials provided with the distribution;
14955SN/A# neither the name of the copyright holders nor the names of its
15955SN/A# contributors may be used to endorse or promote products derived from
16955SN/A# this software without specific prior written permission.
17955SN/A#
18955SN/A# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19955SN/A# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20955SN/A# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21955SN/A# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22955SN/A# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23955SN/A# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24955SN/A# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25955SN/A# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26955SN/A# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27955SN/A# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28955SN/A# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
292665Ssaidi@eecs.umich.edu#
302665Ssaidi@eecs.umich.edu# Authors: Steve Reinhardt
315863Snate@binkert.org#          Nathan Binkert
32955SN/A
33955SN/A###################################################
34955SN/A#
35955SN/A# SCons top-level build description (SConstruct) file.
36955SN/A#
372632Sstever@eecs.umich.edu# While in this directory ('m5'), just type 'scons' to build the default
382632Sstever@eecs.umich.edu# configuration (see below), or type 'scons build/<CONFIG>/<binary>'
392632Sstever@eecs.umich.edu# to build some other configuration (e.g., 'build/ALPHA_FS/m5.opt' for
402632Sstever@eecs.umich.edu# the optimized full-system version).
41955SN/A#
422632Sstever@eecs.umich.edu# You can build M5 in a different directory as long as there is a
432632Sstever@eecs.umich.edu# 'build/<CONFIG>' somewhere along the target path.  The build system
442761Sstever@eecs.umich.edu# expects that all configs under the same build directory are being
452632Sstever@eecs.umich.edu# built for the same host system.
462632Sstever@eecs.umich.edu#
472632Sstever@eecs.umich.edu# Examples:
482761Sstever@eecs.umich.edu#
492761Sstever@eecs.umich.edu#   The following two commands are equivalent.  The '-u' option tells
502761Sstever@eecs.umich.edu#   scons to search up the directory tree for this SConstruct file.
512632Sstever@eecs.umich.edu#   % cd <path-to-src>/m5 ; scons build/ALPHA_FS/m5.debug
522632Sstever@eecs.umich.edu#   % cd <path-to-src>/m5/build/ALPHA_FS; scons -u m5.debug
532761Sstever@eecs.umich.edu#
542761Sstever@eecs.umich.edu#   The following two commands are equivalent and demonstrate building
552761Sstever@eecs.umich.edu#   in a directory outside of the source tree.  The '-C' option tells
562761Sstever@eecs.umich.edu#   scons to chdir to the specified directory to find this SConstruct
572761Sstever@eecs.umich.edu#   file.
582632Sstever@eecs.umich.edu#   % cd <path-to-src>/m5 ; scons /local/foo/build/ALPHA_FS/m5.debug
592632Sstever@eecs.umich.edu#   % cd /local/foo/build/ALPHA_FS; scons -C <path-to-src>/m5 m5.debug
602632Sstever@eecs.umich.edu#
612632Sstever@eecs.umich.edu# You can use 'scons -H' to print scons options.  If you're in this
622632Sstever@eecs.umich.edu# 'm5' directory (or use -u or -C to tell scons where to find this
632632Sstever@eecs.umich.edu# file), you can use 'scons -h' to print all the M5-specific build
642632Sstever@eecs.umich.edu# options as well.
65955SN/A#
66955SN/A###################################################
67955SN/A
685863Snate@binkert.org# Check for recent-enough Python and SCons versions.
695863Snate@binkert.orgtry:
705863Snate@binkert.org    # Really old versions of scons only take two options for the
715863Snate@binkert.org    # function, so check once without the revision and once with the
725863Snate@binkert.org    # revision, the first instance will fail for stuff other than
735863Snate@binkert.org    # 0.98, and the second will fail for 0.98.0
745863Snate@binkert.org    EnsureSConsVersion(0, 98)
755863Snate@binkert.org    EnsureSConsVersion(0, 98, 1)
765863Snate@binkert.orgexcept SystemExit, e:
775863Snate@binkert.org    print """
785863Snate@binkert.orgFor more details, see:
795863Snate@binkert.org    http://m5sim.org/wiki/index.php/Compiling_M5
805863Snate@binkert.org"""
815863Snate@binkert.org    raise
825863Snate@binkert.org
835863Snate@binkert.org# We ensure the python version early because we have stuff that
845863Snate@binkert.org# requires python 2.4
855863Snate@binkert.orgtry:
865863Snate@binkert.org    EnsurePythonVersion(2, 4)
875863Snate@binkert.orgexcept SystemExit, e:
885863Snate@binkert.org    print """
895863Snate@binkert.orgYou can use a non-default installation of the Python interpreter by
905863Snate@binkert.orgeither (1) rearranging your PATH so that scons finds the non-default
915863Snate@binkert.org'python' first or (2) explicitly invoking an alternative interpreter
925863Snate@binkert.orgon the scons script.
935863Snate@binkert.org
945863Snate@binkert.orgFor more details, see:
955863Snate@binkert.org    http://m5sim.org/wiki/index.php/Using_a_non-default_Python_installation
965863Snate@binkert.org"""
975863Snate@binkert.org    raise
985863Snate@binkert.org
996654Snate@binkert.org# Global Python includes
100955SN/Aimport os
1015396Ssaidi@eecs.umich.eduimport re
1025863Snate@binkert.orgimport subprocess
1035863Snate@binkert.orgimport sys
1044202Sbinkertn@umich.edu
1055863Snate@binkert.orgfrom os import mkdir, environ
1065863Snate@binkert.orgfrom os.path import abspath, basename, dirname, expanduser, normpath
1075863Snate@binkert.orgfrom os.path import exists,  isdir, isfile
1085863Snate@binkert.orgfrom os.path import join as joinpath, split as splitpath
109955SN/A
1106654Snate@binkert.org# SCons includes
1115273Sstever@gmail.comimport SCons
1125871Snate@binkert.orgimport SCons.Node
1135273Sstever@gmail.com
1146655Snate@binkert.orgextra_python_paths = [
1156655Snate@binkert.org    Dir('src/python').srcnode().abspath, # M5 includes
1166655Snate@binkert.org    Dir('ext/ply').srcnode().abspath, # ply is used by several files
1176655Snate@binkert.org    ]
1186655Snate@binkert.org    
1196655Snate@binkert.orgsys.path[1:1] = extra_python_paths
1205871Snate@binkert.org
1216654Snate@binkert.orgfrom m5.util import compareVersions, readCommand
1225396Ssaidi@eecs.umich.edu
1235871Snate@binkert.org########################################################################
1245871Snate@binkert.org#
1256121Snate@binkert.org# Set up the main build environment.
1265871Snate@binkert.org#
1275871Snate@binkert.org########################################################################
1286003Snate@binkert.orguse_vars = set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH', 'PATH',
1296655Snate@binkert.org                 'PYTHONPATH', 'RANLIB' ])
130955SN/A
1315871Snate@binkert.orguse_env = {}
1325871Snate@binkert.orgfor key,val in os.environ.iteritems():
1335871Snate@binkert.org    if key in use_vars or key.startswith("M5"):
1345871Snate@binkert.org        use_env[key] = val
135955SN/A
1366121Snate@binkert.orgmain = Environment(ENV=use_env)
1376121Snate@binkert.orgmain.root = Dir(".")         # The current directory (where this file lives).
1386121Snate@binkert.orgmain.srcdir = Dir("src")     # The source directory
1391533SN/A
1406655Snate@binkert.org# add useful python code PYTHONPATH so it can be used by subprocesses
1416655Snate@binkert.org# as well
1426655Snate@binkert.orgmain.AppendENVPath('PYTHONPATH', extra_python_paths)
1436655Snate@binkert.org
1445871Snate@binkert.org########################################################################
1455871Snate@binkert.org#
1465863Snate@binkert.org# Mercurial Stuff.
1475871Snate@binkert.org#
1485871Snate@binkert.org# If the M5 directory is a mercurial repository, we should do some
1495871Snate@binkert.org# extra things.
1505871Snate@binkert.org#
1515871Snate@binkert.org########################################################################
1525863Snate@binkert.org
1536121Snate@binkert.orghgdir = main.root.Dir(".hg")
1545863Snate@binkert.org
1555871Snate@binkert.orgmercurial_style_message = """
1564678Snate@binkert.orgYou're missing the M5 style hook.
1574678Snate@binkert.orgPlease install the hook so we can ensure that all code fits a common style.
1584678Snate@binkert.org
1594678Snate@binkert.orgAll you'd need to do is add the following lines to your repository .hg/hgrc
1604678Snate@binkert.orgor your personal .hgrc
1614678Snate@binkert.org----------------
1624678Snate@binkert.org
1634678Snate@binkert.org[extensions]
1644678Snate@binkert.orgstyle = %s/util/style.py
1654678Snate@binkert.org
1664678Snate@binkert.org[hooks]
1674678Snate@binkert.orgpretxncommit.style = python:style.check_whitespace
1686121Snate@binkert.org""" % (main.root)
1694678Snate@binkert.org
1705871Snate@binkert.orgmercurial_bin_not_found = """
1715871Snate@binkert.orgMercurial binary cannot be found, unfortunately this means that we
1725871Snate@binkert.orgcannot easily determine the version of M5 that you are running and
1735871Snate@binkert.orgthis makes error messages more difficult to collect.  Please consider
1745871Snate@binkert.orginstalling mercurial if you choose to post an error message
1755871Snate@binkert.org"""
1765871Snate@binkert.org
1775871Snate@binkert.orgmercurial_lib_not_found = """
1785871Snate@binkert.orgMercurial libraries cannot be found, ignoring style hook
1795871Snate@binkert.orgIf you are actually a M5 developer, please fix this and
1805871Snate@binkert.orgrun the style hook. It is important.
1815871Snate@binkert.org"""
1825871Snate@binkert.org
1835990Ssaidi@eecs.umich.eduhg_info = "Unknown"
1845871Snate@binkert.orgif hgdir.exists():
1855871Snate@binkert.org    # 1) Grab repository revision if we know it.
1865871Snate@binkert.org    cmd = "hg id -n -i -t -b"
1874678Snate@binkert.org    try:
1886654Snate@binkert.org        hg_info = readCommand(cmd, cwd=main.root.abspath).strip()
1895871Snate@binkert.org    except OSError:
1905871Snate@binkert.org        print mercurial_bin_not_found
1915871Snate@binkert.org
1925871Snate@binkert.org    # 2) Ensure that the style hook is in place.
1935871Snate@binkert.org    try:
1945871Snate@binkert.org        ui = None
1955871Snate@binkert.org        if ARGUMENTS.get('IGNORE_STYLE') != 'True':
1965871Snate@binkert.org            from mercurial import ui
1975871Snate@binkert.org            ui = ui.ui()
1984678Snate@binkert.org    except ImportError:
1995871Snate@binkert.org        print mercurial_lib_not_found
2004678Snate@binkert.org
2015871Snate@binkert.org    if ui is not None:
2025871Snate@binkert.org        ui.readconfig(hgdir.File('hgrc').abspath)
2035871Snate@binkert.org        style_hook = ui.config('hooks', 'pretxncommit.style', None)
2045871Snate@binkert.org
2055871Snate@binkert.org        if not style_hook:
2065871Snate@binkert.org            print mercurial_style_message
2075871Snate@binkert.org            sys.exit(1)
2085871Snate@binkert.orgelse:
2095871Snate@binkert.org    print ".hg directory not found"
2106121Snate@binkert.org
2116121Snate@binkert.orgmain['HG_INFO'] = hg_info
2125863Snate@binkert.org
213955SN/A###################################################
214955SN/A#
2152632Sstever@eecs.umich.edu# Figure out which configurations to set up based on the path(s) of
2162632Sstever@eecs.umich.edu# the target(s).
217955SN/A#
218955SN/A###################################################
219955SN/A
220955SN/A# Find default configuration & binary.
2215863Snate@binkert.orgDefault(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA_SE/m5.debug'))
222955SN/A
2232632Sstever@eecs.umich.edu# helper function: find last occurrence of element in list
2242632Sstever@eecs.umich.edudef rfind(l, elt, offs = -1):
2252632Sstever@eecs.umich.edu    for i in range(len(l)+offs, 0, -1):
2262632Sstever@eecs.umich.edu        if l[i] == elt:
2272632Sstever@eecs.umich.edu            return i
2282632Sstever@eecs.umich.edu    raise ValueError, "element not found"
2292632Sstever@eecs.umich.edu
2302632Sstever@eecs.umich.edu# Each target must have 'build' in the interior of the path; the
2312632Sstever@eecs.umich.edu# directory below this will determine the build parameters.  For
2322632Sstever@eecs.umich.edu# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
2332632Sstever@eecs.umich.edu# recognize that ALPHA_SE specifies the configuration because it
2342632Sstever@eecs.umich.edu# follow 'build' in the bulid path.
2352632Sstever@eecs.umich.edu
2363718Sstever@eecs.umich.edu# Generate absolute paths to targets so we can see where the build dir is
2373718Sstever@eecs.umich.eduif COMMAND_LINE_TARGETS:
2383718Sstever@eecs.umich.edu    # Ask SCons which directory it was invoked from
2393718Sstever@eecs.umich.edu    launch_dir = GetLaunchDir()
2403718Sstever@eecs.umich.edu    # Make targets relative to invocation directory
2415863Snate@binkert.org    abs_targets = [ normpath(joinpath(launch_dir, str(x))) for x in \
2425863Snate@binkert.org                    COMMAND_LINE_TARGETS]
2433718Sstever@eecs.umich.eduelse:
2443718Sstever@eecs.umich.edu    # Default targets are relative to root of tree
2456121Snate@binkert.org    abs_targets = [ normpath(joinpath(main.root.abspath, str(x))) for x in \
2465863Snate@binkert.org                    DEFAULT_TARGETS]
2473718Sstever@eecs.umich.edu
2483718Sstever@eecs.umich.edu
2492634Sstever@eecs.umich.edu# Generate a list of the unique build roots and configs that the
2502634Sstever@eecs.umich.edu# collected targets reference.
2515863Snate@binkert.orgvariant_paths = []
2522638Sstever@eecs.umich.edubuild_root = None
2532632Sstever@eecs.umich.edufor t in abs_targets:
2542632Sstever@eecs.umich.edu    path_dirs = t.split('/')
2552632Sstever@eecs.umich.edu    try:
2562632Sstever@eecs.umich.edu        build_top = rfind(path_dirs, 'build', -2)
2572632Sstever@eecs.umich.edu    except:
2582632Sstever@eecs.umich.edu        print "Error: no non-leaf 'build' dir found on target path", t
2591858SN/A        Exit(1)
2603716Sstever@eecs.umich.edu    this_build_root = joinpath('/',*path_dirs[:build_top+1])
2612638Sstever@eecs.umich.edu    if not build_root:
2622638Sstever@eecs.umich.edu        build_root = this_build_root
2632638Sstever@eecs.umich.edu    else:
2642638Sstever@eecs.umich.edu        if this_build_root != build_root:
2652638Sstever@eecs.umich.edu            print "Error: build targets not under same build root\n"\
2662638Sstever@eecs.umich.edu                  "  %s\n  %s" % (build_root, this_build_root)
2672638Sstever@eecs.umich.edu            Exit(1)
2685863Snate@binkert.org    variant_path = joinpath('/',*path_dirs[:build_top+2])
2695863Snate@binkert.org    if variant_path not in variant_paths:
2705863Snate@binkert.org        variant_paths.append(variant_path)
271955SN/A
2725341Sstever@gmail.com# Make sure build_root exists (might not if this is the first build there)
2735341Sstever@gmail.comif not isdir(build_root):
2745863Snate@binkert.org    mkdir(build_root)
2755341Sstever@gmail.com
2766121Snate@binkert.orgExport('main')
2774494Ssaidi@eecs.umich.edu
2786121Snate@binkert.orgmain.SConsignFile(joinpath(build_root, "sconsign"))
2791105SN/A
2802667Sstever@eecs.umich.edu# Default duplicate option is to use hard links, but this messes up
2812667Sstever@eecs.umich.edu# when you use emacs to edit a file in the target dir, as emacs moves
2822667Sstever@eecs.umich.edu# file to file~ then copies to file, breaking the link.  Symbolic
2832667Sstever@eecs.umich.edu# (soft) links work better.
2846121Snate@binkert.orgmain.SetOption('duplicate', 'soft-copy')
2852667Sstever@eecs.umich.edu
2865341Sstever@gmail.com#
2875863Snate@binkert.org# Set up global sticky variables... these are common to an entire build
2885341Sstever@gmail.com# tree (not specific to a particular build like ALPHA_SE)
2895341Sstever@gmail.com#
2905341Sstever@gmail.com
2915863Snate@binkert.org# Variable validators & converters for global sticky variables
2925341Sstever@gmail.comdef PathListMakeAbsolute(val):
2935341Sstever@gmail.com    if not val:
2945341Sstever@gmail.com        return val
2955863Snate@binkert.org    f = lambda p: abspath(expanduser(p))
2965341Sstever@gmail.com    return ':'.join(map(f, val.split(':')))
2975341Sstever@gmail.com
2985341Sstever@gmail.comdef PathListAllExist(key, val, env):
2995341Sstever@gmail.com    if not val:
3005341Sstever@gmail.com        return
3015341Sstever@gmail.com    paths = val.split(':')
3025341Sstever@gmail.com    for path in paths:
3035341Sstever@gmail.com        if not isdir(path):
3045341Sstever@gmail.com            raise SCons.Errors.UserError("Path does not exist: '%s'" % path)
3055341Sstever@gmail.com
3065863Snate@binkert.orgglobal_sticky_vars_file = joinpath(build_root, 'variables.global')
3075341Sstever@gmail.com
3085863Snate@binkert.orgglobal_sticky_vars = Variables(global_sticky_vars_file, args=ARGUMENTS)
3095341Sstever@gmail.com
3105863Snate@binkert.orgglobal_sticky_vars.AddVariables(
3116121Snate@binkert.org    ('CC', 'C compiler', environ.get('CC', main['CC'])),
3126121Snate@binkert.org    ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])),
3135397Ssaidi@eecs.umich.edu    ('BATCH', 'Use batch pool for build and tests', False),
3145397Ssaidi@eecs.umich.edu    ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
3157727SAli.Saidi@ARM.com    ('M5_BUILD_CACHE', 'Cache built objects in this directory', False),
3165341Sstever@gmail.com    ('EXTRAS', 'Add Extra directories to the compilation', '',
3176168Snate@binkert.org     PathListAllExist, PathListMakeAbsolute),
3186168Snate@binkert.org    )
3195341Sstever@gmail.com
3205341Sstever@gmail.com# base help text
3215341Sstever@gmail.comhelp_text = '''
3225341Sstever@gmail.comUsage: scons [scons options] [build options] [target(s)]
3235341Sstever@gmail.com
3245863Snate@binkert.orgGlobal sticky options:
3255341Sstever@gmail.com'''
3265341Sstever@gmail.com
3276121Snate@binkert.org# Update main environment with values from ARGUMENTS & global_sticky_vars_file
3286121Snate@binkert.orgglobal_sticky_vars.Update(main)
3295341Sstever@gmail.com
3306814Sgblack@eecs.umich.eduhelp_text += global_sticky_vars.GenerateHelpText(main)
3316814Sgblack@eecs.umich.edu
3325863Snate@binkert.org# Save sticky variable settings back to current variables file
3336121Snate@binkert.orgglobal_sticky_vars.Save(global_sticky_vars_file, main)
3345341Sstever@gmail.com
3355863Snate@binkert.org# Parse EXTRAS variable to build list of all directories where we're
3365341Sstever@gmail.com# look for sources etc.  This list is exported as base_dir_list.
3376121Snate@binkert.orgbase_dir = main.srcdir.abspath
3386121Snate@binkert.orgif main['EXTRAS']:
3396121Snate@binkert.org    extras_dir_list = main['EXTRAS'].split(':')
3405742Snate@binkert.orgelse:
3415742Snate@binkert.org    extras_dir_list = []
3425341Sstever@gmail.com
3435742Snate@binkert.orgExport('base_dir')
3445742Snate@binkert.orgExport('extras_dir_list')
3455341Sstever@gmail.com
3466017Snate@binkert.org# the ext directory should be on the #includes path
3476121Snate@binkert.orgmain.Append(CPPPATH=[Dir('ext')])
3486017Snate@binkert.org
3496654Snate@binkert.orgCXX_version = readCommand([main['CXX'],'--version'], exception=False)
3506654Snate@binkert.orgCXX_V = readCommand([main['CXX'],'-V'], exception=False)
3515871Snate@binkert.org
3526121Snate@binkert.orgmain['GCC'] = CXX_version and CXX_version.find('g++') >= 0
3536121Snate@binkert.orgmain['SUNCC'] = CXX_V and CXX_V.find('Sun C++') >= 0
3546121Snate@binkert.orgmain['ICC'] = CXX_V and CXX_V.find('Intel') >= 0
3556121Snate@binkert.orgif main['GCC'] + main['SUNCC'] + main['ICC'] > 1:
3563940Ssaidi@eecs.umich.edu    print 'Error: How can we have two at the same time?'
3573918Ssaidi@eecs.umich.edu    Exit(1)
3583918Ssaidi@eecs.umich.edu
3591858SN/A# Set up default C++ compiler flags
3606121Snate@binkert.orgif main['GCC']:
3617739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=['-pipe'])
3627739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=['-fno-strict-aliasing'])
3636143Snate@binkert.org    main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef'])
3647739Sgblack@eecs.umich.edu    main.Append(CXXFLAGS=['-Wno-deprecated'])
3657618SAli.Saidi@arm.com    # Read the GCC version to check for versions with bugs
3667618SAli.Saidi@arm.com    # Note CCVERSION doesn't work here because it is run with the CC
3677618SAli.Saidi@arm.com    # before we override it from the command line
3687618SAli.Saidi@arm.com    gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False)
3697618SAli.Saidi@arm.com    if not compareVersions(gcc_version, '4.4.1') or \
3707618SAli.Saidi@arm.com       not compareVersions(gcc_version, '4.4.2'):
3717618SAli.Saidi@arm.com        print 'Info: Tree vectorizer in GCC 4.4.1 & 4.4.2 is buggy, disabling.'
3727739Sgblack@eecs.umich.edu        main.Append(CCFLAGS=['-fno-tree-vectorize'])
3736121Snate@binkert.orgelif main['ICC']:
3743940Ssaidi@eecs.umich.edu    pass #Fix me... add warning flags once we clean up icc warnings
3756121Snate@binkert.orgelif main['SUNCC']:
3767739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=['-Qoption ccfe'])
3777739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=['-features=gcc'])
3787739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=['-features=extensions'])
3797739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=['-library=stlport4'])
3807739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=['-xar'])
3817739Sgblack@eecs.umich.edu    #main.Append(CCFLAGS=['-instances=semiexplicit'])
3823918Ssaidi@eecs.umich.eduelse:
3833918Ssaidi@eecs.umich.edu    print 'Error: Don\'t know what compiler options to use for your compiler.'
3843940Ssaidi@eecs.umich.edu    print '       Please fix SConstruct and src/SConscript and try again.'
3853918Ssaidi@eecs.umich.edu    Exit(1)
3863918Ssaidi@eecs.umich.edu
3876157Snate@binkert.org# Set up common yacc/bison flags (needed for Ruby)
3886157Snate@binkert.orgmain['YACCFLAGS'] = '-d'
3896157Snate@binkert.orgmain['YACCHXXFILESUFFIX'] = '.hh'
3906157Snate@binkert.org
3915397Ssaidi@eecs.umich.edu# Do this after we save setting back, or else we'll tack on an
3925397Ssaidi@eecs.umich.edu# extra 'qdo' every time we run scons.
3936121Snate@binkert.orgif main['BATCH']:
3946121Snate@binkert.org    main['CC']     = main['BATCH_CMD'] + ' ' + main['CC']
3956121Snate@binkert.org    main['CXX']    = main['BATCH_CMD'] + ' ' + main['CXX']
3966121Snate@binkert.org    main['AS']     = main['BATCH_CMD'] + ' ' + main['AS']
3976121Snate@binkert.org    main['AR']     = main['BATCH_CMD'] + ' ' + main['AR']
3986121Snate@binkert.org    main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB']
3995397Ssaidi@eecs.umich.edu
4001851SN/Aif sys.platform == 'cygwin':
4011851SN/A    # cygwin has some header file issues...
4027739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=["-Wno-uninitialized"])
403955SN/A
4043053Sstever@eecs.umich.edu# Check for SWIG
4056121Snate@binkert.orgif not main.has_key('SWIG'):
4063053Sstever@eecs.umich.edu    print 'Error: SWIG utility not found.'
4073053Sstever@eecs.umich.edu    print '       Please install (see http://www.swig.org) and retry.'
4083053Sstever@eecs.umich.edu    Exit(1)
4093053Sstever@eecs.umich.edu
4103053Sstever@eecs.umich.edu# Check for appropriate SWIG version
4116654Snate@binkert.orgswig_version = readCommand(('swig', '-version'), exception='').split()
4123053Sstever@eecs.umich.edu# First 3 words should be "SWIG Version x.y.z"
4134742Sstever@eecs.umich.eduif len(swig_version) < 3 or \
4144742Sstever@eecs.umich.edu        swig_version[0] != 'SWIG' or swig_version[1] != 'Version':
4153053Sstever@eecs.umich.edu    print 'Error determining SWIG version.'
4163053Sstever@eecs.umich.edu    Exit(1)
4173053Sstever@eecs.umich.edu
4183053Sstever@eecs.umich.edumin_swig_version = '1.3.28'
4196654Snate@binkert.orgif compareVersions(swig_version[2], min_swig_version) < 0:
4203053Sstever@eecs.umich.edu    print 'Error: SWIG version', min_swig_version, 'or newer required.'
4213053Sstever@eecs.umich.edu    print '       Installed version:', swig_version[2]
4223053Sstever@eecs.umich.edu    Exit(1)
4233053Sstever@eecs.umich.edu
4242667Sstever@eecs.umich.edu# Set up SWIG flags & scanner
4254554Sbinkertn@umich.eduswig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
4266121Snate@binkert.orgmain.Append(SWIGFLAGS=swig_flags)
4272667Sstever@eecs.umich.edu
4284554Sbinkertn@umich.edu# filter out all existing swig scanners, they mess up the dependency
4294554Sbinkertn@umich.edu# stuff for some reason
4304554Sbinkertn@umich.eduscanners = []
4316121Snate@binkert.orgfor scanner in main['SCANNERS']:
4324554Sbinkertn@umich.edu    skeys = scanner.skeys
4334554Sbinkertn@umich.edu    if skeys == '.i':
4344554Sbinkertn@umich.edu        continue
4354781Snate@binkert.org
4364554Sbinkertn@umich.edu    if isinstance(skeys, (list, tuple)) and '.i' in skeys:
4374554Sbinkertn@umich.edu        continue
4382667Sstever@eecs.umich.edu
4394554Sbinkertn@umich.edu    scanners.append(scanner)
4404554Sbinkertn@umich.edu
4414554Sbinkertn@umich.edu# add the new swig scanner that we like better
4424554Sbinkertn@umich.edufrom SCons.Scanner import ClassicCPP as CPPScanner
4432667Sstever@eecs.umich.eduswig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
4444554Sbinkertn@umich.eduscanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re))
4452667Sstever@eecs.umich.edu
4464554Sbinkertn@umich.edu# replace the scanners list that has what we want
4476121Snate@binkert.orgmain['SCANNERS'] = scanners
4482667Sstever@eecs.umich.edu
4495522Snate@binkert.org# Add a custom Check function to the Configure context so that we can
4505522Snate@binkert.org# figure out if the compiler adds leading underscores to global
4515522Snate@binkert.org# variables.  This is needed for the autogenerated asm files that we
4525522Snate@binkert.org# use for embedding the python code.
4535522Snate@binkert.orgdef CheckLeading(context):
4545522Snate@binkert.org    context.Message("Checking for leading underscore in global variables...")
4555522Snate@binkert.org    # 1) Define a global variable called x from asm so the C compiler
4565522Snate@binkert.org    #    won't change the symbol at all.
4575522Snate@binkert.org    # 2) Declare that variable.
4585522Snate@binkert.org    # 3) Use the variable
4595522Snate@binkert.org    #
4605522Snate@binkert.org    # If the compiler prepends an underscore, this will successfully
4615522Snate@binkert.org    # link because the external symbol 'x' will be called '_x' which
4625522Snate@binkert.org    # was defined by the asm statement.  If the compiler does not
4635522Snate@binkert.org    # prepend an underscore, this will not successfully link because
4645522Snate@binkert.org    # '_x' will have been defined by assembly, while the C portion of
4655522Snate@binkert.org    # the code will be trying to use 'x'
4665522Snate@binkert.org    ret = context.TryLink('''
4675522Snate@binkert.org        asm(".globl _x; _x: .byte 0");
4685522Snate@binkert.org        extern int x;
4695522Snate@binkert.org        int main() { return x; }
4705522Snate@binkert.org        ''', extension=".c")
4715522Snate@binkert.org    context.env.Append(LEADING_UNDERSCORE=ret)
4725522Snate@binkert.org    context.Result(ret)
4735522Snate@binkert.org    return ret
4745522Snate@binkert.org
4752638Sstever@eecs.umich.edu# Platform-specific configuration.  Note again that we assume that all
4762638Sstever@eecs.umich.edu# builds under a given build root run on the same host platform.
4776121Snate@binkert.orgconf = Configure(main,
4783716Sstever@eecs.umich.edu                 conf_dir = joinpath(build_root, '.scons_config'),
4795522Snate@binkert.org                 log_file = joinpath(build_root, 'scons_config.log'),
4805522Snate@binkert.org                 custom_tests = { 'CheckLeading' : CheckLeading })
4815522Snate@binkert.org
4825522Snate@binkert.org# Check for leading underscores.  Don't really need to worry either
4835522Snate@binkert.org# way so don't need to check the return code.
4845522Snate@binkert.orgconf.CheckLeading()
4851858SN/A
4865227Ssaidi@eecs.umich.edu# Check if we should compile a 64 bit binary on Mac OS X/Darwin
4875227Ssaidi@eecs.umich.edutry:
4885227Ssaidi@eecs.umich.edu    import platform
4895227Ssaidi@eecs.umich.edu    uname = platform.uname()
4906654Snate@binkert.org    if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0:
4916654Snate@binkert.org        if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
4927739Sgblack@eecs.umich.edu            main.Append(CCFLAGS=['-arch x86_64'])
4937739Sgblack@eecs.umich.edu            main.Append(CFLAGS=['-arch x86_64'])
4947739Sgblack@eecs.umich.edu            main.Append(LINKFLAGS=['-arch x86_64'])
4957739Sgblack@eecs.umich.edu            main.Append(ASFLAGS=['-arch x86_64'])
4965227Ssaidi@eecs.umich.eduexcept:
4975227Ssaidi@eecs.umich.edu    pass
4985227Ssaidi@eecs.umich.edu
4995204Sstever@gmail.com# Recent versions of scons substitute a "Null" object for Configure()
5005204Sstever@gmail.com# when configuration isn't necessary, e.g., if the "--help" option is
5015204Sstever@gmail.com# present.  Unfortuantely this Null object always returns false,
5025204Sstever@gmail.com# breaking all our configuration checks.  We replace it with our own
5035204Sstever@gmail.com# more optimistic null object that returns True instead.
5045204Sstever@gmail.comif not conf:
5055204Sstever@gmail.com    def NullCheck(*args, **kwargs):
5065204Sstever@gmail.com        return True
5075204Sstever@gmail.com
5085204Sstever@gmail.com    class NullConf:
5095204Sstever@gmail.com        def __init__(self, env):
5105204Sstever@gmail.com            self.env = env
5115204Sstever@gmail.com        def Finish(self):
5125204Sstever@gmail.com            return self.env
5135204Sstever@gmail.com        def __getattr__(self, mname):
5145204Sstever@gmail.com            return NullCheck
5155204Sstever@gmail.com
5166121Snate@binkert.org    conf = NullConf(main)
5175204Sstever@gmail.com
5183118Sstever@eecs.umich.edu# Find Python include and library directories for embedding the
5193118Sstever@eecs.umich.edu# interpreter.  For consistency, we will use the same Python
5203118Sstever@eecs.umich.edu# installation used to run scons (and thus this script).  If you want
5213118Sstever@eecs.umich.edu# to link in an alternate version, see above for instructions on how
5223118Sstever@eecs.umich.edu# to invoke scons with a different copy of the Python interpreter.
5235863Snate@binkert.orgfrom distutils import sysconfig
5243118Sstever@eecs.umich.edu
5255863Snate@binkert.orgpy_getvar = sysconfig.get_config_var
5263118Sstever@eecs.umich.edu
5277457Snate@binkert.orgpy_debug = getattr(sys, 'pydebug', False)
5287457Snate@binkert.orgpy_version = 'python' + py_getvar('VERSION') + (py_debug and "_d" or "")
5295863Snate@binkert.org
5305863Snate@binkert.orgpy_general_include = sysconfig.get_python_inc()
5315863Snate@binkert.orgpy_platform_include = sysconfig.get_python_inc(plat_specific=True)
5325863Snate@binkert.orgpy_includes = [ py_general_include ]
5335863Snate@binkert.orgif py_platform_include != py_general_include:
5345863Snate@binkert.org    py_includes.append(py_platform_include)
5355863Snate@binkert.org
5366003Snate@binkert.orgpy_lib_path = [ py_getvar('LIBDIR') ]
5375863Snate@binkert.org# add the prefix/lib/pythonX.Y/config dir, but only if there is no
5385863Snate@binkert.org# shared library in prefix/lib/.
5395863Snate@binkert.orgif not py_getvar('Py_ENABLE_SHARED'):
5406120Snate@binkert.org    py_lib_path.append(py_getvar('LIBPL'))
5415863Snate@binkert.org
5425863Snate@binkert.orgpy_libs = []
5435863Snate@binkert.orgfor lib in py_getvar('LIBS').split() + py_getvar('SYSLIBS').split():
5446120Snate@binkert.org    assert lib.startswith('-l')
5456120Snate@binkert.org    lib = lib[2:]   
5465863Snate@binkert.org    if lib not in py_libs:
5475863Snate@binkert.org        py_libs.append(lib)
5486120Snate@binkert.orgpy_libs.append(py_version)
5495863Snate@binkert.org
5506121Snate@binkert.orgmain.Append(CPPPATH=py_includes)
5516121Snate@binkert.orgmain.Append(LIBPATH=py_lib_path)
5525863Snate@binkert.org
5537727SAli.Saidi@ARM.com# Cache build files in the supplied directory.
5547727SAli.Saidi@ARM.comif main['M5_BUILD_CACHE']:
5557727SAli.Saidi@ARM.com    print 'Using build cache located at', main['M5_BUILD_CACHE']
5567727SAli.Saidi@ARM.com    CacheDir(main['M5_BUILD_CACHE'])
5577727SAli.Saidi@ARM.com
5587727SAli.Saidi@ARM.com
5595863Snate@binkert.org# verify that this stuff works
5603118Sstever@eecs.umich.eduif not conf.CheckHeader('Python.h', '<>'):
5615863Snate@binkert.org    print "Error: can't find Python.h header in", py_includes
5623118Sstever@eecs.umich.edu    Exit(1)
5633118Sstever@eecs.umich.edu
5645863Snate@binkert.orgfor lib in py_libs:
5655863Snate@binkert.org    if not conf.CheckLib(lib):
5665863Snate@binkert.org        print "Error: can't find library %s required by python" % lib
5675863Snate@binkert.org        Exit(1)
5683118Sstever@eecs.umich.edu
5693483Ssaidi@eecs.umich.edu# On Solaris you need to use libsocket for socket ops
5703494Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
5713494Ssaidi@eecs.umich.edu   if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
5723483Ssaidi@eecs.umich.edu       print "Can't find library with socket calls (e.g. accept())"
5733483Ssaidi@eecs.umich.edu       Exit(1)
5743483Ssaidi@eecs.umich.edu
5753053Sstever@eecs.umich.edu# Check for zlib.  If the check passes, libz will be automatically
5763053Sstever@eecs.umich.edu# added to the LIBS environment variable.
5773918Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
5783053Sstever@eecs.umich.edu    print 'Error: did not find needed zlib compression library '\
5793053Sstever@eecs.umich.edu          'and/or zlib.h header file.'
5803053Sstever@eecs.umich.edu    print '       Please install zlib and try again.'
5813053Sstever@eecs.umich.edu    Exit(1)
5823053Sstever@eecs.umich.edu
5831858SN/A# Check for <fenv.h> (C99 FP environment control)
5841858SN/Ahave_fenv = conf.CheckHeader('fenv.h', '<>')
5851858SN/Aif not have_fenv:
5861858SN/A    print "Warning: Header file <fenv.h> not found."
5871858SN/A    print "         This host has no IEEE FP rounding mode control."
5881858SN/A
5895863Snate@binkert.org######################################################################
5905863Snate@binkert.org#
5911859SN/A# Check for mysql.
5925863Snate@binkert.org#
5931858SN/Amysql_config = WhereIs('mysql_config')
5945863Snate@binkert.orghave_mysql = bool(mysql_config)
5951858SN/A
5961859SN/A# Check MySQL version.
5971859SN/Aif have_mysql:
5986654Snate@binkert.org    mysql_version = readCommand(mysql_config + ' --version')
5993053Sstever@eecs.umich.edu    min_mysql_version = '4.1'
6006654Snate@binkert.org    if compareVersions(mysql_version, min_mysql_version) < 0:
6013053Sstever@eecs.umich.edu        print 'Warning: MySQL', min_mysql_version, 'or newer required.'
6023053Sstever@eecs.umich.edu        print '         Version', mysql_version, 'detected.'
6031859SN/A        have_mysql = False
6041859SN/A
6051859SN/A# Set up mysql_config commands.
6061859SN/Aif have_mysql:
6071859SN/A    mysql_config_include = mysql_config + ' --include'
6081859SN/A    if os.system(mysql_config_include + ' > /dev/null') != 0:
6091859SN/A        # older mysql_config versions don't support --include, use
6101859SN/A        # --cflags instead
6111862SN/A        mysql_config_include = mysql_config + ' --cflags | sed s/\\\'//g'
6121859SN/A    # This seems to work in all versions
6131859SN/A    mysql_config_libs = mysql_config + ' --libs'
6141859SN/A
6155863Snate@binkert.org######################################################################
6165863Snate@binkert.org#
6175863Snate@binkert.org# Finish the configuration
6185863Snate@binkert.org#
6196121Snate@binkert.orgmain = conf.Finish()
6201858SN/A
6215863Snate@binkert.org######################################################################
6225863Snate@binkert.org#
6235863Snate@binkert.org# Collect all non-global variables
6245863Snate@binkert.org#
6255863Snate@binkert.org
6262139SN/A# Define the universe of supported ISAs
6274202Sbinkertn@umich.eduall_isa_list = [ ]
6284202Sbinkertn@umich.eduExport('all_isa_list')
6292139SN/A
6306994Snate@binkert.orgclass CpuModel(object):
6316994Snate@binkert.org    '''The CpuModel class encapsulates everything the ISA parser needs to
6326994Snate@binkert.org    know about a particular CPU model.'''
6336994Snate@binkert.org
6346994Snate@binkert.org    # Dict of available CPU model objects.  Accessible as CpuModel.dict.
6356994Snate@binkert.org    dict = {}
6366994Snate@binkert.org    list = []
6376994Snate@binkert.org    defaults = []
6386994Snate@binkert.org
6396994Snate@binkert.org    # Constructor.  Automatically adds models to CpuModel.dict.
6406994Snate@binkert.org    def __init__(self, name, filename, includes, strings, default=False):
6416994Snate@binkert.org        self.name = name           # name of model
6426994Snate@binkert.org        self.filename = filename   # filename for output exec code
6436994Snate@binkert.org        self.includes = includes   # include files needed in exec file
6446994Snate@binkert.org        # The 'strings' dict holds all the per-CPU symbols we can
6456994Snate@binkert.org        # substitute into templates etc.
6466994Snate@binkert.org        self.strings = strings
6476994Snate@binkert.org
6486994Snate@binkert.org        # This cpu is enabled by default
6496994Snate@binkert.org        self.default = default
6506994Snate@binkert.org
6516994Snate@binkert.org        # Add self to dict
6526994Snate@binkert.org        if name in CpuModel.dict:
6536994Snate@binkert.org            raise AttributeError, "CpuModel '%s' already registered" % name
6546994Snate@binkert.org        CpuModel.dict[name] = self
6556994Snate@binkert.org        CpuModel.list.append(name)
6566994Snate@binkert.org
6576994Snate@binkert.orgExport('CpuModel')
6582155SN/A
6595863Snate@binkert.org# Sticky variables get saved in the variables file so they persist from
6601869SN/A# one invocation to the next (unless overridden, in which case the new
6611869SN/A# value becomes sticky).
6625863Snate@binkert.orgsticky_vars = Variables(args=ARGUMENTS)
6635863Snate@binkert.orgExport('sticky_vars')
6644202Sbinkertn@umich.edu
6656108Snate@binkert.org# Sticky variables that should be exported
6666108Snate@binkert.orgexport_vars = []
6676108Snate@binkert.orgExport('export_vars')
6686108Snate@binkert.org
6695863Snate@binkert.org# Non-sticky variables only apply to the current build.
6705863Snate@binkert.orgnonsticky_vars = Variables(args=ARGUMENTS)
6715863Snate@binkert.orgExport('nonsticky_vars')
6724202Sbinkertn@umich.edu
6734202Sbinkertn@umich.edu# Walk the tree and execute all SConsopts scripts that wil add to the
6745863Snate@binkert.org# above variables
6755742Snate@binkert.orgfor bdir in [ base_dir ] + extras_dir_list:
6765742Snate@binkert.org    for root, dirs, files in os.walk(bdir):
6775341Sstever@gmail.com        if 'SConsopts' in files:
6785342Sstever@gmail.com            print "Reading", joinpath(root, 'SConsopts')
6795342Sstever@gmail.com            SConscript(joinpath(root, 'SConsopts'))
6804202Sbinkertn@umich.edu
6814202Sbinkertn@umich.eduall_isa_list.sort()
6824202Sbinkertn@umich.edu
6835863Snate@binkert.orgsticky_vars.AddVariables(
6845863Snate@binkert.org    EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list),
6855863Snate@binkert.org    BoolVariable('FULL_SYSTEM', 'Full-system support', False),
6866994Snate@binkert.org    ListVariable('CPU_MODELS', 'CPU models',
6876994Snate@binkert.org                 sorted(n for n,m in CpuModel.dict.iteritems() if m.default),
6886994Snate@binkert.org                 sorted(CpuModel.list)),
6895863Snate@binkert.org    BoolVariable('NO_FAST_ALLOC', 'Disable fast object allocator', False),
6905863Snate@binkert.org    BoolVariable('FAST_ALLOC_DEBUG', 'Enable fast object allocator debugging',
6915863Snate@binkert.org                 False),
6925863Snate@binkert.org    BoolVariable('FAST_ALLOC_STATS', 'Enable fast object allocator statistics',
6935863Snate@binkert.org                 False),
6945863Snate@binkert.org    BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
6955863Snate@binkert.org                 False),
6965863Snate@binkert.org    BoolVariable('SS_COMPATIBLE_FP',
6975863Snate@binkert.org                 'Make floating-point results compatible with SimpleScalar',
6985863Snate@binkert.org                 False),
6995863Snate@binkert.org    BoolVariable('USE_SSE2',
7005863Snate@binkert.org                 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
7015863Snate@binkert.org                 False),
7025863Snate@binkert.org    BoolVariable('USE_MYSQL', 'Use MySQL for stats output', have_mysql),
7035863Snate@binkert.org    BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
7045863Snate@binkert.org    BoolVariable('USE_CHECKER', 'Use checker for detailed CPU models', False),
7055952Ssaidi@eecs.umich.edu    BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False),
7067450Sstever@gmail.com    BoolVariable('RUBY', 'Build with Ruby', False),
7071869SN/A    )
7081858SN/A
7095863Snate@binkert.orgnonsticky_vars.AddVariables(
7105863Snate@binkert.org    BoolVariable('update_ref', 'Update test reference outputs', False)
7111869SN/A    )
7121858SN/A
7135863Snate@binkert.org# These variables get exported to #defines in config/*.hh (see src/SConscript).
7146108Snate@binkert.orgexport_vars += ['FULL_SYSTEM', 'USE_FENV', 'USE_MYSQL',
7156108Snate@binkert.org                'NO_FAST_ALLOC', 'FAST_ALLOC_DEBUG', 'FAST_ALLOC_STATS',
7166108Snate@binkert.org                'SS_COMPATIBLE_FP', 'USE_CHECKER', 'TARGET_ISA', 'CP_ANNOTATE']
7171858SN/A
718955SN/A###################################################
719955SN/A#
7201869SN/A# Define a SCons builder for configuration flag headers.
7211869SN/A#
7221869SN/A###################################################
7231869SN/A
7241869SN/A# This function generates a config header file that #defines the
7255863Snate@binkert.org# variable symbol to the current variable setting (0 or 1).  The source
7265863Snate@binkert.org# operands are the name of the variable and a Value node containing the
7275863Snate@binkert.org# value of the variable.
7281869SN/Adef build_config_file(target, source, env):
7295863Snate@binkert.org    (variable, value) = [s.get_contents() for s in source]
7301869SN/A    f = file(str(target[0]), 'w')
7315863Snate@binkert.org    print >> f, '#define', variable, value
7321869SN/A    f.close()
7331869SN/A    return None
7341869SN/A
7351869SN/A# Generate the message to be printed when building the config file.
7361869SN/Adef build_config_file_string(target, source, env):
7375863Snate@binkert.org    (variable, value) = [s.get_contents() for s in source]
7385863Snate@binkert.org    return "Defining %s as %s in %s." % (variable, value, target[0])
7391869SN/A
7401869SN/A# Combine the two functions into a scons Action object.
7411869SN/Aconfig_action = Action(build_config_file, build_config_file_string)
7421869SN/A
7431869SN/A# The emitter munges the source & target node lists to reflect what
7441869SN/A# we're really doing.
7451869SN/Adef config_emitter(target, source, env):
7465863Snate@binkert.org    # extract variable name from Builder arg
7475863Snate@binkert.org    variable = str(target[0])
7481869SN/A    # True target is config header file
7495863Snate@binkert.org    target = joinpath('config', variable.lower() + '.hh')
7505863Snate@binkert.org    val = env[variable]
7513356Sbinkertn@umich.edu    if isinstance(val, bool):
7523356Sbinkertn@umich.edu        # Force value to 0/1
7533356Sbinkertn@umich.edu        val = int(val)
7543356Sbinkertn@umich.edu    elif isinstance(val, str):
7553356Sbinkertn@umich.edu        val = '"' + val + '"'
7564781Snate@binkert.org
7575863Snate@binkert.org    # Sources are variable name & value (packaged in SCons Value nodes)
7585863Snate@binkert.org    return ([target], [Value(variable), Value(val)])
7591869SN/A
7601869SN/Aconfig_builder = Builder(emitter = config_emitter, action = config_action)
7611869SN/A
7626121Snate@binkert.orgmain.Append(BUILDERS = { 'ConfigFile' : config_builder })
7631869SN/A
7642638Sstever@eecs.umich.edu# libelf build is shared across all configs in the build root.
7656121Snate@binkert.orgmain.SConscript('ext/libelf/SConscript',
7666121Snate@binkert.org                variant_dir = joinpath(build_root, 'libelf'))
7672638Sstever@eecs.umich.edu
7685749Scws3k@cs.virginia.edu# gzstream build is shared across all configs in the build root.
7696121Snate@binkert.orgmain.SConscript('ext/gzstream/SConscript',
7706121Snate@binkert.org                variant_dir = joinpath(build_root, 'gzstream'))
7715749Scws3k@cs.virginia.edu
7721869SN/A###################################################
7731869SN/A#
7743546Sgblack@eecs.umich.edu# This function is used to set up a directory with switching headers
7753546Sgblack@eecs.umich.edu#
7763546Sgblack@eecs.umich.edu###################################################
7773546Sgblack@eecs.umich.edu
7786121Snate@binkert.orgmain['ALL_ISA_LIST'] = all_isa_list
7795863Snate@binkert.orgdef make_switching_dir(dname, switch_headers, env):
7803546Sgblack@eecs.umich.edu    # Generate the header.  target[0] is the full path of the output
7813546Sgblack@eecs.umich.edu    # header to generate.  'source' is a dummy variable, since we get the
7823546Sgblack@eecs.umich.edu    # list of ISAs from env['ALL_ISA_LIST'].
7833546Sgblack@eecs.umich.edu    def gen_switch_hdr(target, source, env):
7844781Snate@binkert.org        fname = str(target[0])
7854781Snate@binkert.org        f = open(fname, 'w')
7866658Snate@binkert.org        isa = env['TARGET_ISA'].lower()
7876658Snate@binkert.org        print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname))
7884781Snate@binkert.org        f.close()
7893546Sgblack@eecs.umich.edu
7903546Sgblack@eecs.umich.edu    # String to print when generating header
7913546Sgblack@eecs.umich.edu    def gen_switch_hdr_string(target, source, env):
7924781Snate@binkert.org        return "Generating switch header " + str(target[0])
7933546Sgblack@eecs.umich.edu
7943546Sgblack@eecs.umich.edu    # Build SCons Action object. 'varlist' specifies env vars that this
7953546Sgblack@eecs.umich.edu    # action depends on; when env['ALL_ISA_LIST'] changes these actions
7963546Sgblack@eecs.umich.edu    # should get re-executed.
7973546Sgblack@eecs.umich.edu    switch_hdr_action = Action(gen_switch_hdr, gen_switch_hdr_string,
7983546Sgblack@eecs.umich.edu                               varlist=['ALL_ISA_LIST'])
7993546Sgblack@eecs.umich.edu
8003546Sgblack@eecs.umich.edu    # Instantiate actions for each header
8013546Sgblack@eecs.umich.edu    for hdr in switch_headers:
8023546Sgblack@eecs.umich.edu        env.Command(hdr, [], switch_hdr_action)
8034202Sbinkertn@umich.eduExport('make_switching_dir')
8043546Sgblack@eecs.umich.edu
8053546Sgblack@eecs.umich.edu###################################################
8063546Sgblack@eecs.umich.edu#
807955SN/A# Define build environments for selected configurations.
808955SN/A#
809955SN/A###################################################
810955SN/A
8115863Snate@binkert.orgfor variant_path in variant_paths:
8125863Snate@binkert.org    print "Building in", variant_path
8135343Sstever@gmail.com
8145343Sstever@gmail.com    # Make a copy of the build-root environment to use for this config.
8156121Snate@binkert.org    env = main.Clone()
8165863Snate@binkert.org    env['BUILDDIR'] = variant_path
8174773Snate@binkert.org
8185863Snate@binkert.org    # variant_dir is the tail component of build path, and is used to
8192632Sstever@eecs.umich.edu    # determine the build parameters (e.g., 'ALPHA_SE')
8205863Snate@binkert.org    (build_root, variant_dir) = splitpath(variant_path)
8212023SN/A
8225863Snate@binkert.org    # Set env variables according to the build directory config.
8235863Snate@binkert.org    sticky_vars.files = []
8245863Snate@binkert.org    # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
8255863Snate@binkert.org    # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
8265863Snate@binkert.org    # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
8275863Snate@binkert.org    current_vars_file = joinpath(build_root, 'variables', variant_dir)
8285863Snate@binkert.org    if isfile(current_vars_file):
8295863Snate@binkert.org        sticky_vars.files.append(current_vars_file)
8305863Snate@binkert.org        print "Using saved variables file %s" % current_vars_file
8312632Sstever@eecs.umich.edu    else:
8325863Snate@binkert.org        # Build dir-specific variables file doesn't exist.
8332023SN/A
8342632Sstever@eecs.umich.edu        # Make sure the directory is there so we can create it later
8355863Snate@binkert.org        opt_dir = dirname(current_vars_file)
8365342Sstever@gmail.com        if not isdir(opt_dir):
8375863Snate@binkert.org            mkdir(opt_dir)
8382632Sstever@eecs.umich.edu
8395863Snate@binkert.org        # Get default build variables from source tree.  Variables are
8405863Snate@binkert.org        # normally determined by name of $VARIANT_DIR, but can be
8412632Sstever@eecs.umich.edu        # overriden by 'default=' arg on command line.
8425863Snate@binkert.org        default_vars_file = joinpath('build_opts',
8435863Snate@binkert.org                                     ARGUMENTS.get('default', variant_dir))
8445863Snate@binkert.org        if isfile(default_vars_file):
8455863Snate@binkert.org            sticky_vars.files.append(default_vars_file)
8465863Snate@binkert.org            print "Variables file %s not found,\n  using defaults in %s" \
8475863Snate@binkert.org                  % (current_vars_file, default_vars_file)
8482632Sstever@eecs.umich.edu        else:
8495863Snate@binkert.org            print "Error: cannot find variables file %s or %s" \
8505863Snate@binkert.org                  % (current_vars_file, default_vars_file)
8512632Sstever@eecs.umich.edu            Exit(1)
8521888SN/A
8535863Snate@binkert.org    # Apply current variable settings to env
8545863Snate@binkert.org    sticky_vars.Update(env)
8555863Snate@binkert.org    nonsticky_vars.Update(env)
8561858SN/A
8575863Snate@binkert.org    help_text += "\nSticky variables for %s:\n" % variant_dir \
8585863Snate@binkert.org                 + sticky_vars.GenerateHelpText(env) \
8595863Snate@binkert.org                 + "\nNon-sticky variables for %s:\n" % variant_dir \
8605863Snate@binkert.org                 + nonsticky_vars.GenerateHelpText(env)
8612598SN/A
8625863Snate@binkert.org    # Process variable settings.
8631858SN/A
8641858SN/A    if not have_fenv and env['USE_FENV']:
8651858SN/A        print "Warning: <fenv.h> not available; " \
8665863Snate@binkert.org              "forcing USE_FENV to False in", variant_dir + "."
8671858SN/A        env['USE_FENV'] = False
8681858SN/A
8691858SN/A    if not env['USE_FENV']:
8705863Snate@binkert.org        print "Warning: No IEEE FP rounding mode control in", variant_dir + "."
8711871SN/A        print "         FP results may deviate slightly from other platforms."
8721858SN/A
8731858SN/A    if env['EFENCE']:
8741858SN/A        env.Append(LIBS=['efence'])
8751858SN/A
8761858SN/A    if env['USE_MYSQL']:
8771858SN/A        if not have_mysql:
8781858SN/A            print "Warning: MySQL not available; " \
8795863Snate@binkert.org                  "forcing USE_MYSQL to False in", variant_dir + "."
8801858SN/A            env['USE_MYSQL'] = False
8811858SN/A        else:
8825863Snate@binkert.org            print "Compiling in", variant_dir, "with MySQL support."
8831859SN/A            env.ParseConfig(mysql_config_libs)
8841859SN/A            env.ParseConfig(mysql_config_include)
8851869SN/A
8865863Snate@binkert.org    # Save sticky variable settings back to current variables file
8875863Snate@binkert.org    sticky_vars.Save(current_vars_file, env)
8881869SN/A
8891965SN/A    if env['USE_SSE2']:
8907739Sgblack@eecs.umich.edu        env.Append(CCFLAGS=['-msse2'])
8911965SN/A
8922761Sstever@eecs.umich.edu    # The src/SConscript file sets up the build rules in 'env' according
8935863Snate@binkert.org    # to the configured variables.  It returns a list of environments,
8941869SN/A    # one for each variant build (debug, opt, etc.)
8955863Snate@binkert.org    envList = SConscript('src/SConscript', variant_dir = variant_path,
8962667Sstever@eecs.umich.edu                         exports = 'env')
8971869SN/A
8981869SN/A    # Set up the regression tests for each build.
8992929Sktlim@umich.edu    for e in envList:
9002929Sktlim@umich.edu        SConscript('tests/SConscript',
9015863Snate@binkert.org                   variant_dir = joinpath(variant_path, 'tests', e.Label),
9022929Sktlim@umich.edu                   exports = { 'env' : e }, duplicate = False)
903955SN/A
9042598SN/AHelp(help_text)
905