SConstruct revision 5990
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
99955SN/Aimport os
1005396Ssaidi@eecs.umich.eduimport re
1015863Snate@binkert.orgimport subprocess
1025863Snate@binkert.orgimport sys
1034202Sbinkertn@umich.edu
1045863Snate@binkert.orgfrom os import mkdir, environ
1055863Snate@binkert.orgfrom os.path import abspath, basename, dirname, expanduser, normpath
1065863Snate@binkert.orgfrom os.path import exists,  isdir, isfile
1075863Snate@binkert.orgfrom os.path import join as joinpath, split as splitpath
108955SN/A
1095273Sstever@gmail.comimport SCons
1105871Snate@binkert.orgimport SCons.Node
1115273Sstever@gmail.com
1125871Snate@binkert.orgdef read_command(cmd, **kwargs):
1135863Snate@binkert.org    """run the command cmd, read the results and return them
1145863Snate@binkert.org    this is sorta like `cmd` in shell"""
1155863Snate@binkert.org    from subprocess import Popen, PIPE, STDOUT
1165871Snate@binkert.org
1175872Snate@binkert.org    if isinstance(cmd, str):
1185872Snate@binkert.org        cmd = cmd.split()
1195872Snate@binkert.org
1205871Snate@binkert.org    no_exception = 'exception' in kwargs
1215871Snate@binkert.org    exception = kwargs.pop('exception', None)
1225871Snate@binkert.org    
1235871Snate@binkert.org    kwargs.setdefault('shell', False)
1245871Snate@binkert.org    kwargs.setdefault('stdout', PIPE)
1255871Snate@binkert.org    kwargs.setdefault('stderr', STDOUT)
1265871Snate@binkert.org    kwargs.setdefault('close_fds', True)
1275871Snate@binkert.org    try:
1285871Snate@binkert.org        subp = Popen(cmd, **kwargs)
1295871Snate@binkert.org    except Exception, e:
1305871Snate@binkert.org        if no_exception:
1315871Snate@binkert.org            return exception
1325871Snate@binkert.org        raise
1335871Snate@binkert.org
1345863Snate@binkert.org    return subp.communicate()[0]
1355227Ssaidi@eecs.umich.edu
1365396Ssaidi@eecs.umich.edu# helper function: compare arrays or strings of version numbers.
1375396Ssaidi@eecs.umich.edu# E.g., compare_version((1,3,25), (1,4,1)')
1385396Ssaidi@eecs.umich.edu# returns -1, 0, 1 if v1 is <, ==, > v2
1395396Ssaidi@eecs.umich.edudef compare_versions(v1, v2):
1405396Ssaidi@eecs.umich.edu    def make_version_list(v):
1415396Ssaidi@eecs.umich.edu        if isinstance(v, (list,tuple)):
1425396Ssaidi@eecs.umich.edu            return v
1435396Ssaidi@eecs.umich.edu        elif isinstance(v, str):
1445588Ssaidi@eecs.umich.edu            return map(lambda x: int(re.match('\d+', x).group()), v.split('.'))
1455396Ssaidi@eecs.umich.edu        else:
1465396Ssaidi@eecs.umich.edu            raise TypeError
1475396Ssaidi@eecs.umich.edu
1485396Ssaidi@eecs.umich.edu    v1 = make_version_list(v1)
1495396Ssaidi@eecs.umich.edu    v2 = make_version_list(v2)
1505396Ssaidi@eecs.umich.edu    # Compare corresponding elements of lists
1515396Ssaidi@eecs.umich.edu    for n1,n2 in zip(v1, v2):
1525396Ssaidi@eecs.umich.edu        if n1 < n2: return -1
1535396Ssaidi@eecs.umich.edu        if n1 > n2: return  1
1545396Ssaidi@eecs.umich.edu    # all corresponding values are equal... see if one has extra values
1555396Ssaidi@eecs.umich.edu    if len(v1) < len(v2): return -1
1565396Ssaidi@eecs.umich.edu    if len(v1) > len(v2): return  1
1575396Ssaidi@eecs.umich.edu    return 0
1585396Ssaidi@eecs.umich.edu
1595871Snate@binkert.org########################################################################
1605871Snate@binkert.org#
1615871Snate@binkert.org# Set up the base build environment.
1625871Snate@binkert.org#
1635871Snate@binkert.org########################################################################
1645871Snate@binkert.orguse_vars = set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'PATH', 'RANLIB' ])
165955SN/A
1665871Snate@binkert.orguse_env = {}
1675871Snate@binkert.orgfor key,val in os.environ.iteritems():
1685871Snate@binkert.org    if key in use_vars or key.startswith("M5"):
1695871Snate@binkert.org        use_env[key] = val
170955SN/A
1715871Snate@binkert.orgenv = Environment(ENV=use_env)
1725871Snate@binkert.orgenv.root = Dir(".")          # The current directory (where this file lives).
1735871Snate@binkert.orgenv.srcdir = Dir("src")      # The source directory
1741533SN/A
1755871Snate@binkert.org########################################################################
1765871Snate@binkert.org#
1775863Snate@binkert.org# Mercurial Stuff.
1785871Snate@binkert.org#
1795871Snate@binkert.org# If the M5 directory is a mercurial repository, we should do some
1805871Snate@binkert.org# extra things.
1815871Snate@binkert.org#
1825871Snate@binkert.org########################################################################
1835863Snate@binkert.org
1845871Snate@binkert.orghgdir = env.root.Dir(".hg")
1855863Snate@binkert.org
1865871Snate@binkert.orgmercurial_style_message = """
1874678Snate@binkert.orgYou're missing the M5 style hook.
1884678Snate@binkert.orgPlease install the hook so we can ensure that all code fits a common style.
1894678Snate@binkert.org
1904678Snate@binkert.orgAll you'd need to do is add the following lines to your repository .hg/hgrc
1914678Snate@binkert.orgor your personal .hgrc
1924678Snate@binkert.org----------------
1934678Snate@binkert.org
1944678Snate@binkert.org[extensions]
1954678Snate@binkert.orgstyle = %s/util/style.py
1964678Snate@binkert.org
1974678Snate@binkert.org[hooks]
1984678Snate@binkert.orgpretxncommit.style = python:style.check_whitespace
1995871Snate@binkert.org""" % (env.root)
2004678Snate@binkert.org
2015871Snate@binkert.orgmercurial_bin_not_found = """
2025871Snate@binkert.orgMercurial binary cannot be found, unfortunately this means that we
2035871Snate@binkert.orgcannot easily determine the version of M5 that you are running and
2045871Snate@binkert.orgthis makes error messages more difficult to collect.  Please consider
2055871Snate@binkert.orginstalling mercurial if you choose to post an error message
2065871Snate@binkert.org"""
2075871Snate@binkert.org
2085871Snate@binkert.orgmercurial_lib_not_found = """
2095871Snate@binkert.orgMercurial libraries cannot be found, ignoring style hook
2105871Snate@binkert.orgIf you are actually a M5 developer, please fix this and
2115871Snate@binkert.orgrun the style hook. It is important.
2125871Snate@binkert.org"""
2135871Snate@binkert.org
2145990Ssaidi@eecs.umich.eduhg_info = "Unknown"
2155871Snate@binkert.orgif hgdir.exists():
2165871Snate@binkert.org    # 1) Grab repository revision if we know it.
2175871Snate@binkert.org    cmd = "hg id -n -i -t -b"
2184678Snate@binkert.org    try:
2195871Snate@binkert.org        hg_info = read_command(cmd, cwd=env.root.abspath).strip()
2205871Snate@binkert.org    except OSError:
2215871Snate@binkert.org        print mercurial_bin_not_found
2225871Snate@binkert.org
2235871Snate@binkert.org    # 2) Ensure that the style hook is in place.
2245871Snate@binkert.org    try:
2255871Snate@binkert.org        ui = None
2265871Snate@binkert.org        if ARGUMENTS.get('IGNORE_STYLE') != 'True':
2275871Snate@binkert.org            from mercurial import ui
2285871Snate@binkert.org            ui = ui.ui()
2294678Snate@binkert.org    except ImportError:
2305871Snate@binkert.org        print mercurial_lib_not_found
2314678Snate@binkert.org
2325871Snate@binkert.org    if ui is not None:
2335871Snate@binkert.org        ui.readconfig(hgdir.File('hgrc').abspath)
2345871Snate@binkert.org        style_hook = ui.config('hooks', 'pretxncommit.style', None)
2355871Snate@binkert.org
2365871Snate@binkert.org        if not style_hook:
2375871Snate@binkert.org            print mercurial_style_message
2385871Snate@binkert.org            sys.exit(1)
2395871Snate@binkert.orgelse:
2405871Snate@binkert.org    print ".hg directory not found"
2415990Ssaidi@eecs.umich.eduenv['HG_INFO'] = hg_info
2425863Snate@binkert.org
243955SN/A###################################################
244955SN/A#
2452632Sstever@eecs.umich.edu# Figure out which configurations to set up based on the path(s) of
2462632Sstever@eecs.umich.edu# the target(s).
247955SN/A#
248955SN/A###################################################
249955SN/A
250955SN/A# Find default configuration & binary.
2515863Snate@binkert.orgDefault(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA_SE/m5.debug'))
252955SN/A
2532632Sstever@eecs.umich.edu# helper function: find last occurrence of element in list
2542632Sstever@eecs.umich.edudef rfind(l, elt, offs = -1):
2552632Sstever@eecs.umich.edu    for i in range(len(l)+offs, 0, -1):
2562632Sstever@eecs.umich.edu        if l[i] == elt:
2572632Sstever@eecs.umich.edu            return i
2582632Sstever@eecs.umich.edu    raise ValueError, "element not found"
2592632Sstever@eecs.umich.edu
2602632Sstever@eecs.umich.edu# Each target must have 'build' in the interior of the path; the
2612632Sstever@eecs.umich.edu# directory below this will determine the build parameters.  For
2622632Sstever@eecs.umich.edu# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
2632632Sstever@eecs.umich.edu# recognize that ALPHA_SE specifies the configuration because it
2642632Sstever@eecs.umich.edu# follow 'build' in the bulid path.
2652632Sstever@eecs.umich.edu
2663718Sstever@eecs.umich.edu# Generate absolute paths to targets so we can see where the build dir is
2673718Sstever@eecs.umich.eduif COMMAND_LINE_TARGETS:
2683718Sstever@eecs.umich.edu    # Ask SCons which directory it was invoked from
2693718Sstever@eecs.umich.edu    launch_dir = GetLaunchDir()
2703718Sstever@eecs.umich.edu    # Make targets relative to invocation directory
2715863Snate@binkert.org    abs_targets = [ normpath(joinpath(launch_dir, str(x))) for x in \
2725863Snate@binkert.org                    COMMAND_LINE_TARGETS]
2733718Sstever@eecs.umich.eduelse:
2743718Sstever@eecs.umich.edu    # Default targets are relative to root of tree
2755863Snate@binkert.org    abs_targets = [ normpath(joinpath(ROOT, str(x))) for x in \
2765863Snate@binkert.org                    DEFAULT_TARGETS]
2773718Sstever@eecs.umich.edu
2783718Sstever@eecs.umich.edu
2792634Sstever@eecs.umich.edu# Generate a list of the unique build roots and configs that the
2802634Sstever@eecs.umich.edu# collected targets reference.
2815863Snate@binkert.orgvariant_paths = []
2822638Sstever@eecs.umich.edubuild_root = None
2832632Sstever@eecs.umich.edufor t in abs_targets:
2842632Sstever@eecs.umich.edu    path_dirs = t.split('/')
2852632Sstever@eecs.umich.edu    try:
2862632Sstever@eecs.umich.edu        build_top = rfind(path_dirs, 'build', -2)
2872632Sstever@eecs.umich.edu    except:
2882632Sstever@eecs.umich.edu        print "Error: no non-leaf 'build' dir found on target path", t
2891858SN/A        Exit(1)
2903716Sstever@eecs.umich.edu    this_build_root = joinpath('/',*path_dirs[:build_top+1])
2912638Sstever@eecs.umich.edu    if not build_root:
2922638Sstever@eecs.umich.edu        build_root = this_build_root
2932638Sstever@eecs.umich.edu    else:
2942638Sstever@eecs.umich.edu        if this_build_root != build_root:
2952638Sstever@eecs.umich.edu            print "Error: build targets not under same build root\n"\
2962638Sstever@eecs.umich.edu                  "  %s\n  %s" % (build_root, this_build_root)
2972638Sstever@eecs.umich.edu            Exit(1)
2985863Snate@binkert.org    variant_path = joinpath('/',*path_dirs[:build_top+2])
2995863Snate@binkert.org    if variant_path not in variant_paths:
3005863Snate@binkert.org        variant_paths.append(variant_path)
301955SN/A
3025341Sstever@gmail.com# Make sure build_root exists (might not if this is the first build there)
3035341Sstever@gmail.comif not isdir(build_root):
3045863Snate@binkert.org    mkdir(build_root)
3055341Sstever@gmail.com
3064494Ssaidi@eecs.umich.eduExport('env')
3074494Ssaidi@eecs.umich.edu
3085863Snate@binkert.orgenv.SConsignFile(joinpath(build_root, "sconsign"))
3091105SN/A
3102667Sstever@eecs.umich.edu# Default duplicate option is to use hard links, but this messes up
3112667Sstever@eecs.umich.edu# when you use emacs to edit a file in the target dir, as emacs moves
3122667Sstever@eecs.umich.edu# file to file~ then copies to file, breaking the link.  Symbolic
3132667Sstever@eecs.umich.edu# (soft) links work better.
3142667Sstever@eecs.umich.eduenv.SetOption('duplicate', 'soft-copy')
3152667Sstever@eecs.umich.edu
3165341Sstever@gmail.com#
3175863Snate@binkert.org# Set up global sticky variables... these are common to an entire build
3185341Sstever@gmail.com# tree (not specific to a particular build like ALPHA_SE)
3195341Sstever@gmail.com#
3205341Sstever@gmail.com
3215863Snate@binkert.org# Variable validators & converters for global sticky variables
3225341Sstever@gmail.comdef PathListMakeAbsolute(val):
3235341Sstever@gmail.com    if not val:
3245341Sstever@gmail.com        return val
3255863Snate@binkert.org    f = lambda p: abspath(expanduser(p))
3265341Sstever@gmail.com    return ':'.join(map(f, val.split(':')))
3275341Sstever@gmail.com
3285341Sstever@gmail.comdef PathListAllExist(key, val, env):
3295341Sstever@gmail.com    if not val:
3305341Sstever@gmail.com        return
3315341Sstever@gmail.com    paths = val.split(':')
3325341Sstever@gmail.com    for path in paths:
3335341Sstever@gmail.com        if not isdir(path):
3345341Sstever@gmail.com            raise SCons.Errors.UserError("Path does not exist: '%s'" % path)
3355341Sstever@gmail.com
3365863Snate@binkert.orgglobal_sticky_vars_file = joinpath(build_root, 'variables.global')
3375341Sstever@gmail.com
3385863Snate@binkert.orgglobal_sticky_vars = Variables(global_sticky_vars_file, args=ARGUMENTS)
3395341Sstever@gmail.com
3405863Snate@binkert.orgglobal_sticky_vars.AddVariables(
3415863Snate@binkert.org    ('CC', 'C compiler', environ.get('CC', env['CC'])),
3425863Snate@binkert.org    ('CXX', 'C++ compiler', environ.get('CXX', env['CXX'])),
3435397Ssaidi@eecs.umich.edu    ('BATCH', 'Use batch pool for build and tests', False),
3445397Ssaidi@eecs.umich.edu    ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
3455341Sstever@gmail.com    ('EXTRAS', 'Add Extra directories to the compilation', '',
3465341Sstever@gmail.com     PathListAllExist, PathListMakeAbsolute)
3475341Sstever@gmail.com    )    
3485341Sstever@gmail.com
3495341Sstever@gmail.com# base help text
3505341Sstever@gmail.comhelp_text = '''
3515341Sstever@gmail.comUsage: scons [scons options] [build options] [target(s)]
3525341Sstever@gmail.com
3535863Snate@binkert.orgGlobal sticky options:
3545341Sstever@gmail.com'''
3555341Sstever@gmail.com
3565863Snate@binkert.orghelp_text += global_sticky_vars.GenerateHelpText(env)
3575341Sstever@gmail.com
3585863Snate@binkert.org# Update env with values from ARGUMENTS & file global_sticky_vars_file
3595863Snate@binkert.orgglobal_sticky_vars.Update(env)
3605341Sstever@gmail.com
3615863Snate@binkert.org# Save sticky variable settings back to current variables file
3625863Snate@binkert.orgglobal_sticky_vars.Save(global_sticky_vars_file, env)
3635341Sstever@gmail.com
3645863Snate@binkert.org# Parse EXTRAS variable to build list of all directories where we're
3655341Sstever@gmail.com# look for sources etc.  This list is exported as base_dir_list.
3665871Snate@binkert.orgbase_dir = env.srcdir.abspath
3675341Sstever@gmail.comif env['EXTRAS']:
3685742Snate@binkert.org    extras_dir_list = env['EXTRAS'].split(':')
3695742Snate@binkert.orgelse:
3705742Snate@binkert.org    extras_dir_list = []
3715341Sstever@gmail.com
3725742Snate@binkert.orgExport('base_dir')
3735742Snate@binkert.orgExport('extras_dir_list')
3745341Sstever@gmail.com
3752632Sstever@eecs.umich.edu# M5_PLY is used by isa_parser.py to find the PLY package.
3765199Sstever@gmail.comenv.Append(ENV = { 'M5_PLY' : str(Dir('ext/ply')) })
3775871Snate@binkert.org
3785871Snate@binkert.orgCXX_version = read_command([env['CXX'],'--version'], exception=False)
3795871Snate@binkert.orgCXX_V = read_command([env['CXX'],'-V'], exception=False)
3805871Snate@binkert.org
3815871Snate@binkert.orgenv['GCC'] = CXX_version and CXX_version.find('g++') >= 0
3825871Snate@binkert.orgenv['SUNCC'] = CXX_V and CXX_V.find('Sun C++') >= 0
3835871Snate@binkert.orgenv['ICC'] = CXX_V and CXX_V.find('Intel') >= 0
3843942Ssaidi@eecs.umich.eduif env['GCC'] + env['SUNCC'] + env['ICC'] > 1:
3853940Ssaidi@eecs.umich.edu    print 'Error: How can we have two at the same time?'
3863918Ssaidi@eecs.umich.edu    Exit(1)
3873918Ssaidi@eecs.umich.edu
3881858SN/A# Set up default C++ compiler flags
3893918Ssaidi@eecs.umich.eduif env['GCC']:
3903918Ssaidi@eecs.umich.edu    env.Append(CCFLAGS='-pipe')
3913918Ssaidi@eecs.umich.edu    env.Append(CCFLAGS='-fno-strict-aliasing')
3923918Ssaidi@eecs.umich.edu    env.Append(CCFLAGS=Split('-Wall -Wno-sign-compare -Werror -Wundef'))
3935571Snate@binkert.org    env.Append(CXXFLAGS='-Wno-deprecated')
3943940Ssaidi@eecs.umich.eduelif env['ICC']:
3953940Ssaidi@eecs.umich.edu    pass #Fix me... add warning flags once we clean up icc warnings
3963918Ssaidi@eecs.umich.eduelif env['SUNCC']:
3973918Ssaidi@eecs.umich.edu    env.Append(CCFLAGS='-Qoption ccfe')
3983918Ssaidi@eecs.umich.edu    env.Append(CCFLAGS='-features=gcc')
3993918Ssaidi@eecs.umich.edu    env.Append(CCFLAGS='-features=extensions')
4003918Ssaidi@eecs.umich.edu    env.Append(CCFLAGS='-library=stlport4')
4013918Ssaidi@eecs.umich.edu    env.Append(CCFLAGS='-xar')
4025871Snate@binkert.org    #env.Append(CCFLAGS='-instances=semiexplicit')
4033918Ssaidi@eecs.umich.eduelse:
4043918Ssaidi@eecs.umich.edu    print 'Error: Don\'t know what compiler options to use for your compiler.'
4053940Ssaidi@eecs.umich.edu    print '       Please fix SConstruct and src/SConscript and try again.'
4063918Ssaidi@eecs.umich.edu    Exit(1)
4073918Ssaidi@eecs.umich.edu
4085397Ssaidi@eecs.umich.edu# Do this after we save setting back, or else we'll tack on an
4095397Ssaidi@eecs.umich.edu# extra 'qdo' every time we run scons.
4105397Ssaidi@eecs.umich.eduif env['BATCH']:
4115708Ssaidi@eecs.umich.edu    env['CC']     = env['BATCH_CMD'] + ' ' + env['CC']
4125708Ssaidi@eecs.umich.edu    env['CXX']    = env['BATCH_CMD'] + ' ' + env['CXX']
4135708Ssaidi@eecs.umich.edu    env['AS']     = env['BATCH_CMD'] + ' ' + env['AS']
4145708Ssaidi@eecs.umich.edu    env['AR']     = env['BATCH_CMD'] + ' ' + env['AR']
4155708Ssaidi@eecs.umich.edu    env['RANLIB'] = env['BATCH_CMD'] + ' ' + env['RANLIB']
4165397Ssaidi@eecs.umich.edu
4171851SN/Aif sys.platform == 'cygwin':
4181851SN/A    # cygwin has some header file issues...
4191858SN/A    env.Append(CCFLAGS=Split("-Wno-uninitialized"))
4205200Sstever@gmail.comenv.Append(CPPPATH=[Dir('ext/dnet')])
421955SN/A
4223053Sstever@eecs.umich.edu# Check for SWIG
4233053Sstever@eecs.umich.eduif not env.has_key('SWIG'):
4243053Sstever@eecs.umich.edu    print 'Error: SWIG utility not found.'
4253053Sstever@eecs.umich.edu    print '       Please install (see http://www.swig.org) and retry.'
4263053Sstever@eecs.umich.edu    Exit(1)
4273053Sstever@eecs.umich.edu
4283053Sstever@eecs.umich.edu# Check for appropriate SWIG version
4295871Snate@binkert.orgswig_version = read_command(('swig', '-version'), exception='').split()
4303053Sstever@eecs.umich.edu# First 3 words should be "SWIG Version x.y.z"
4314742Sstever@eecs.umich.eduif len(swig_version) < 3 or \
4324742Sstever@eecs.umich.edu        swig_version[0] != 'SWIG' or swig_version[1] != 'Version':
4333053Sstever@eecs.umich.edu    print 'Error determining SWIG version.'
4343053Sstever@eecs.umich.edu    Exit(1)
4353053Sstever@eecs.umich.edu
4363053Sstever@eecs.umich.edumin_swig_version = '1.3.28'
4373053Sstever@eecs.umich.eduif compare_versions(swig_version[2], min_swig_version) < 0:
4383053Sstever@eecs.umich.edu    print 'Error: SWIG version', min_swig_version, 'or newer required.'
4393053Sstever@eecs.umich.edu    print '       Installed version:', swig_version[2]
4403053Sstever@eecs.umich.edu    Exit(1)
4413053Sstever@eecs.umich.edu
4422667Sstever@eecs.umich.edu# Set up SWIG flags & scanner
4434554Sbinkertn@umich.eduswig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
4444554Sbinkertn@umich.eduenv.Append(SWIGFLAGS=swig_flags)
4452667Sstever@eecs.umich.edu
4464554Sbinkertn@umich.edu# filter out all existing swig scanners, they mess up the dependency
4474554Sbinkertn@umich.edu# stuff for some reason
4484554Sbinkertn@umich.eduscanners = []
4494554Sbinkertn@umich.edufor scanner in env['SCANNERS']:
4504554Sbinkertn@umich.edu    skeys = scanner.skeys
4514554Sbinkertn@umich.edu    if skeys == '.i':
4524554Sbinkertn@umich.edu        continue
4534781Snate@binkert.org
4544554Sbinkertn@umich.edu    if isinstance(skeys, (list, tuple)) and '.i' in skeys:
4554554Sbinkertn@umich.edu        continue
4562667Sstever@eecs.umich.edu
4574554Sbinkertn@umich.edu    scanners.append(scanner)
4584554Sbinkertn@umich.edu
4594554Sbinkertn@umich.edu# add the new swig scanner that we like better
4604554Sbinkertn@umich.edufrom SCons.Scanner import ClassicCPP as CPPScanner
4612667Sstever@eecs.umich.eduswig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
4624554Sbinkertn@umich.eduscanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re))
4632667Sstever@eecs.umich.edu
4644554Sbinkertn@umich.edu# replace the scanners list that has what we want
4654554Sbinkertn@umich.eduenv['SCANNERS'] = scanners
4662667Sstever@eecs.umich.edu
4675522Snate@binkert.org# Add a custom Check function to the Configure context so that we can
4685522Snate@binkert.org# figure out if the compiler adds leading underscores to global
4695522Snate@binkert.org# variables.  This is needed for the autogenerated asm files that we
4705522Snate@binkert.org# use for embedding the python code.
4715522Snate@binkert.orgdef CheckLeading(context):
4725522Snate@binkert.org    context.Message("Checking for leading underscore in global variables...")
4735522Snate@binkert.org    # 1) Define a global variable called x from asm so the C compiler
4745522Snate@binkert.org    #    won't change the symbol at all.
4755522Snate@binkert.org    # 2) Declare that variable.
4765522Snate@binkert.org    # 3) Use the variable
4775522Snate@binkert.org    #
4785522Snate@binkert.org    # If the compiler prepends an underscore, this will successfully
4795522Snate@binkert.org    # link because the external symbol 'x' will be called '_x' which
4805522Snate@binkert.org    # was defined by the asm statement.  If the compiler does not
4815522Snate@binkert.org    # prepend an underscore, this will not successfully link because
4825522Snate@binkert.org    # '_x' will have been defined by assembly, while the C portion of
4835522Snate@binkert.org    # the code will be trying to use 'x'
4845522Snate@binkert.org    ret = context.TryLink('''
4855522Snate@binkert.org        asm(".globl _x; _x: .byte 0");
4865522Snate@binkert.org        extern int x;
4875522Snate@binkert.org        int main() { return x; }
4885522Snate@binkert.org        ''', extension=".c")
4895522Snate@binkert.org    context.env.Append(LEADING_UNDERSCORE=ret)
4905522Snate@binkert.org    context.Result(ret)
4915522Snate@binkert.org    return ret
4925522Snate@binkert.org
4932638Sstever@eecs.umich.edu# Platform-specific configuration.  Note again that we assume that all
4942638Sstever@eecs.umich.edu# builds under a given build root run on the same host platform.
4952638Sstever@eecs.umich.educonf = Configure(env,
4963716Sstever@eecs.umich.edu                 conf_dir = joinpath(build_root, '.scons_config'),
4975522Snate@binkert.org                 log_file = joinpath(build_root, 'scons_config.log'),
4985522Snate@binkert.org                 custom_tests = { 'CheckLeading' : CheckLeading })
4995522Snate@binkert.org
5005522Snate@binkert.org# Check for leading underscores.  Don't really need to worry either
5015522Snate@binkert.org# way so don't need to check the return code.
5025522Snate@binkert.orgconf.CheckLeading()
5031858SN/A
5045227Ssaidi@eecs.umich.edu# Check if we should compile a 64 bit binary on Mac OS X/Darwin
5055227Ssaidi@eecs.umich.edutry:
5065227Ssaidi@eecs.umich.edu    import platform
5075227Ssaidi@eecs.umich.edu    uname = platform.uname()
5085227Ssaidi@eecs.umich.edu    if uname[0] == 'Darwin' and compare_versions(uname[2], '9.0.0') >= 0:
5095863Snate@binkert.org        if int(read_command('sysctl -n hw.cpu64bit_capable')[0]):
5105227Ssaidi@eecs.umich.edu            env.Append(CCFLAGS='-arch x86_64')
5115227Ssaidi@eecs.umich.edu            env.Append(CFLAGS='-arch x86_64')
5125227Ssaidi@eecs.umich.edu            env.Append(LINKFLAGS='-arch x86_64')
5135227Ssaidi@eecs.umich.edu            env.Append(ASFLAGS='-arch x86_64')
5145227Ssaidi@eecs.umich.eduexcept:
5155227Ssaidi@eecs.umich.edu    pass
5165227Ssaidi@eecs.umich.edu
5175204Sstever@gmail.com# Recent versions of scons substitute a "Null" object for Configure()
5185204Sstever@gmail.com# when configuration isn't necessary, e.g., if the "--help" option is
5195204Sstever@gmail.com# present.  Unfortuantely this Null object always returns false,
5205204Sstever@gmail.com# breaking all our configuration checks.  We replace it with our own
5215204Sstever@gmail.com# more optimistic null object that returns True instead.
5225204Sstever@gmail.comif not conf:
5235204Sstever@gmail.com    def NullCheck(*args, **kwargs):
5245204Sstever@gmail.com        return True
5255204Sstever@gmail.com
5265204Sstever@gmail.com    class NullConf:
5275204Sstever@gmail.com        def __init__(self, env):
5285204Sstever@gmail.com            self.env = env
5295204Sstever@gmail.com        def Finish(self):
5305204Sstever@gmail.com            return self.env
5315204Sstever@gmail.com        def __getattr__(self, mname):
5325204Sstever@gmail.com            return NullCheck
5335204Sstever@gmail.com
5345204Sstever@gmail.com    conf = NullConf(env)
5355204Sstever@gmail.com
5363118Sstever@eecs.umich.edu# Find Python include and library directories for embedding the
5373118Sstever@eecs.umich.edu# interpreter.  For consistency, we will use the same Python
5383118Sstever@eecs.umich.edu# installation used to run scons (and thus this script).  If you want
5393118Sstever@eecs.umich.edu# to link in an alternate version, see above for instructions on how
5403118Sstever@eecs.umich.edu# to invoke scons with a different copy of the Python interpreter.
5415863Snate@binkert.orgfrom distutils import sysconfig
5423118Sstever@eecs.umich.edu
5435863Snate@binkert.orgpy_getvar = sysconfig.get_config_var
5443118Sstever@eecs.umich.edu
5455863Snate@binkert.orgpy_version = 'python' + py_getvar('VERSION')
5465863Snate@binkert.org
5475863Snate@binkert.orgpy_general_include = sysconfig.get_python_inc()
5485863Snate@binkert.orgpy_platform_include = sysconfig.get_python_inc(plat_specific=True)
5495863Snate@binkert.orgpy_includes = [ py_general_include ]
5505863Snate@binkert.orgif py_platform_include != py_general_include:
5515863Snate@binkert.org    py_includes.append(py_platform_include)
5525863Snate@binkert.org
5535863Snate@binkert.orgpy_lib_path = []
5545863Snate@binkert.org# add the prefix/lib/pythonX.Y/config dir, but only if there is no
5555863Snate@binkert.org# shared library in prefix/lib/.
5565863Snate@binkert.orgif not py_getvar('Py_ENABLE_SHARED'):
5575863Snate@binkert.org    py_lib_path.append('-L' + py_getvar('LIBPL'))
5585863Snate@binkert.org
5595863Snate@binkert.orgpy_libs = []
5605863Snate@binkert.orgfor lib in py_getvar('LIBS').split() + py_getvar('SYSLIBS').split():
5615863Snate@binkert.org    if lib not in py_libs:
5625863Snate@binkert.org        py_libs.append(lib)
5635863Snate@binkert.orgpy_libs.append('-l' + py_version)
5645863Snate@binkert.org
5655863Snate@binkert.orgenv.Append(CPPPATH=py_includes)
5665863Snate@binkert.orgenv.Append(LIBPATH=py_lib_path)
5675863Snate@binkert.org#env.Append(LIBS=py_libs)
5685863Snate@binkert.org
5695863Snate@binkert.org# verify that this stuff works
5703118Sstever@eecs.umich.eduif not conf.CheckHeader('Python.h', '<>'):
5715863Snate@binkert.org    print "Error: can't find Python.h header in", py_includes
5723118Sstever@eecs.umich.edu    Exit(1)
5733118Sstever@eecs.umich.edu
5745863Snate@binkert.orgfor lib in py_libs:
5755863Snate@binkert.org    assert lib.startswith('-l')
5765863Snate@binkert.org    lib = lib[2:]
5775863Snate@binkert.org    if not conf.CheckLib(lib):
5785863Snate@binkert.org        print "Error: can't find library %s required by python" % lib
5795863Snate@binkert.org        Exit(1)
5803118Sstever@eecs.umich.edu
5813483Ssaidi@eecs.umich.edu# On Solaris you need to use libsocket for socket ops
5823494Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
5833494Ssaidi@eecs.umich.edu   if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
5843483Ssaidi@eecs.umich.edu       print "Can't find library with socket calls (e.g. accept())"
5853483Ssaidi@eecs.umich.edu       Exit(1)
5863483Ssaidi@eecs.umich.edu
5873053Sstever@eecs.umich.edu# Check for zlib.  If the check passes, libz will be automatically
5883053Sstever@eecs.umich.edu# added to the LIBS environment variable.
5893918Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
5903053Sstever@eecs.umich.edu    print 'Error: did not find needed zlib compression library '\
5913053Sstever@eecs.umich.edu          'and/or zlib.h header file.'
5923053Sstever@eecs.umich.edu    print '       Please install zlib and try again.'
5933053Sstever@eecs.umich.edu    Exit(1)
5943053Sstever@eecs.umich.edu
5951858SN/A# Check for <fenv.h> (C99 FP environment control)
5961858SN/Ahave_fenv = conf.CheckHeader('fenv.h', '<>')
5971858SN/Aif not have_fenv:
5981858SN/A    print "Warning: Header file <fenv.h> not found."
5991858SN/A    print "         This host has no IEEE FP rounding mode control."
6001858SN/A
6015863Snate@binkert.org######################################################################
6025863Snate@binkert.org#
6031859SN/A# Check for mysql.
6045863Snate@binkert.org#
6051858SN/Amysql_config = WhereIs('mysql_config')
6065863Snate@binkert.orghave_mysql = bool(mysql_config)
6071858SN/A
6081859SN/A# Check MySQL version.
6091859SN/Aif have_mysql:
6105863Snate@binkert.org    mysql_version = read_command(mysql_config + ' --version')
6113053Sstever@eecs.umich.edu    min_mysql_version = '4.1'
6123053Sstever@eecs.umich.edu    if compare_versions(mysql_version, min_mysql_version) < 0:
6133053Sstever@eecs.umich.edu        print 'Warning: MySQL', min_mysql_version, 'or newer required.'
6143053Sstever@eecs.umich.edu        print '         Version', mysql_version, 'detected.'
6151859SN/A        have_mysql = False
6161859SN/A
6171859SN/A# Set up mysql_config commands.
6181859SN/Aif have_mysql:
6191859SN/A    mysql_config_include = mysql_config + ' --include'
6201859SN/A    if os.system(mysql_config_include + ' > /dev/null') != 0:
6211859SN/A        # older mysql_config versions don't support --include, use
6221859SN/A        # --cflags instead
6231862SN/A        mysql_config_include = mysql_config + ' --cflags | sed s/\\\'//g'
6241859SN/A    # This seems to work in all versions
6251859SN/A    mysql_config_libs = mysql_config + ' --libs'
6261859SN/A
6275863Snate@binkert.org######################################################################
6285863Snate@binkert.org#
6295863Snate@binkert.org# Finish the configuration
6305863Snate@binkert.org#
6311858SN/Aenv = conf.Finish()
6321858SN/A
6335863Snate@binkert.org######################################################################
6345863Snate@binkert.org#
6355863Snate@binkert.org# Collect all non-global variables
6365863Snate@binkert.org#
6375863Snate@binkert.org
6385871Snate@binkert.orgExport('env')
6395871Snate@binkert.org
6402139SN/A# Define the universe of supported ISAs
6414202Sbinkertn@umich.eduall_isa_list = [ ]
6424202Sbinkertn@umich.eduExport('all_isa_list')
6432139SN/A
6442155SN/A# Define the universe of supported CPU models
6454202Sbinkertn@umich.eduall_cpu_list = [ ]
6464202Sbinkertn@umich.edudefault_cpus = [ ]
6474202Sbinkertn@umich.eduExport('all_cpu_list', 'default_cpus')
6482155SN/A
6495863Snate@binkert.org# Sticky variables get saved in the variables file so they persist from
6501869SN/A# one invocation to the next (unless overridden, in which case the new
6511869SN/A# value becomes sticky).
6525863Snate@binkert.orgsticky_vars = Variables(args=ARGUMENTS)
6535863Snate@binkert.orgExport('sticky_vars')
6544202Sbinkertn@umich.edu
6555863Snate@binkert.org# Non-sticky variables only apply to the current build.
6565863Snate@binkert.orgnonsticky_vars = Variables(args=ARGUMENTS)
6575863Snate@binkert.orgExport('nonsticky_vars')
6584202Sbinkertn@umich.edu
6594202Sbinkertn@umich.edu# Walk the tree and execute all SConsopts scripts that wil add to the
6605863Snate@binkert.org# above variables
6615742Snate@binkert.orgfor bdir in [ base_dir ] + extras_dir_list:
6625742Snate@binkert.org    for root, dirs, files in os.walk(bdir):
6635341Sstever@gmail.com        if 'SConsopts' in files:
6645342Sstever@gmail.com            print "Reading", joinpath(root, 'SConsopts')
6655342Sstever@gmail.com            SConscript(joinpath(root, 'SConsopts'))
6664202Sbinkertn@umich.edu
6674202Sbinkertn@umich.eduall_isa_list.sort()
6684202Sbinkertn@umich.eduall_cpu_list.sort()
6694202Sbinkertn@umich.edudefault_cpus.sort()
6704202Sbinkertn@umich.edu
6715863Snate@binkert.orgsticky_vars.AddVariables(
6725863Snate@binkert.org    EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list),
6735863Snate@binkert.org    BoolVariable('FULL_SYSTEM', 'Full-system support', False),
6745863Snate@binkert.org    ListVariable('CPU_MODELS', 'CPU models', default_cpus, all_cpu_list),
6755863Snate@binkert.org    BoolVariable('NO_FAST_ALLOC', 'Disable fast object allocator', False),
6765863Snate@binkert.org    BoolVariable('FAST_ALLOC_DEBUG', 'Enable fast object allocator debugging',
6775863Snate@binkert.org                 False),
6785863Snate@binkert.org    BoolVariable('FAST_ALLOC_STATS', 'Enable fast object allocator statistics',
6795863Snate@binkert.org                 False),
6805863Snate@binkert.org    BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
6815863Snate@binkert.org                 False),
6825863Snate@binkert.org    BoolVariable('SS_COMPATIBLE_FP',
6835863Snate@binkert.org                 'Make floating-point results compatible with SimpleScalar',
6845863Snate@binkert.org                 False),
6855863Snate@binkert.org    BoolVariable('USE_SSE2',
6865863Snate@binkert.org                 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
6875863Snate@binkert.org                 False),
6885863Snate@binkert.org    BoolVariable('USE_MYSQL', 'Use MySQL for stats output', have_mysql),
6895863Snate@binkert.org    BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
6905863Snate@binkert.org    BoolVariable('USE_CHECKER', 'Use checker for detailed CPU models', False),
6915952Ssaidi@eecs.umich.edu    BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False),
6921869SN/A    )
6931858SN/A
6945863Snate@binkert.orgnonsticky_vars.AddVariables(
6955863Snate@binkert.org    BoolVariable('update_ref', 'Update test reference outputs', False)
6961869SN/A    )
6971858SN/A
6985863Snate@binkert.org# These variables get exported to #defines in config/*.hh (see src/SConscript).
6995863Snate@binkert.orgenv.ExportVariables = ['FULL_SYSTEM', 'ALPHA_TLASER', 'USE_FENV', \
7005863Snate@binkert.org                       'USE_MYSQL', 'NO_FAST_ALLOC', 'FAST_ALLOC_DEBUG', \
7015863Snate@binkert.org                       'FAST_ALLOC_STATS', 'SS_COMPATIBLE_FP', \
7025952Ssaidi@eecs.umich.edu                       'USE_CHECKER', 'TARGET_ISA', 'CP_ANNOTATE']
7031858SN/A
704955SN/A###################################################
705955SN/A#
7061869SN/A# Define a SCons builder for configuration flag headers.
7071869SN/A#
7081869SN/A###################################################
7091869SN/A
7101869SN/A# This function generates a config header file that #defines the
7115863Snate@binkert.org# variable symbol to the current variable setting (0 or 1).  The source
7125863Snate@binkert.org# operands are the name of the variable and a Value node containing the
7135863Snate@binkert.org# value of the variable.
7141869SN/Adef build_config_file(target, source, env):
7155863Snate@binkert.org    (variable, value) = [s.get_contents() for s in source]
7161869SN/A    f = file(str(target[0]), 'w')
7175863Snate@binkert.org    print >> f, '#define', variable, value
7181869SN/A    f.close()
7191869SN/A    return None
7201869SN/A
7211869SN/A# Generate the message to be printed when building the config file.
7221869SN/Adef build_config_file_string(target, source, env):
7235863Snate@binkert.org    (variable, value) = [s.get_contents() for s in source]
7245863Snate@binkert.org    return "Defining %s as %s in %s." % (variable, value, target[0])
7251869SN/A
7261869SN/A# Combine the two functions into a scons Action object.
7271869SN/Aconfig_action = Action(build_config_file, build_config_file_string)
7281869SN/A
7291869SN/A# The emitter munges the source & target node lists to reflect what
7301869SN/A# we're really doing.
7311869SN/Adef config_emitter(target, source, env):
7325863Snate@binkert.org    # extract variable name from Builder arg
7335863Snate@binkert.org    variable = str(target[0])
7341869SN/A    # True target is config header file
7355863Snate@binkert.org    target = joinpath('config', variable.lower() + '.hh')
7365863Snate@binkert.org    val = env[variable]
7373356Sbinkertn@umich.edu    if isinstance(val, bool):
7383356Sbinkertn@umich.edu        # Force value to 0/1
7393356Sbinkertn@umich.edu        val = int(val)
7403356Sbinkertn@umich.edu    elif isinstance(val, str):
7413356Sbinkertn@umich.edu        val = '"' + val + '"'
7424781Snate@binkert.org
7435863Snate@binkert.org    # Sources are variable name & value (packaged in SCons Value nodes)
7445863Snate@binkert.org    return ([target], [Value(variable), Value(val)])
7451869SN/A
7461869SN/Aconfig_builder = Builder(emitter = config_emitter, action = config_action)
7471869SN/A
7481869SN/Aenv.Append(BUILDERS = { 'ConfigFile' : config_builder })
7491869SN/A
7502638Sstever@eecs.umich.edu# libelf build is shared across all configs in the build root.
7512638Sstever@eecs.umich.eduenv.SConscript('ext/libelf/SConscript',
7525871Snate@binkert.org               variant_dir = joinpath(build_root, 'libelf'))
7532638Sstever@eecs.umich.edu
7545749Scws3k@cs.virginia.edu# gzstream build is shared across all configs in the build root.
7555749Scws3k@cs.virginia.eduenv.SConscript('ext/gzstream/SConscript',
7565871Snate@binkert.org               variant_dir = joinpath(build_root, 'gzstream'))
7575749Scws3k@cs.virginia.edu
7581869SN/A###################################################
7591869SN/A#
7603546Sgblack@eecs.umich.edu# This function is used to set up a directory with switching headers
7613546Sgblack@eecs.umich.edu#
7623546Sgblack@eecs.umich.edu###################################################
7633546Sgblack@eecs.umich.edu
7644202Sbinkertn@umich.eduenv['ALL_ISA_LIST'] = all_isa_list
7655863Snate@binkert.orgdef make_switching_dir(dname, switch_headers, env):
7663546Sgblack@eecs.umich.edu    # Generate the header.  target[0] is the full path of the output
7673546Sgblack@eecs.umich.edu    # header to generate.  'source' is a dummy variable, since we get the
7683546Sgblack@eecs.umich.edu    # list of ISAs from env['ALL_ISA_LIST'].
7693546Sgblack@eecs.umich.edu    def gen_switch_hdr(target, source, env):
7704781Snate@binkert.org        fname = str(target[0])
7715863Snate@binkert.org        bname = basename(fname)
7724781Snate@binkert.org        f = open(fname, 'w')
7734781Snate@binkert.org        f.write('#include "arch/isa_specific.hh"\n')
7744781Snate@binkert.org        cond = '#if'
7754781Snate@binkert.org        for isa in all_isa_list:
7764781Snate@binkert.org            f.write('%s THE_ISA == %s_ISA\n#include "%s/%s/%s"\n'
7775863Snate@binkert.org                    % (cond, isa.upper(), dname, isa, bname))
7784781Snate@binkert.org            cond = '#elif'
7794781Snate@binkert.org        f.write('#else\n#error "THE_ISA not set"\n#endif\n')
7804781Snate@binkert.org        f.close()
7814781Snate@binkert.org        return 0
7823546Sgblack@eecs.umich.edu
7833546Sgblack@eecs.umich.edu    # String to print when generating header
7843546Sgblack@eecs.umich.edu    def gen_switch_hdr_string(target, source, env):
7854781Snate@binkert.org        return "Generating switch header " + str(target[0])
7863546Sgblack@eecs.umich.edu
7873546Sgblack@eecs.umich.edu    # Build SCons Action object. 'varlist' specifies env vars that this
7883546Sgblack@eecs.umich.edu    # action depends on; when env['ALL_ISA_LIST'] changes these actions
7893546Sgblack@eecs.umich.edu    # should get re-executed.
7903546Sgblack@eecs.umich.edu    switch_hdr_action = Action(gen_switch_hdr, gen_switch_hdr_string,
7913546Sgblack@eecs.umich.edu                               varlist=['ALL_ISA_LIST'])
7923546Sgblack@eecs.umich.edu
7933546Sgblack@eecs.umich.edu    # Instantiate actions for each header
7943546Sgblack@eecs.umich.edu    for hdr in switch_headers:
7953546Sgblack@eecs.umich.edu        env.Command(hdr, [], switch_hdr_action)
7964202Sbinkertn@umich.eduExport('make_switching_dir')
7973546Sgblack@eecs.umich.edu
7983546Sgblack@eecs.umich.edu###################################################
7993546Sgblack@eecs.umich.edu#
800955SN/A# Define build environments for selected configurations.
801955SN/A#
802955SN/A###################################################
803955SN/A
8041858SN/A# rename base env
8051858SN/Abase_env = env
8061858SN/A
8075863Snate@binkert.orgfor variant_path in variant_paths:
8085863Snate@binkert.org    print "Building in", variant_path
8095343Sstever@gmail.com
8105343Sstever@gmail.com    # Make a copy of the build-root environment to use for this config.
8115863Snate@binkert.org    env = base_env.Clone()
8125863Snate@binkert.org    env['BUILDDIR'] = variant_path
8134773Snate@binkert.org
8145863Snate@binkert.org    # variant_dir is the tail component of build path, and is used to
8152632Sstever@eecs.umich.edu    # determine the build parameters (e.g., 'ALPHA_SE')
8165863Snate@binkert.org    (build_root, variant_dir) = splitpath(variant_path)
8172023SN/A
8185863Snate@binkert.org    # Set env variables according to the build directory config.
8195863Snate@binkert.org    sticky_vars.files = []
8205863Snate@binkert.org    # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
8215863Snate@binkert.org    # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
8225863Snate@binkert.org    # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
8235863Snate@binkert.org    current_vars_file = joinpath(build_root, 'variables', variant_dir)
8245863Snate@binkert.org    if isfile(current_vars_file):
8255863Snate@binkert.org        sticky_vars.files.append(current_vars_file)
8265863Snate@binkert.org        print "Using saved variables file %s" % current_vars_file
8272632Sstever@eecs.umich.edu    else:
8285863Snate@binkert.org        # Build dir-specific variables file doesn't exist.
8292023SN/A
8302632Sstever@eecs.umich.edu        # Make sure the directory is there so we can create it later
8315863Snate@binkert.org        opt_dir = dirname(current_vars_file)
8325342Sstever@gmail.com        if not isdir(opt_dir):
8335863Snate@binkert.org            mkdir(opt_dir)
8342632Sstever@eecs.umich.edu
8355863Snate@binkert.org        # Get default build variables from source tree.  Variables are
8365863Snate@binkert.org        # normally determined by name of $VARIANT_DIR, but can be
8372632Sstever@eecs.umich.edu        # overriden by 'default=' arg on command line.
8385863Snate@binkert.org        default_vars_file = joinpath('build_opts',
8395863Snate@binkert.org                                     ARGUMENTS.get('default', variant_dir))
8405863Snate@binkert.org        if isfile(default_vars_file):
8415863Snate@binkert.org            sticky_vars.files.append(default_vars_file)
8425863Snate@binkert.org            print "Variables file %s not found,\n  using defaults in %s" \
8435863Snate@binkert.org                  % (current_vars_file, default_vars_file)
8442632Sstever@eecs.umich.edu        else:
8455863Snate@binkert.org            print "Error: cannot find variables file %s or %s" \
8465863Snate@binkert.org                  % (current_vars_file, default_vars_file)
8472632Sstever@eecs.umich.edu            Exit(1)
8481888SN/A
8495863Snate@binkert.org    # Apply current variable settings to env
8505863Snate@binkert.org    sticky_vars.Update(env)
8515863Snate@binkert.org    nonsticky_vars.Update(env)
8521858SN/A
8535863Snate@binkert.org    help_text += "\nSticky variables for %s:\n" % variant_dir \
8545863Snate@binkert.org                 + sticky_vars.GenerateHelpText(env) \
8555863Snate@binkert.org                 + "\nNon-sticky variables for %s:\n" % variant_dir \
8565863Snate@binkert.org                 + nonsticky_vars.GenerateHelpText(env)
8572598SN/A
8585863Snate@binkert.org    # Process variable settings.
8591858SN/A
8601858SN/A    if not have_fenv and env['USE_FENV']:
8611858SN/A        print "Warning: <fenv.h> not available; " \
8625863Snate@binkert.org              "forcing USE_FENV to False in", variant_dir + "."
8631858SN/A        env['USE_FENV'] = False
8641858SN/A
8651858SN/A    if not env['USE_FENV']:
8665863Snate@binkert.org        print "Warning: No IEEE FP rounding mode control in", variant_dir + "."
8671871SN/A        print "         FP results may deviate slightly from other platforms."
8681858SN/A
8691858SN/A    if env['EFENCE']:
8701858SN/A        env.Append(LIBS=['efence'])
8711858SN/A
8721858SN/A    if env['USE_MYSQL']:
8731858SN/A        if not have_mysql:
8741858SN/A            print "Warning: MySQL not available; " \
8755863Snate@binkert.org                  "forcing USE_MYSQL to False in", variant_dir + "."
8761858SN/A            env['USE_MYSQL'] = False
8771858SN/A        else:
8785863Snate@binkert.org            print "Compiling in", variant_dir, "with MySQL support."
8791859SN/A            env.ParseConfig(mysql_config_libs)
8801859SN/A            env.ParseConfig(mysql_config_include)
8811869SN/A
8825863Snate@binkert.org    # Save sticky variable settings back to current variables file
8835863Snate@binkert.org    sticky_vars.Save(current_vars_file, env)
8841869SN/A
8851965SN/A    if env['USE_SSE2']:
8861965SN/A        env.Append(CCFLAGS='-msse2')
8871965SN/A
8882761Sstever@eecs.umich.edu    # The src/SConscript file sets up the build rules in 'env' according
8895863Snate@binkert.org    # to the configured variables.  It returns a list of environments,
8901869SN/A    # one for each variant build (debug, opt, etc.)
8915863Snate@binkert.org    envList = SConscript('src/SConscript', variant_dir = variant_path,
8922667Sstever@eecs.umich.edu                         exports = 'env')
8931869SN/A
8941869SN/A    # Set up the regression tests for each build.
8952929Sktlim@umich.edu    for e in envList:
8962929Sktlim@umich.edu        SConscript('tests/SConscript',
8975863Snate@binkert.org                   variant_dir = joinpath(variant_path, 'tests', e.Label),
8982929Sktlim@umich.edu                   exports = { 'env' : e }, duplicate = False)
899955SN/A
9002598SN/AHelp(help_text)
901