SConstruct revision 6654
1955SN/A# -*- mode:python -*-
2955SN/A
310841Sandreas.sandberg@arm.com# Copyright (c) 2009 The Hewlett-Packard Development Company
49812Sandreas.hansson@arm.com# Copyright (c) 2004-2005 The Regents of The University of Michigan
59812Sandreas.hansson@arm.com# All rights reserved.
69812Sandreas.hansson@arm.com#
79812Sandreas.hansson@arm.com# Redistribution and use in source and binary forms, with or without
89812Sandreas.hansson@arm.com# modification, are permitted provided that the following conditions are
99812Sandreas.hansson@arm.com# met: redistributions of source code must retain the above copyright
109812Sandreas.hansson@arm.com# notice, this list of conditions and the following disclaimer;
119812Sandreas.hansson@arm.com# redistributions in binary form must reproduce the above copyright
129812Sandreas.hansson@arm.com# notice, this list of conditions and the following disclaimer in the
139812Sandreas.hansson@arm.com# documentation and/or other materials provided with the distribution;
149812Sandreas.hansson@arm.com# neither the name of the copyright holders nor the names of its
157816Ssteve.reinhardt@amd.com# contributors may be used to endorse or promote products derived from
165871Snate@binkert.org# this software without specific prior written permission.
171762SN/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.
29955SN/A#
30955SN/A# Authors: Steve Reinhardt
31955SN/A#          Nathan Binkert
32955SN/A
33955SN/A###################################################
34955SN/A#
35955SN/A# SCons top-level build description (SConstruct) file.
36955SN/A#
37955SN/A# While in this directory ('m5'), just type 'scons' to build the default
38955SN/A# configuration (see below), or type 'scons build/<CONFIG>/<binary>'
39955SN/A# to build some other configuration (e.g., 'build/ALPHA_FS/m5.opt' for
40955SN/A# the optimized full-system version).
41955SN/A#
422665Ssaidi@eecs.umich.edu# You can build M5 in a different directory as long as there is a
432665Ssaidi@eecs.umich.edu# 'build/<CONFIG>' somewhere along the target path.  The build system
445863Snate@binkert.org# expects that all configs under the same build directory are being
45955SN/A# built for the same host system.
46955SN/A#
47955SN/A# Examples:
48955SN/A#
49955SN/A#   The following two commands are equivalent.  The '-u' option tells
508878Ssteve.reinhardt@amd.com#   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
528878Ssteve.reinhardt@amd.com#   % cd <path-to-src>/m5/build/ALPHA_FS; scons -u m5.debug
532632Sstever@eecs.umich.edu#
54955SN/A#   The following two commands are equivalent and demonstrate building
558878Ssteve.reinhardt@amd.com#   in a directory outside of the source tree.  The '-C' option tells
562632Sstever@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#
612761Sstever@eecs.umich.edu# You can use 'scons -H' to print scons options.  If you're in this
622761Sstever@eecs.umich.edu# 'm5' directory (or use -u or -C to tell scons where to find this
632761Sstever@eecs.umich.edu# file), you can use 'scons -h' to print all the M5-specific build
648878Ssteve.reinhardt@amd.com# options as well.
658878Ssteve.reinhardt@amd.com#
662761Sstever@eecs.umich.edu###################################################
672761Sstever@eecs.umich.edu
682761Sstever@eecs.umich.edu# Check for recent-enough Python and SCons versions.
692761Sstever@eecs.umich.edutry:
702761Sstever@eecs.umich.edu    # Really old versions of scons only take two options for the
718878Ssteve.reinhardt@amd.com    # function, so check once without the revision and once with the
728878Ssteve.reinhardt@amd.com    # revision, the first instance will fail for stuff other than
732632Sstever@eecs.umich.edu    # 0.98, and the second will fail for 0.98.0
742632Sstever@eecs.umich.edu    EnsureSConsVersion(0, 98)
758878Ssteve.reinhardt@amd.com    EnsureSConsVersion(0, 98, 1)
768878Ssteve.reinhardt@amd.comexcept SystemExit, e:
772632Sstever@eecs.umich.edu    print """
78955SN/AFor more details, see:
79955SN/A    http://m5sim.org/wiki/index.php/Compiling_M5
80955SN/A"""
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
928878Ssteve.reinhardt@amd.comon 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
969812Sandreas.hansson@arm.com"""
979812Sandreas.hansson@arm.com    raise
985863Snate@binkert.org
999812Sandreas.hansson@arm.com# Global Python includes
1005863Snate@binkert.orgimport os
1015863Snate@binkert.orgimport re
1025863Snate@binkert.orgimport subprocess
1039812Sandreas.hansson@arm.comimport sys
1049812Sandreas.hansson@arm.com
1055863Snate@binkert.orgfrom os import mkdir, environ
1065863Snate@binkert.orgfrom os.path import abspath, basename, dirname, expanduser, normpath
1078878Ssteve.reinhardt@amd.comfrom os.path import exists,  isdir, isfile
1085863Snate@binkert.orgfrom os.path import join as joinpath, split as splitpath
1095863Snate@binkert.org
1105863Snate@binkert.org# SCons includes
1116654Snate@binkert.orgimport SCons
11210196SCurtis.Dunham@arm.comimport SCons.Node
113955SN/A
1145396Ssaidi@eecs.umich.edu# M5 includes
1155863Snate@binkert.orgsys.path[1:1] = [ Dir('src/python').srcnode().abspath ]
1165863Snate@binkert.org
1174202Sbinkertn@umich.edufrom m5.util import compareVersions, readCommand
1185863Snate@binkert.org
1195863Snate@binkert.org########################################################################
1205863Snate@binkert.org#
1215863Snate@binkert.org# Set up the main build environment.
122955SN/A#
1236654Snate@binkert.org########################################################################
1245273Sstever@gmail.comuse_vars = set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH', 'PATH',
1255871Snate@binkert.org                 'RANLIB' ])
1265273Sstever@gmail.com
1276655Snate@binkert.orguse_env = {}
1288878Ssteve.reinhardt@amd.comfor key,val in os.environ.iteritems():
1296655Snate@binkert.org    if key in use_vars or key.startswith("M5"):
1306655Snate@binkert.org        use_env[key] = val
1319219Spower.jg@gmail.com
1326655Snate@binkert.orgmain = Environment(ENV=use_env)
1335871Snate@binkert.orgmain.root = Dir(".")         # The current directory (where this file lives).
1346654Snate@binkert.orgmain.srcdir = Dir("src")     # The source directory
1358947Sandreas.hansson@arm.com
1365396Ssaidi@eecs.umich.edu########################################################################
1378120Sgblack@eecs.umich.edu#
1388120Sgblack@eecs.umich.edu# Mercurial Stuff.
1398120Sgblack@eecs.umich.edu#
1408120Sgblack@eecs.umich.edu# If the M5 directory is a mercurial repository, we should do some
1418120Sgblack@eecs.umich.edu# extra things.
1428120Sgblack@eecs.umich.edu#
1438120Sgblack@eecs.umich.edu########################################################################
1448120Sgblack@eecs.umich.edu
1458879Ssteve.reinhardt@amd.comhgdir = main.root.Dir(".hg")
1468879Ssteve.reinhardt@amd.com
1478879Ssteve.reinhardt@amd.commercurial_style_message = """
1488879Ssteve.reinhardt@amd.comYou're missing the M5 style hook.
1498879Ssteve.reinhardt@amd.comPlease install the hook so we can ensure that all code fits a common style.
1508879Ssteve.reinhardt@amd.com
1518879Ssteve.reinhardt@amd.comAll you'd need to do is add the following lines to your repository .hg/hgrc
1528879Ssteve.reinhardt@amd.comor your personal .hgrc
1538879Ssteve.reinhardt@amd.com----------------
1548879Ssteve.reinhardt@amd.com
1558879Ssteve.reinhardt@amd.com[extensions]
1568879Ssteve.reinhardt@amd.comstyle = %s/util/style.py
1578879Ssteve.reinhardt@amd.com
1588120Sgblack@eecs.umich.edu[hooks]
1598120Sgblack@eecs.umich.edupretxncommit.style = python:style.check_whitespace
1608120Sgblack@eecs.umich.edu""" % (main.root)
1618120Sgblack@eecs.umich.edu
1628120Sgblack@eecs.umich.edumercurial_bin_not_found = """
1638120Sgblack@eecs.umich.eduMercurial binary cannot be found, unfortunately this means that we
1648120Sgblack@eecs.umich.educannot easily determine the version of M5 that you are running and
1658120Sgblack@eecs.umich.eduthis makes error messages more difficult to collect.  Please consider
1668120Sgblack@eecs.umich.eduinstalling mercurial if you choose to post an error message
1678120Sgblack@eecs.umich.edu"""
1688120Sgblack@eecs.umich.edu
1698120Sgblack@eecs.umich.edumercurial_lib_not_found = """
1708120Sgblack@eecs.umich.eduMercurial libraries cannot be found, ignoring style hook
1718120Sgblack@eecs.umich.eduIf you are actually a M5 developer, please fix this and
1728879Ssteve.reinhardt@amd.comrun the style hook. It is important.
1738879Ssteve.reinhardt@amd.com"""
1748879Ssteve.reinhardt@amd.com
1758879Ssteve.reinhardt@amd.comhg_info = "Unknown"
17610458Sandreas.hansson@arm.comif hgdir.exists():
17710458Sandreas.hansson@arm.com    # 1) Grab repository revision if we know it.
17810458Sandreas.hansson@arm.com    cmd = "hg id -n -i -t -b"
1798879Ssteve.reinhardt@amd.com    try:
1808879Ssteve.reinhardt@amd.com        hg_info = readCommand(cmd, cwd=main.root.abspath).strip()
1818879Ssteve.reinhardt@amd.com    except OSError:
1828879Ssteve.reinhardt@amd.com        print mercurial_bin_not_found
1839227Sandreas.hansson@arm.com
1849227Sandreas.hansson@arm.com    # 2) Ensure that the style hook is in place.
1858879Ssteve.reinhardt@amd.com    try:
1868879Ssteve.reinhardt@amd.com        ui = None
1878879Ssteve.reinhardt@amd.com        if ARGUMENTS.get('IGNORE_STYLE') != 'True':
1888879Ssteve.reinhardt@amd.com            from mercurial import ui
18910453SAndrew.Bardsley@arm.com            ui = ui.ui()
19010453SAndrew.Bardsley@arm.com    except ImportError:
19110453SAndrew.Bardsley@arm.com        print mercurial_lib_not_found
19210456SCurtis.Dunham@arm.com
19310456SCurtis.Dunham@arm.com    if ui is not None:
19410456SCurtis.Dunham@arm.com        ui.readconfig(hgdir.File('hgrc').abspath)
19510457Sandreas.hansson@arm.com        style_hook = ui.config('hooks', 'pretxncommit.style', None)
19610457Sandreas.hansson@arm.com
1978120Sgblack@eecs.umich.edu        if not style_hook:
1988947Sandreas.hansson@arm.com            print mercurial_style_message
1997816Ssteve.reinhardt@amd.com            sys.exit(1)
2005871Snate@binkert.orgelse:
2015871Snate@binkert.org    print ".hg directory not found"
2026121Snate@binkert.org
2035871Snate@binkert.orgmain['HG_INFO'] = hg_info
2045871Snate@binkert.org
2059926Sstan.czerniawski@arm.com###################################################
2069926Sstan.czerniawski@arm.com#
2079119Sandreas.hansson@arm.com# Figure out which configurations to set up based on the path(s) of
20810068Sandreas.hansson@arm.com# the target(s).
20910068Sandreas.hansson@arm.com#
210955SN/A###################################################
2119416SAndreas.Sandberg@ARM.com
2129416SAndreas.Sandberg@ARM.com# Find default configuration & binary.
2139416SAndreas.Sandberg@ARM.comDefault(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA_SE/m5.debug'))
2149416SAndreas.Sandberg@ARM.com
2159416SAndreas.Sandberg@ARM.com# helper function: find last occurrence of element in list
2169416SAndreas.Sandberg@ARM.comdef rfind(l, elt, offs = -1):
2179416SAndreas.Sandberg@ARM.com    for i in range(len(l)+offs, 0, -1):
2185871Snate@binkert.org        if l[i] == elt:
21910584Sandreas.hansson@arm.com            return i
2209416SAndreas.Sandberg@ARM.com    raise ValueError, "element not found"
2219416SAndreas.Sandberg@ARM.com
2225871Snate@binkert.org# Each target must have 'build' in the interior of the path; the
223955SN/A# directory below this will determine the build parameters.  For
22410671Sandreas.hansson@arm.com# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
22510671Sandreas.hansson@arm.com# recognize that ALPHA_SE specifies the configuration because it
22610671Sandreas.hansson@arm.com# follow 'build' in the bulid path.
22710671Sandreas.hansson@arm.com
2288881Smarc.orr@gmail.com# Generate absolute paths to targets so we can see where the build dir is
2296121Snate@binkert.orgif COMMAND_LINE_TARGETS:
2306121Snate@binkert.org    # Ask SCons which directory it was invoked from
2311533SN/A    launch_dir = GetLaunchDir()
2329239Sandreas.hansson@arm.com    # Make targets relative to invocation directory
2339239Sandreas.hansson@arm.com    abs_targets = [ normpath(joinpath(launch_dir, str(x))) for x in \
2349239Sandreas.hansson@arm.com                    COMMAND_LINE_TARGETS]
2359239Sandreas.hansson@arm.comelse:
2369239Sandreas.hansson@arm.com    # Default targets are relative to root of tree
2379239Sandreas.hansson@arm.com    abs_targets = [ normpath(joinpath(main.root.abspath, str(x))) for x in \
2389239Sandreas.hansson@arm.com                    DEFAULT_TARGETS]
2399239Sandreas.hansson@arm.com
2409239Sandreas.hansson@arm.com
2419239Sandreas.hansson@arm.com# Generate a list of the unique build roots and configs that the
2429239Sandreas.hansson@arm.com# collected targets reference.
2439239Sandreas.hansson@arm.comvariant_paths = []
2446655Snate@binkert.orgbuild_root = None
2456655Snate@binkert.orgfor t in abs_targets:
2466655Snate@binkert.org    path_dirs = t.split('/')
2476655Snate@binkert.org    try:
2485871Snate@binkert.org        build_top = rfind(path_dirs, 'build', -2)
2495871Snate@binkert.org    except:
2505863Snate@binkert.org        print "Error: no non-leaf 'build' dir found on target path", t
2515871Snate@binkert.org        Exit(1)
2528878Ssteve.reinhardt@amd.com    this_build_root = joinpath('/',*path_dirs[:build_top+1])
2535871Snate@binkert.org    if not build_root:
2545871Snate@binkert.org        build_root = this_build_root
2555871Snate@binkert.org    else:
2565863Snate@binkert.org        if this_build_root != build_root:
2576121Snate@binkert.org            print "Error: build targets not under same build root\n"\
2585863Snate@binkert.org                  "  %s\n  %s" % (build_root, this_build_root)
2595871Snate@binkert.org            Exit(1)
2608336Ssteve.reinhardt@amd.com    variant_path = joinpath('/',*path_dirs[:build_top+2])
2618336Ssteve.reinhardt@amd.com    if variant_path not in variant_paths:
2628336Ssteve.reinhardt@amd.com        variant_paths.append(variant_path)
2638336Ssteve.reinhardt@amd.com
2644678Snate@binkert.org# Make sure build_root exists (might not if this is the first build there)
2658336Ssteve.reinhardt@amd.comif not isdir(build_root):
2668336Ssteve.reinhardt@amd.com    mkdir(build_root)
2678336Ssteve.reinhardt@amd.com
2684678Snate@binkert.orgExport('main')
2694678Snate@binkert.org
2704678Snate@binkert.orgmain.SConsignFile(joinpath(build_root, "sconsign"))
2714678Snate@binkert.org
2727827Snate@binkert.org# Default duplicate option is to use hard links, but this messes up
2737827Snate@binkert.org# when you use emacs to edit a file in the target dir, as emacs moves
2748336Ssteve.reinhardt@amd.com# file to file~ then copies to file, breaking the link.  Symbolic
2754678Snate@binkert.org# (soft) links work better.
2768336Ssteve.reinhardt@amd.commain.SetOption('duplicate', 'soft-copy')
2778336Ssteve.reinhardt@amd.com
2788336Ssteve.reinhardt@amd.com#
2798336Ssteve.reinhardt@amd.com# Set up global sticky variables... these are common to an entire build
2808336Ssteve.reinhardt@amd.com# tree (not specific to a particular build like ALPHA_SE)
2818336Ssteve.reinhardt@amd.com#
2825871Snate@binkert.org
2835871Snate@binkert.org# Variable validators & converters for global sticky variables
2848336Ssteve.reinhardt@amd.comdef PathListMakeAbsolute(val):
2858336Ssteve.reinhardt@amd.com    if not val:
2868336Ssteve.reinhardt@amd.com        return val
2878336Ssteve.reinhardt@amd.com    f = lambda p: abspath(expanduser(p))
2888336Ssteve.reinhardt@amd.com    return ':'.join(map(f, val.split(':')))
2895871Snate@binkert.org
2908336Ssteve.reinhardt@amd.comdef PathListAllExist(key, val, env):
2918336Ssteve.reinhardt@amd.com    if not val:
2928336Ssteve.reinhardt@amd.com        return
2938336Ssteve.reinhardt@amd.com    paths = val.split(':')
2948336Ssteve.reinhardt@amd.com    for path in paths:
2954678Snate@binkert.org        if not isdir(path):
2965871Snate@binkert.org            raise SCons.Errors.UserError("Path does not exist: '%s'" % path)
2974678Snate@binkert.org
2988336Ssteve.reinhardt@amd.comglobal_sticky_vars_file = joinpath(build_root, 'variables.global')
2998336Ssteve.reinhardt@amd.com
3008336Ssteve.reinhardt@amd.comglobal_sticky_vars = Variables(global_sticky_vars_file, args=ARGUMENTS)
3018336Ssteve.reinhardt@amd.com
3028336Ssteve.reinhardt@amd.comglobal_sticky_vars.AddVariables(
3038336Ssteve.reinhardt@amd.com    ('CC', 'C compiler', environ.get('CC', main['CC'])),
3048336Ssteve.reinhardt@amd.com    ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])),
3058336Ssteve.reinhardt@amd.com    ('BATCH', 'Use batch pool for build and tests', False),
3068336Ssteve.reinhardt@amd.com    ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
3078336Ssteve.reinhardt@amd.com    ('EXTRAS', 'Add Extra directories to the compilation', '',
3088336Ssteve.reinhardt@amd.com     PathListAllExist, PathListMakeAbsolute),
3098336Ssteve.reinhardt@amd.com    BoolVariable('RUBY', 'Build with Ruby', False),
3108336Ssteve.reinhardt@amd.com    )
3118336Ssteve.reinhardt@amd.com
3128336Ssteve.reinhardt@amd.com# base help text
3138336Ssteve.reinhardt@amd.comhelp_text = '''
3148336Ssteve.reinhardt@amd.comUsage: scons [scons options] [build options] [target(s)]
3155871Snate@binkert.org
3166121Snate@binkert.orgGlobal sticky options:
317955SN/A'''
318955SN/A
3192632Sstever@eecs.umich.eduhelp_text += global_sticky_vars.GenerateHelpText(main)
3202632Sstever@eecs.umich.edu
321955SN/A# Update main environment with values from ARGUMENTS & global_sticky_vars_file
322955SN/Aglobal_sticky_vars.Update(main)
323955SN/A
324955SN/A# Save sticky variable settings back to current variables file
3258878Ssteve.reinhardt@amd.comglobal_sticky_vars.Save(global_sticky_vars_file, main)
326955SN/A
3272632Sstever@eecs.umich.edu# Parse EXTRAS variable to build list of all directories where we're
3282632Sstever@eecs.umich.edu# look for sources etc.  This list is exported as base_dir_list.
3292632Sstever@eecs.umich.edubase_dir = main.srcdir.abspath
3302632Sstever@eecs.umich.eduif main['EXTRAS']:
3312632Sstever@eecs.umich.edu    extras_dir_list = main['EXTRAS'].split(':')
3322632Sstever@eecs.umich.eduelse:
3332632Sstever@eecs.umich.edu    extras_dir_list = []
3348268Ssteve.reinhardt@amd.com
3358268Ssteve.reinhardt@amd.comExport('base_dir')
3368268Ssteve.reinhardt@amd.comExport('extras_dir_list')
3378268Ssteve.reinhardt@amd.com
3388268Ssteve.reinhardt@amd.com# the ext directory should be on the #includes path
3398268Ssteve.reinhardt@amd.commain.Append(CPPPATH=[Dir('ext')])
3408268Ssteve.reinhardt@amd.com
3412632Sstever@eecs.umich.edu# M5_PLY is used by isa_parser.py to find the PLY package.
3422632Sstever@eecs.umich.edumain.Append(ENV = { 'M5_PLY' : Dir('ext/ply').abspath })
3432632Sstever@eecs.umich.edu
3442632Sstever@eecs.umich.eduCXX_version = readCommand([main['CXX'],'--version'], exception=False)
3458268Ssteve.reinhardt@amd.comCXX_V = readCommand([main['CXX'],'-V'], exception=False)
3462632Sstever@eecs.umich.edu
3478268Ssteve.reinhardt@amd.commain['GCC'] = CXX_version and CXX_version.find('g++') >= 0
3488268Ssteve.reinhardt@amd.commain['SUNCC'] = CXX_V and CXX_V.find('Sun C++') >= 0
3498268Ssteve.reinhardt@amd.commain['ICC'] = CXX_V and CXX_V.find('Intel') >= 0
3508268Ssteve.reinhardt@amd.comif main['GCC'] + main['SUNCC'] + main['ICC'] > 1:
3513718Sstever@eecs.umich.edu    print 'Error: How can we have two at the same time?'
3522634Sstever@eecs.umich.edu    Exit(1)
3532634Sstever@eecs.umich.edu
3545863Snate@binkert.org# Set up default C++ compiler flags
3552638Sstever@eecs.umich.eduif main['GCC']:
3568268Ssteve.reinhardt@amd.com    main.Append(CCFLAGS='-pipe')
3572632Sstever@eecs.umich.edu    main.Append(CCFLAGS='-fno-strict-aliasing')
3582632Sstever@eecs.umich.edu    main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef'])
3592632Sstever@eecs.umich.edu    main.Append(CXXFLAGS='-Wno-deprecated')
3602632Sstever@eecs.umich.eduelif main['ICC']:
3612632Sstever@eecs.umich.edu    pass #Fix me... add warning flags once we clean up icc warnings
3621858SN/Aelif main['SUNCC']:
3633716Sstever@eecs.umich.edu    main.Append(CCFLAGS='-Qoption ccfe')
3642638Sstever@eecs.umich.edu    main.Append(CCFLAGS='-features=gcc')
3652638Sstever@eecs.umich.edu    main.Append(CCFLAGS='-features=extensions')
3662638Sstever@eecs.umich.edu    main.Append(CCFLAGS='-library=stlport4')
3672638Sstever@eecs.umich.edu    main.Append(CCFLAGS='-xar')
3682638Sstever@eecs.umich.edu    #main.Append(CCFLAGS='-instances=semiexplicit')
3692638Sstever@eecs.umich.eduelse:
3702638Sstever@eecs.umich.edu    print 'Error: Don\'t know what compiler options to use for your compiler.'
3715863Snate@binkert.org    print '       Please fix SConstruct and src/SConscript and try again.'
3725863Snate@binkert.org    Exit(1)
3735863Snate@binkert.org
374955SN/A# Set up common yacc/bison flags (needed for Ruby)
3755341Sstever@gmail.commain['YACCFLAGS'] = '-d'
3765341Sstever@gmail.commain['YACCHXXFILESUFFIX'] = '.hh'
3775863Snate@binkert.org
3787756SAli.Saidi@ARM.com# Do this after we save setting back, or else we'll tack on an
3795341Sstever@gmail.com# extra 'qdo' every time we run scons.
3806121Snate@binkert.orgif main['BATCH']:
3814494Ssaidi@eecs.umich.edu    main['CC']     = main['BATCH_CMD'] + ' ' + main['CC']
3826121Snate@binkert.org    main['CXX']    = main['BATCH_CMD'] + ' ' + main['CXX']
3831105SN/A    main['AS']     = main['BATCH_CMD'] + ' ' + main['AS']
3842667Sstever@eecs.umich.edu    main['AR']     = main['BATCH_CMD'] + ' ' + main['AR']
3852667Sstever@eecs.umich.edu    main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB']
3862667Sstever@eecs.umich.edu
3872667Sstever@eecs.umich.eduif sys.platform == 'cygwin':
3886121Snate@binkert.org    # cygwin has some header file issues...
3892667Sstever@eecs.umich.edu    main.Append(CCFLAGS=Split("-Wno-uninitialized"))
3905341Sstever@gmail.com
3915863Snate@binkert.org# Check for SWIG
3925341Sstever@gmail.comif not main.has_key('SWIG'):
3935341Sstever@gmail.com    print 'Error: SWIG utility not found.'
3945341Sstever@gmail.com    print '       Please install (see http://www.swig.org) and retry.'
3958120Sgblack@eecs.umich.edu    Exit(1)
3965341Sstever@gmail.com
3978120Sgblack@eecs.umich.edu# Check for appropriate SWIG version
3985341Sstever@gmail.comswig_version = readCommand(('swig', '-version'), exception='').split()
3998120Sgblack@eecs.umich.edu# First 3 words should be "SWIG Version x.y.z"
4006121Snate@binkert.orgif len(swig_version) < 3 or \
4016121Snate@binkert.org        swig_version[0] != 'SWIG' or swig_version[1] != 'Version':
4028980Ssteve.reinhardt@amd.com    print 'Error determining SWIG version.'
4039396Sandreas.hansson@arm.com    Exit(1)
4045397Ssaidi@eecs.umich.edu
4055397Ssaidi@eecs.umich.edumin_swig_version = '1.3.28'
4067727SAli.Saidi@ARM.comif compareVersions(swig_version[2], min_swig_version) < 0:
4078268Ssteve.reinhardt@amd.com    print 'Error: SWIG version', min_swig_version, 'or newer required.'
4086168Snate@binkert.org    print '       Installed version:', swig_version[2]
4095341Sstever@gmail.com    Exit(1)
4108120Sgblack@eecs.umich.edu
4118120Sgblack@eecs.umich.edu# Set up SWIG flags & scanner
4128120Sgblack@eecs.umich.eduswig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
4136814Sgblack@eecs.umich.edumain.Append(SWIGFLAGS=swig_flags)
4145863Snate@binkert.org
4158120Sgblack@eecs.umich.edu# filter out all existing swig scanners, they mess up the dependency
4165341Sstever@gmail.com# stuff for some reason
4175863Snate@binkert.orgscanners = []
4188268Ssteve.reinhardt@amd.comfor scanner in main['SCANNERS']:
4196121Snate@binkert.org    skeys = scanner.skeys
4206121Snate@binkert.org    if skeys == '.i':
4218268Ssteve.reinhardt@amd.com        continue
4225742Snate@binkert.org
4235742Snate@binkert.org    if isinstance(skeys, (list, tuple)) and '.i' in skeys:
4245341Sstever@gmail.com        continue
4255742Snate@binkert.org
4265742Snate@binkert.org    scanners.append(scanner)
4275341Sstever@gmail.com
4286017Snate@binkert.org# add the new swig scanner that we like better
4296121Snate@binkert.orgfrom SCons.Scanner import ClassicCPP as CPPScanner
4306017Snate@binkert.orgswig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
4317816Ssteve.reinhardt@amd.comscanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re))
4327756SAli.Saidi@ARM.com
4337756SAli.Saidi@ARM.com# replace the scanners list that has what we want
4347756SAli.Saidi@ARM.commain['SCANNERS'] = scanners
4357756SAli.Saidi@ARM.com
4367756SAli.Saidi@ARM.com# Add a custom Check function to the Configure context so that we can
4377756SAli.Saidi@ARM.com# figure out if the compiler adds leading underscores to global
4387756SAli.Saidi@ARM.com# variables.  This is needed for the autogenerated asm files that we
4397756SAli.Saidi@ARM.com# use for embedding the python code.
4407816Ssteve.reinhardt@amd.comdef CheckLeading(context):
4417816Ssteve.reinhardt@amd.com    context.Message("Checking for leading underscore in global variables...")
4427816Ssteve.reinhardt@amd.com    # 1) Define a global variable called x from asm so the C compiler
4437816Ssteve.reinhardt@amd.com    #    won't change the symbol at all.
4447816Ssteve.reinhardt@amd.com    # 2) Declare that variable.
4457816Ssteve.reinhardt@amd.com    # 3) Use the variable
4467816Ssteve.reinhardt@amd.com    #
4477816Ssteve.reinhardt@amd.com    # If the compiler prepends an underscore, this will successfully
4487816Ssteve.reinhardt@amd.com    # link because the external symbol 'x' will be called '_x' which
4497816Ssteve.reinhardt@amd.com    # was defined by the asm statement.  If the compiler does not
4507756SAli.Saidi@ARM.com    # prepend an underscore, this will not successfully link because
4517816Ssteve.reinhardt@amd.com    # '_x' will have been defined by assembly, while the C portion of
4527816Ssteve.reinhardt@amd.com    # the code will be trying to use 'x'
4537816Ssteve.reinhardt@amd.com    ret = context.TryLink('''
4547816Ssteve.reinhardt@amd.com        asm(".globl _x; _x: .byte 0");
4557816Ssteve.reinhardt@amd.com        extern int x;
4567816Ssteve.reinhardt@amd.com        int main() { return x; }
4577816Ssteve.reinhardt@amd.com        ''', extension=".c")
4587816Ssteve.reinhardt@amd.com    context.env.Append(LEADING_UNDERSCORE=ret)
4597816Ssteve.reinhardt@amd.com    context.Result(ret)
4607816Ssteve.reinhardt@amd.com    return ret
4617816Ssteve.reinhardt@amd.com
4627816Ssteve.reinhardt@amd.com# Platform-specific configuration.  Note again that we assume that all
4637816Ssteve.reinhardt@amd.com# builds under a given build root run on the same host platform.
4647816Ssteve.reinhardt@amd.comconf = Configure(main,
4657816Ssteve.reinhardt@amd.com                 conf_dir = joinpath(build_root, '.scons_config'),
4667816Ssteve.reinhardt@amd.com                 log_file = joinpath(build_root, 'scons_config.log'),
4677816Ssteve.reinhardt@amd.com                 custom_tests = { 'CheckLeading' : CheckLeading })
4687816Ssteve.reinhardt@amd.com
4697816Ssteve.reinhardt@amd.com# Check for leading underscores.  Don't really need to worry either
4707816Ssteve.reinhardt@amd.com# way so don't need to check the return code.
4717816Ssteve.reinhardt@amd.comconf.CheckLeading()
4727816Ssteve.reinhardt@amd.com
4737816Ssteve.reinhardt@amd.com# Check if we should compile a 64 bit binary on Mac OS X/Darwin
4747816Ssteve.reinhardt@amd.comtry:
4757816Ssteve.reinhardt@amd.com    import platform
4767816Ssteve.reinhardt@amd.com    uname = platform.uname()
4777816Ssteve.reinhardt@amd.com    if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0:
4787816Ssteve.reinhardt@amd.com        if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
4797816Ssteve.reinhardt@amd.com            main.Append(CCFLAGS='-arch x86_64')
4807816Ssteve.reinhardt@amd.com            main.Append(CFLAGS='-arch x86_64')
4817816Ssteve.reinhardt@amd.com            main.Append(LINKFLAGS='-arch x86_64')
4827816Ssteve.reinhardt@amd.com            main.Append(ASFLAGS='-arch x86_64')
4837816Ssteve.reinhardt@amd.comexcept:
4847816Ssteve.reinhardt@amd.com    pass
4857816Ssteve.reinhardt@amd.com
4867816Ssteve.reinhardt@amd.com# Recent versions of scons substitute a "Null" object for Configure()
4877816Ssteve.reinhardt@amd.com# when configuration isn't necessary, e.g., if the "--help" option is
4887816Ssteve.reinhardt@amd.com# present.  Unfortuantely this Null object always returns false,
4897816Ssteve.reinhardt@amd.com# breaking all our configuration checks.  We replace it with our own
4907816Ssteve.reinhardt@amd.com# more optimistic null object that returns True instead.
4917816Ssteve.reinhardt@amd.comif not conf:
4927816Ssteve.reinhardt@amd.com    def NullCheck(*args, **kwargs):
4937816Ssteve.reinhardt@amd.com        return True
4947816Ssteve.reinhardt@amd.com
4957816Ssteve.reinhardt@amd.com    class NullConf:
4967816Ssteve.reinhardt@amd.com        def __init__(self, env):
4977816Ssteve.reinhardt@amd.com            self.env = env
4987816Ssteve.reinhardt@amd.com        def Finish(self):
4997816Ssteve.reinhardt@amd.com            return self.env
5007816Ssteve.reinhardt@amd.com        def __getattr__(self, mname):
5017816Ssteve.reinhardt@amd.com            return NullCheck
5027816Ssteve.reinhardt@amd.com
5037816Ssteve.reinhardt@amd.com    conf = NullConf(main)
5047816Ssteve.reinhardt@amd.com
5057816Ssteve.reinhardt@amd.com# Find Python include and library directories for embedding the
5067816Ssteve.reinhardt@amd.com# interpreter.  For consistency, we will use the same Python
5077816Ssteve.reinhardt@amd.com# installation used to run scons (and thus this script).  If you want
5087816Ssteve.reinhardt@amd.com# to link in an alternate version, see above for instructions on how
5097816Ssteve.reinhardt@amd.com# to invoke scons with a different copy of the Python interpreter.
5107816Ssteve.reinhardt@amd.comfrom distutils import sysconfig
5117816Ssteve.reinhardt@amd.com
5128947Sandreas.hansson@arm.compy_getvar = sysconfig.get_config_var
5138947Sandreas.hansson@arm.com
5147756SAli.Saidi@ARM.compy_version = 'python' + py_getvar('VERSION')
5158120Sgblack@eecs.umich.edu
5167756SAli.Saidi@ARM.compy_general_include = sysconfig.get_python_inc()
5177756SAli.Saidi@ARM.compy_platform_include = sysconfig.get_python_inc(plat_specific=True)
5187756SAli.Saidi@ARM.compy_includes = [ py_general_include ]
5197756SAli.Saidi@ARM.comif py_platform_include != py_general_include:
5207816Ssteve.reinhardt@amd.com    py_includes.append(py_platform_include)
5217816Ssteve.reinhardt@amd.com
5227816Ssteve.reinhardt@amd.compy_lib_path = [ py_getvar('LIBDIR') ]
5237816Ssteve.reinhardt@amd.com# add the prefix/lib/pythonX.Y/config dir, but only if there is no
5247816Ssteve.reinhardt@amd.com# shared library in prefix/lib/.
5257816Ssteve.reinhardt@amd.comif not py_getvar('Py_ENABLE_SHARED'):
5267816Ssteve.reinhardt@amd.com    py_lib_path.append(py_getvar('LIBPL'))
5277816Ssteve.reinhardt@amd.com
5287816Ssteve.reinhardt@amd.compy_libs = []
5297816Ssteve.reinhardt@amd.comfor lib in py_getvar('LIBS').split() + py_getvar('SYSLIBS').split():
5307756SAli.Saidi@ARM.com    assert lib.startswith('-l')
5317756SAli.Saidi@ARM.com    lib = lib[2:]   
5329227Sandreas.hansson@arm.com    if lib not in py_libs:
5339227Sandreas.hansson@arm.com        py_libs.append(lib)
5349227Sandreas.hansson@arm.compy_libs.append(py_version)
5359227Sandreas.hansson@arm.com
5369590Sandreas@sandberg.pp.semain.Append(CPPPATH=py_includes)
5379590Sandreas@sandberg.pp.semain.Append(LIBPATH=py_lib_path)
5389590Sandreas@sandberg.pp.se
5399590Sandreas@sandberg.pp.se# verify that this stuff works
5409590Sandreas@sandberg.pp.seif not conf.CheckHeader('Python.h', '<>'):
5419590Sandreas@sandberg.pp.se    print "Error: can't find Python.h header in", py_includes
5426654Snate@binkert.org    Exit(1)
5436654Snate@binkert.org
5445871Snate@binkert.orgfor lib in py_libs:
5456121Snate@binkert.org    if not conf.CheckLib(lib):
5468946Sandreas.hansson@arm.com        print "Error: can't find library %s required by python" % lib
5479419Sandreas.hansson@arm.com        Exit(1)
5483940Ssaidi@eecs.umich.edu
5493918Ssaidi@eecs.umich.edu# On Solaris you need to use libsocket for socket ops
5503918Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
5511858SN/A   if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
5529556Sandreas.hansson@arm.com       print "Can't find library with socket calls (e.g. accept())"
5539556Sandreas.hansson@arm.com       Exit(1)
5549556Sandreas.hansson@arm.com
5559556Sandreas.hansson@arm.com# Check for zlib.  If the check passes, libz will be automatically
5569556Sandreas.hansson@arm.com# added to the LIBS environment variable.
5579556Sandreas.hansson@arm.comif not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
5589556Sandreas.hansson@arm.com    print 'Error: did not find needed zlib compression library '\
55910878Sandreas.hansson@arm.com          'and/or zlib.h header file.'
56010878Sandreas.hansson@arm.com    print '       Please install zlib and try again.'
5619556Sandreas.hansson@arm.com    Exit(1)
5629556Sandreas.hansson@arm.com
5639556Sandreas.hansson@arm.com# Check for <fenv.h> (C99 FP environment control)
5649556Sandreas.hansson@arm.comhave_fenv = conf.CheckHeader('fenv.h', '<>')
5659556Sandreas.hansson@arm.comif not have_fenv:
5669556Sandreas.hansson@arm.com    print "Warning: Header file <fenv.h> not found."
5679556Sandreas.hansson@arm.com    print "         This host has no IEEE FP rounding mode control."
5689556Sandreas.hansson@arm.com
5699556Sandreas.hansson@arm.com######################################################################
5709556Sandreas.hansson@arm.com#
5719556Sandreas.hansson@arm.com# Check for mysql.
5729556Sandreas.hansson@arm.com#
5739556Sandreas.hansson@arm.commysql_config = WhereIs('mysql_config')
5749556Sandreas.hansson@arm.comhave_mysql = bool(mysql_config)
5759556Sandreas.hansson@arm.com
5769556Sandreas.hansson@arm.com# Check MySQL version.
5779556Sandreas.hansson@arm.comif have_mysql:
5789556Sandreas.hansson@arm.com    mysql_version = readCommand(mysql_config + ' --version')
5799556Sandreas.hansson@arm.com    min_mysql_version = '4.1'
5809556Sandreas.hansson@arm.com    if compareVersions(mysql_version, min_mysql_version) < 0:
5819556Sandreas.hansson@arm.com        print 'Warning: MySQL', min_mysql_version, 'or newer required.'
5829556Sandreas.hansson@arm.com        print '         Version', mysql_version, 'detected.'
5836121Snate@binkert.org        have_mysql = False
58410878Sandreas.hansson@arm.com
58510238Sandreas.hansson@arm.com# Set up mysql_config commands.
58610878Sandreas.hansson@arm.comif have_mysql:
5879420Sandreas.hansson@arm.com    mysql_config_include = mysql_config + ' --include'
58810878Sandreas.hansson@arm.com    if os.system(mysql_config_include + ' > /dev/null') != 0:
58910878Sandreas.hansson@arm.com        # older mysql_config versions don't support --include, use
5909420Sandreas.hansson@arm.com        # --cflags instead
5919420Sandreas.hansson@arm.com        mysql_config_include = mysql_config + ' --cflags | sed s/\\\'//g'
5929420Sandreas.hansson@arm.com    # This seems to work in all versions
5939420Sandreas.hansson@arm.com    mysql_config_libs = mysql_config + ' --libs'
5949420Sandreas.hansson@arm.com
59510264Sandreas.hansson@arm.com######################################################################
59610264Sandreas.hansson@arm.com#
59710264Sandreas.hansson@arm.com# Finish the configuration
59810264Sandreas.hansson@arm.com#
59910264Sandreas.hansson@arm.commain = conf.Finish()
60010866Sandreas.hansson@arm.com
60110866Sandreas.hansson@arm.com######################################################################
60210264Sandreas.hansson@arm.com#
60310866Sandreas.hansson@arm.com# Collect all non-global variables
60410866Sandreas.hansson@arm.com#
60510866Sandreas.hansson@arm.com
60610866Sandreas.hansson@arm.com# Define the universe of supported ISAs
60710866Sandreas.hansson@arm.comall_isa_list = [ ]
60810866Sandreas.hansson@arm.comExport('all_isa_list')
60910866Sandreas.hansson@arm.com
61010264Sandreas.hansson@arm.com# Define the universe of supported CPU models
61110264Sandreas.hansson@arm.comall_cpu_list = [ ]
61210264Sandreas.hansson@arm.comdefault_cpus = [ ]
61310264Sandreas.hansson@arm.comExport('all_cpu_list', 'default_cpus')
61410264Sandreas.hansson@arm.com
61510264Sandreas.hansson@arm.com# Sticky variables get saved in the variables file so they persist from
61610264Sandreas.hansson@arm.com# one invocation to the next (unless overridden, in which case the new
61710457Sandreas.hansson@arm.com# value becomes sticky).
61810457Sandreas.hansson@arm.comsticky_vars = Variables(args=ARGUMENTS)
61910457Sandreas.hansson@arm.comExport('sticky_vars')
62010457Sandreas.hansson@arm.com
62110457Sandreas.hansson@arm.com# Sticky variables that should be exported
62210457Sandreas.hansson@arm.comexport_vars = []
62310457Sandreas.hansson@arm.comExport('export_vars')
62410457Sandreas.hansson@arm.com
62510457Sandreas.hansson@arm.com# Non-sticky variables only apply to the current build.
62610238Sandreas.hansson@arm.comnonsticky_vars = Variables(args=ARGUMENTS)
62710238Sandreas.hansson@arm.comExport('nonsticky_vars')
62810238Sandreas.hansson@arm.com
62910238Sandreas.hansson@arm.com# Walk the tree and execute all SConsopts scripts that wil add to the
63010238Sandreas.hansson@arm.com# above variables
63110238Sandreas.hansson@arm.comfor bdir in [ base_dir ] + extras_dir_list:
63210416Sandreas.hansson@arm.com    for root, dirs, files in os.walk(bdir):
63310238Sandreas.hansson@arm.com        if 'SConsopts' in files:
6349227Sandreas.hansson@arm.com            print "Reading", joinpath(root, 'SConsopts')
63510238Sandreas.hansson@arm.com            SConscript(joinpath(root, 'SConsopts'))
63610416Sandreas.hansson@arm.com
63710416Sandreas.hansson@arm.comall_isa_list.sort()
6389227Sandreas.hansson@arm.comall_cpu_list.sort()
6399590Sandreas@sandberg.pp.sedefault_cpus.sort()
6409590Sandreas@sandberg.pp.se
6419590Sandreas@sandberg.pp.sesticky_vars.AddVariables(
6428737Skoansin.tan@gmail.com    EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list),
64310878Sandreas.hansson@arm.com    BoolVariable('FULL_SYSTEM', 'Full-system support', False),
64410878Sandreas.hansson@arm.com    ListVariable('CPU_MODELS', 'CPU models', default_cpus, all_cpu_list),
6459420Sandreas.hansson@arm.com    BoolVariable('NO_FAST_ALLOC', 'Disable fast object allocator', False),
6468737Skoansin.tan@gmail.com    BoolVariable('FAST_ALLOC_DEBUG', 'Enable fast object allocator debugging',
64710106SMitch.Hayenga@arm.com                 False),
6488737Skoansin.tan@gmail.com    BoolVariable('FAST_ALLOC_STATS', 'Enable fast object allocator statistics',
6498737Skoansin.tan@gmail.com                 False),
65010878Sandreas.hansson@arm.com    BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
65110878Sandreas.hansson@arm.com                 False),
6528737Skoansin.tan@gmail.com    BoolVariable('SS_COMPATIBLE_FP',
6538737Skoansin.tan@gmail.com                 'Make floating-point results compatible with SimpleScalar',
6548737Skoansin.tan@gmail.com                 False),
6558737Skoansin.tan@gmail.com    BoolVariable('USE_SSE2',
6568737Skoansin.tan@gmail.com                 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
6578737Skoansin.tan@gmail.com                 False),
6589556Sandreas.hansson@arm.com    BoolVariable('USE_MYSQL', 'Use MySQL for stats output', have_mysql),
6599556Sandreas.hansson@arm.com    BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
6609556Sandreas.hansson@arm.com    BoolVariable('USE_CHECKER', 'Use checker for detailed CPU models', False),
6619556Sandreas.hansson@arm.com    BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False),
6629556Sandreas.hansson@arm.com    )
6639556Sandreas.hansson@arm.com
6649556Sandreas.hansson@arm.comnonsticky_vars.AddVariables(
6659556Sandreas.hansson@arm.com    BoolVariable('update_ref', 'Update test reference outputs', False)
66610278SAndreas.Sandberg@ARM.com    )
66710278SAndreas.Sandberg@ARM.com
66810278SAndreas.Sandberg@ARM.com# These variables get exported to #defines in config/*.hh (see src/SConscript).
66910278SAndreas.Sandberg@ARM.comexport_vars += ['FULL_SYSTEM', 'USE_FENV', 'USE_MYSQL',
67010278SAndreas.Sandberg@ARM.com                'NO_FAST_ALLOC', 'FAST_ALLOC_DEBUG', 'FAST_ALLOC_STATS',
67110278SAndreas.Sandberg@ARM.com                'SS_COMPATIBLE_FP', 'USE_CHECKER', 'TARGET_ISA', 'CP_ANNOTATE']
6729556Sandreas.hansson@arm.com
6739590Sandreas@sandberg.pp.se###################################################
6749590Sandreas@sandberg.pp.se#
6759420Sandreas.hansson@arm.com# Define a SCons builder for configuration flag headers.
6769846Sandreas.hansson@arm.com#
6779846Sandreas.hansson@arm.com###################################################
6789846Sandreas.hansson@arm.com
6799846Sandreas.hansson@arm.com# This function generates a config header file that #defines the
6808946Sandreas.hansson@arm.com# variable symbol to the current variable setting (0 or 1).  The source
6813918Ssaidi@eecs.umich.edu# operands are the name of the variable and a Value node containing the
6829068SAli.Saidi@ARM.com# value of the variable.
6839068SAli.Saidi@ARM.comdef build_config_file(target, source, env):
6849068SAli.Saidi@ARM.com    (variable, value) = [s.get_contents() for s in source]
6859068SAli.Saidi@ARM.com    f = file(str(target[0]), 'w')
6869068SAli.Saidi@ARM.com    print >> f, '#define', variable, value
6879068SAli.Saidi@ARM.com    f.close()
6889068SAli.Saidi@ARM.com    return None
6899068SAli.Saidi@ARM.com
6909068SAli.Saidi@ARM.com# Generate the message to be printed when building the config file.
6919419Sandreas.hansson@arm.comdef build_config_file_string(target, source, env):
6929068SAli.Saidi@ARM.com    (variable, value) = [s.get_contents() for s in source]
6939068SAli.Saidi@ARM.com    return "Defining %s as %s in %s." % (variable, value, target[0])
6949068SAli.Saidi@ARM.com
6959068SAli.Saidi@ARM.com# Combine the two functions into a scons Action object.
6969068SAli.Saidi@ARM.comconfig_action = Action(build_config_file, build_config_file_string)
6979068SAli.Saidi@ARM.com
6983918Ssaidi@eecs.umich.edu# The emitter munges the source & target node lists to reflect what
6993918Ssaidi@eecs.umich.edu# we're really doing.
7006157Snate@binkert.orgdef config_emitter(target, source, env):
7016157Snate@binkert.org    # extract variable name from Builder arg
7026157Snate@binkert.org    variable = str(target[0])
7036157Snate@binkert.org    # True target is config header file
7045397Ssaidi@eecs.umich.edu    target = joinpath('config', variable.lower() + '.hh')
7055397Ssaidi@eecs.umich.edu    val = env[variable]
7066121Snate@binkert.org    if isinstance(val, bool):
7076121Snate@binkert.org        # Force value to 0/1
7086121Snate@binkert.org        val = int(val)
7096121Snate@binkert.org    elif isinstance(val, str):
7106121Snate@binkert.org        val = '"' + val + '"'
7116121Snate@binkert.org
7125397Ssaidi@eecs.umich.edu    # Sources are variable name & value (packaged in SCons Value nodes)
7131851SN/A    return ([target], [Value(variable), Value(val)])
7141851SN/A
7157739Sgblack@eecs.umich.educonfig_builder = Builder(emitter = config_emitter, action = config_action)
716955SN/A
7179396Sandreas.hansson@arm.commain.Append(BUILDERS = { 'ConfigFile' : config_builder })
7189396Sandreas.hansson@arm.com
7199396Sandreas.hansson@arm.com# libelf build is shared across all configs in the build root.
7209396Sandreas.hansson@arm.commain.SConscript('ext/libelf/SConscript',
7219396Sandreas.hansson@arm.com                variant_dir = joinpath(build_root, 'libelf'))
7229396Sandreas.hansson@arm.com
7239396Sandreas.hansson@arm.com# gzstream build is shared across all configs in the build root.
7249396Sandreas.hansson@arm.commain.SConscript('ext/gzstream/SConscript',
7259396Sandreas.hansson@arm.com                variant_dir = joinpath(build_root, 'gzstream'))
7269396Sandreas.hansson@arm.com
7279396Sandreas.hansson@arm.com###################################################
7289396Sandreas.hansson@arm.com#
7299396Sandreas.hansson@arm.com# This function is used to set up a directory with switching headers
7309396Sandreas.hansson@arm.com#
7319396Sandreas.hansson@arm.com###################################################
7329396Sandreas.hansson@arm.com
7339477Sandreas.hansson@arm.commain['ALL_ISA_LIST'] = all_isa_list
7349477Sandreas.hansson@arm.comdef make_switching_dir(dname, switch_headers, env):
7359477Sandreas.hansson@arm.com    # Generate the header.  target[0] is the full path of the output
7369477Sandreas.hansson@arm.com    # header to generate.  'source' is a dummy variable, since we get the
7379477Sandreas.hansson@arm.com    # list of ISAs from env['ALL_ISA_LIST'].
7389477Sandreas.hansson@arm.com    def gen_switch_hdr(target, source, env):
7399477Sandreas.hansson@arm.com        fname = str(target[0])
7409477Sandreas.hansson@arm.com        bname = basename(fname)
7419477Sandreas.hansson@arm.com        f = open(fname, 'w')
7429477Sandreas.hansson@arm.com        f.write('#include "arch/isa_specific.hh"\n')
7439477Sandreas.hansson@arm.com        cond = '#if'
7449477Sandreas.hansson@arm.com        for isa in all_isa_list:
7459477Sandreas.hansson@arm.com            f.write('%s THE_ISA == %s_ISA\n#include "%s/%s/%s"\n'
7469477Sandreas.hansson@arm.com                    % (cond, isa.upper(), dname, isa, bname))
7479477Sandreas.hansson@arm.com            cond = '#elif'
7489477Sandreas.hansson@arm.com        f.write('#else\n#error "THE_ISA not set"\n#endif\n')
7499477Sandreas.hansson@arm.com        f.close()
7509477Sandreas.hansson@arm.com        return 0
7519477Sandreas.hansson@arm.com
7529477Sandreas.hansson@arm.com    # String to print when generating header
7539477Sandreas.hansson@arm.com    def gen_switch_hdr_string(target, source, env):
7549477Sandreas.hansson@arm.com        return "Generating switch header " + str(target[0])
7559396Sandreas.hansson@arm.com
7563053Sstever@eecs.umich.edu    # Build SCons Action object. 'varlist' specifies env vars that this
7576121Snate@binkert.org    # action depends on; when env['ALL_ISA_LIST'] changes these actions
7583053Sstever@eecs.umich.edu    # should get re-executed.
7593053Sstever@eecs.umich.edu    switch_hdr_action = Action(gen_switch_hdr, gen_switch_hdr_string,
7603053Sstever@eecs.umich.edu                               varlist=['ALL_ISA_LIST'])
7613053Sstever@eecs.umich.edu
7623053Sstever@eecs.umich.edu    # Instantiate actions for each header
7639072Sandreas.hansson@arm.com    for hdr in switch_headers:
7643053Sstever@eecs.umich.edu        env.Command(hdr, [], switch_hdr_action)
7654742Sstever@eecs.umich.eduExport('make_switching_dir')
7664742Sstever@eecs.umich.edu
7673053Sstever@eecs.umich.edu###################################################
7683053Sstever@eecs.umich.edu#
7693053Sstever@eecs.umich.edu# Define build environments for selected configurations.
77010181SCurtis.Dunham@arm.com#
7716654Snate@binkert.org###################################################
7723053Sstever@eecs.umich.edu
7733053Sstever@eecs.umich.edufor variant_path in variant_paths:
7743053Sstever@eecs.umich.edu    print "Building in", variant_path
7753053Sstever@eecs.umich.edu
77610425Sandreas.hansson@arm.com    # Make a copy of the build-root environment to use for this config.
77710425Sandreas.hansson@arm.com    env = main.Clone()
77810425Sandreas.hansson@arm.com    env['BUILDDIR'] = variant_path
77910425Sandreas.hansson@arm.com
78010425Sandreas.hansson@arm.com    # variant_dir is the tail component of build path, and is used to
78110425Sandreas.hansson@arm.com    # determine the build parameters (e.g., 'ALPHA_SE')
78210425Sandreas.hansson@arm.com    (build_root, variant_dir) = splitpath(variant_path)
78310425Sandreas.hansson@arm.com
78410425Sandreas.hansson@arm.com    # Set env variables according to the build directory config.
78510425Sandreas.hansson@arm.com    sticky_vars.files = []
78610425Sandreas.hansson@arm.com    # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
7872667Sstever@eecs.umich.edu    # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
7884554Sbinkertn@umich.edu    # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
7896121Snate@binkert.org    current_vars_file = joinpath(build_root, 'variables', variant_dir)
7902667Sstever@eecs.umich.edu    if isfile(current_vars_file):
79110710Sandreas.hansson@arm.com        sticky_vars.files.append(current_vars_file)
79210710Sandreas.hansson@arm.com        print "Using saved variables file %s" % current_vars_file
79310710Sandreas.hansson@arm.com    else:
79410710Sandreas.hansson@arm.com        # Build dir-specific variables file doesn't exist.
79510710Sandreas.hansson@arm.com
79610710Sandreas.hansson@arm.com        # Make sure the directory is there so we can create it later
79710710Sandreas.hansson@arm.com        opt_dir = dirname(current_vars_file)
79810710Sandreas.hansson@arm.com        if not isdir(opt_dir):
79910710Sandreas.hansson@arm.com            mkdir(opt_dir)
80010384SCurtis.Dunham@arm.com
8014554Sbinkertn@umich.edu        # Get default build variables from source tree.  Variables are
8024554Sbinkertn@umich.edu        # normally determined by name of $VARIANT_DIR, but can be
8034554Sbinkertn@umich.edu        # overriden by 'default=' arg on command line.
8046121Snate@binkert.org        default_vars_file = joinpath('build_opts',
8054554Sbinkertn@umich.edu                                     ARGUMENTS.get('default', variant_dir))
8064554Sbinkertn@umich.edu        if isfile(default_vars_file):
8074554Sbinkertn@umich.edu            sticky_vars.files.append(default_vars_file)
8084781Snate@binkert.org            print "Variables file %s not found,\n  using defaults in %s" \
8094554Sbinkertn@umich.edu                  % (current_vars_file, default_vars_file)
8104554Sbinkertn@umich.edu        else:
8112667Sstever@eecs.umich.edu            print "Error: cannot find variables file %s or %s" \
8124554Sbinkertn@umich.edu                  % (current_vars_file, default_vars_file)
8134554Sbinkertn@umich.edu            Exit(1)
8144554Sbinkertn@umich.edu
8154554Sbinkertn@umich.edu    # Apply current variable settings to env
8162667Sstever@eecs.umich.edu    sticky_vars.Update(env)
8174554Sbinkertn@umich.edu    nonsticky_vars.Update(env)
8182667Sstever@eecs.umich.edu
8194554Sbinkertn@umich.edu    help_text += "\nSticky variables for %s:\n" % variant_dir \
8206121Snate@binkert.org                 + sticky_vars.GenerateHelpText(env) \
8212667Sstever@eecs.umich.edu                 + "\nNon-sticky variables for %s:\n" % variant_dir \
8225522Snate@binkert.org                 + nonsticky_vars.GenerateHelpText(env)
8235522Snate@binkert.org
8245522Snate@binkert.org    # Process variable settings.
8255522Snate@binkert.org
8265522Snate@binkert.org    if not have_fenv and env['USE_FENV']:
8275522Snate@binkert.org        print "Warning: <fenv.h> not available; " \
8285522Snate@binkert.org              "forcing USE_FENV to False in", variant_dir + "."
8295522Snate@binkert.org        env['USE_FENV'] = False
8305522Snate@binkert.org
8315522Snate@binkert.org    if not env['USE_FENV']:
8325522Snate@binkert.org        print "Warning: No IEEE FP rounding mode control in", variant_dir + "."
8335522Snate@binkert.org        print "         FP results may deviate slightly from other platforms."
8345522Snate@binkert.org
8355522Snate@binkert.org    if env['EFENCE']:
8365522Snate@binkert.org        env.Append(LIBS=['efence'])
8375522Snate@binkert.org
8385522Snate@binkert.org    if env['USE_MYSQL']:
8395522Snate@binkert.org        if not have_mysql:
8405522Snate@binkert.org            print "Warning: MySQL not available; " \
8415522Snate@binkert.org                  "forcing USE_MYSQL to False in", variant_dir + "."
8425522Snate@binkert.org            env['USE_MYSQL'] = False
8435522Snate@binkert.org        else:
8445522Snate@binkert.org            print "Compiling in", variant_dir, "with MySQL support."
8455522Snate@binkert.org            env.ParseConfig(mysql_config_libs)
8465522Snate@binkert.org            env.ParseConfig(mysql_config_include)
8475522Snate@binkert.org
8489986Sandreas@sandberg.pp.se    # Save sticky variable settings back to current variables file
8499986Sandreas@sandberg.pp.se    sticky_vars.Save(current_vars_file, env)
8509986Sandreas@sandberg.pp.se
8519986Sandreas@sandberg.pp.se    if env['USE_SSE2']:
8529986Sandreas@sandberg.pp.se        env.Append(CCFLAGS='-msse2')
8539986Sandreas@sandberg.pp.se
8549986Sandreas@sandberg.pp.se    # The src/SConscript file sets up the build rules in 'env' according
8559986Sandreas@sandberg.pp.se    # to the configured variables.  It returns a list of environments,
8569986Sandreas@sandberg.pp.se    # one for each variant build (debug, opt, etc.)
8579986Sandreas@sandberg.pp.se    envList = SConscript('src/SConscript', variant_dir = variant_path,
8589986Sandreas@sandberg.pp.se                         exports = 'env')
8599986Sandreas@sandberg.pp.se
8609986Sandreas@sandberg.pp.se    # Set up the regression tests for each build.
8619986Sandreas@sandberg.pp.se    for e in envList:
8629986Sandreas@sandberg.pp.se        SConscript('tests/SConscript',
8639986Sandreas@sandberg.pp.se                   variant_dir = joinpath(variant_path, 'tests', e.Label),
8649986Sandreas@sandberg.pp.se                   exports = { 'env' : e }, duplicate = False)
8659986Sandreas@sandberg.pp.se
8669986Sandreas@sandberg.pp.seHelp(help_text)
8679986Sandreas@sandberg.pp.se