SConstruct revision 5396
1955SN/A# -*- mode:python -*-
2955SN/A
31762SN/A# Copyright (c) 2004-2005 The Regents of The University of Michigan
4955SN/A# All rights reserved.
5955SN/A#
6955SN/A# Redistribution and use in source and binary forms, with or without
7955SN/A# modification, are permitted provided that the following conditions are
8955SN/A# met: redistributions of source code must retain the above copyright
9955SN/A# notice, this list of conditions and the following disclaimer;
10955SN/A# redistributions in binary form must reproduce the above copyright
11955SN/A# notice, this list of conditions and the following disclaimer in the
12955SN/A# documentation and/or other materials provided with the distribution;
13955SN/A# neither the name of the copyright holders nor the names of its
14955SN/A# contributors may be used to endorse or promote products derived from
15955SN/A# this software without specific prior written permission.
16955SN/A#
17955SN/A# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18955SN/A# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19955SN/A# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20955SN/A# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21955SN/A# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22955SN/A# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23955SN/A# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24955SN/A# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25955SN/A# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26955SN/A# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27955SN/A# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
282665Ssaidi@eecs.umich.edu#
292665Ssaidi@eecs.umich.edu# Authors: Steve Reinhardt
30955SN/A
31955SN/A###################################################
32955SN/A#
33955SN/A# SCons top-level build description (SConstruct) file.
34955SN/A#
352632Sstever@eecs.umich.edu# While in this directory ('m5'), just type 'scons' to build the default
362632Sstever@eecs.umich.edu# configuration (see below), or type 'scons build/<CONFIG>/<binary>'
372632Sstever@eecs.umich.edu# to build some other configuration (e.g., 'build/ALPHA_FS/m5.opt' for
382632Sstever@eecs.umich.edu# the optimized full-system version).
39955SN/A#
402632Sstever@eecs.umich.edu# You can build M5 in a different directory as long as there is a
412632Sstever@eecs.umich.edu# 'build/<CONFIG>' somewhere along the target path.  The build system
422761Sstever@eecs.umich.edu# expects that all configs under the same build directory are being
432632Sstever@eecs.umich.edu# built for the same host system.
442632Sstever@eecs.umich.edu#
452632Sstever@eecs.umich.edu# Examples:
462761Sstever@eecs.umich.edu#
472761Sstever@eecs.umich.edu#   The following two commands are equivalent.  The '-u' option tells
482761Sstever@eecs.umich.edu#   scons to search up the directory tree for this SConstruct file.
492632Sstever@eecs.umich.edu#   % cd <path-to-src>/m5 ; scons build/ALPHA_FS/m5.debug
502632Sstever@eecs.umich.edu#   % cd <path-to-src>/m5/build/ALPHA_FS; scons -u m5.debug
512761Sstever@eecs.umich.edu#
522761Sstever@eecs.umich.edu#   The following two commands are equivalent and demonstrate building
532761Sstever@eecs.umich.edu#   in a directory outside of the source tree.  The '-C' option tells
542761Sstever@eecs.umich.edu#   scons to chdir to the specified directory to find this SConstruct
552761Sstever@eecs.umich.edu#   file.
562632Sstever@eecs.umich.edu#   % cd <path-to-src>/m5 ; scons /local/foo/build/ALPHA_FS/m5.debug
572632Sstever@eecs.umich.edu#   % cd /local/foo/build/ALPHA_FS; scons -C <path-to-src>/m5 m5.debug
582632Sstever@eecs.umich.edu#
592632Sstever@eecs.umich.edu# You can use 'scons -H' to print scons options.  If you're in this
602632Sstever@eecs.umich.edu# 'm5' directory (or use -u or -C to tell scons where to find this
612632Sstever@eecs.umich.edu# file), you can use 'scons -h' to print all the M5-specific build
622632Sstever@eecs.umich.edu# options as well.
63955SN/A#
64955SN/A###################################################
65955SN/A
66955SN/Aimport sys
67955SN/Aimport os
685396Ssaidi@eecs.umich.eduimport re
694202Sbinkertn@umich.edu
705342Sstever@gmail.comfrom os.path import isdir, isfile, join as joinpath
71955SN/A
725273Sstever@gmail.comimport SCons
735273Sstever@gmail.com
742656Sstever@eecs.umich.edu# Check for recent-enough Python and SCons versions.  If your system's
752656Sstever@eecs.umich.edu# default installation of Python is not recent enough, you can use a
762656Sstever@eecs.umich.edu# non-default installation of the Python interpreter by either (1)
772656Sstever@eecs.umich.edu# rearranging your PATH so that scons finds the non-default 'python'
782656Sstever@eecs.umich.edu# first or (2) explicitly invoking an alternative interpreter on the
792656Sstever@eecs.umich.edu# scons script, e.g., "/usr/local/bin/python2.4 `which scons` [args]".
802656Sstever@eecs.umich.eduEnsurePythonVersion(2,4)
812653Sstever@eecs.umich.edu
825227Ssaidi@eecs.umich.edu# Import subprocess after we check the version since it doesn't exist in
835227Ssaidi@eecs.umich.edu# Python < 2.4.
845227Ssaidi@eecs.umich.eduimport subprocess
855227Ssaidi@eecs.umich.edu
865396Ssaidi@eecs.umich.edu# helper function: compare arrays or strings of version numbers.
875396Ssaidi@eecs.umich.edu# E.g., compare_version((1,3,25), (1,4,1)')
885396Ssaidi@eecs.umich.edu# returns -1, 0, 1 if v1 is <, ==, > v2
895396Ssaidi@eecs.umich.edudef compare_versions(v1, v2):
905396Ssaidi@eecs.umich.edu    def make_version_list(v):
915396Ssaidi@eecs.umich.edu        if isinstance(v, (list,tuple)):
925396Ssaidi@eecs.umich.edu            return v
935396Ssaidi@eecs.umich.edu        elif isinstance(v, str):
945396Ssaidi@eecs.umich.edu            return map(int, v.split('.'))
955396Ssaidi@eecs.umich.edu        else:
965396Ssaidi@eecs.umich.edu            raise TypeError
975396Ssaidi@eecs.umich.edu
985396Ssaidi@eecs.umich.edu    v1 = make_version_list(v1)
995396Ssaidi@eecs.umich.edu    v2 = make_version_list(v2)
1005396Ssaidi@eecs.umich.edu    # Compare corresponding elements of lists
1015396Ssaidi@eecs.umich.edu    for n1,n2 in zip(v1, v2):
1025396Ssaidi@eecs.umich.edu        if n1 < n2: return -1
1035396Ssaidi@eecs.umich.edu        if n1 > n2: return  1
1045396Ssaidi@eecs.umich.edu    # all corresponding values are equal... see if one has extra values
1055396Ssaidi@eecs.umich.edu    if len(v1) < len(v2): return -1
1065396Ssaidi@eecs.umich.edu    if len(v1) > len(v2): return  1
1075396Ssaidi@eecs.umich.edu    return 0
1085396Ssaidi@eecs.umich.edu
1095396Ssaidi@eecs.umich.edu# SCons version numbers need special processing because they can have
1105396Ssaidi@eecs.umich.edu# charecters and an release date embedded in them. This function does
1115396Ssaidi@eecs.umich.edu# the magic to extract them in a similar way to the SCons internal function
1125396Ssaidi@eecs.umich.edu# function does and then checks that the current version is not contained in
1135396Ssaidi@eecs.umich.edu# a list of version tuples (bad_ver_strs)
1145396Ssaidi@eecs.umich.edudef CheckSCons(bad_ver_strs):
1155396Ssaidi@eecs.umich.edu    def scons_ver(v):
1165396Ssaidi@eecs.umich.edu        num_parts = v.split(' ')[0].split('.')
1175396Ssaidi@eecs.umich.edu        major = int(num_parts[0])
1185396Ssaidi@eecs.umich.edu        minor = int(re.match('\d+', num_parts[1]).group())
1195396Ssaidi@eecs.umich.edu        rev = 0
1205396Ssaidi@eecs.umich.edu        rdate = 0
1215396Ssaidi@eecs.umich.edu        if len(num_parts) > 2:
1225396Ssaidi@eecs.umich.edu            try: rev = int(re.match('\d+', num_parts[2]).group())
1235396Ssaidi@eecs.umich.edu            except: pass
1245396Ssaidi@eecs.umich.edu            rev_parts = num_parts[2].split('d')
1255396Ssaidi@eecs.umich.edu            if len(rev_parts) > 1:
1265396Ssaidi@eecs.umich.edu                rdate = int(re.match('\d+', rev_parts[1]).group())
1275396Ssaidi@eecs.umich.edu
1285396Ssaidi@eecs.umich.edu        return (major, minor, rev, rdate)
1295396Ssaidi@eecs.umich.edu
1305396Ssaidi@eecs.umich.edu    sc_ver = scons_ver(SCons.__version__)
1315396Ssaidi@eecs.umich.edu    for bad_ver in bad_ver_strs:
1325396Ssaidi@eecs.umich.edu        bv = (scons_ver(bad_ver[0]), scons_ver(bad_ver[1]))
1335396Ssaidi@eecs.umich.edu        if  compare_versions(sc_ver, bv[0]) != -1 and\
1345396Ssaidi@eecs.umich.edu            compare_versions(sc_ver, bv[1]) != 1:
1355396Ssaidi@eecs.umich.edu            print "The version of SCons that you have installed: ", SCons.__version__
1365396Ssaidi@eecs.umich.edu            print "has a bug that prevents it from working correctly with M5."
1375396Ssaidi@eecs.umich.edu            print "Please install a version NOT contained within the following",
1385396Ssaidi@eecs.umich.edu            print "ranges (inclusive):"
1395396Ssaidi@eecs.umich.edu            for bad_ver in bad_ver_strs:
1405396Ssaidi@eecs.umich.edu                print "    %s - %s" % bad_ver
1415396Ssaidi@eecs.umich.edu            Exit(2)
1425396Ssaidi@eecs.umich.edu
1435396Ssaidi@eecs.umich.eduCheckSCons(( 
1445396Ssaidi@eecs.umich.edu    # We need a version that is 0.96.91 or newer
1455396Ssaidi@eecs.umich.edu    ('0.0.0', '0.96.90'), 
1465396Ssaidi@eecs.umich.edu    # This range has a bug with linking directories into the build dir
1475396Ssaidi@eecs.umich.edu    # that only have header files in them 
1485396Ssaidi@eecs.umich.edu    ('0.97.0d20071212', '0.98.0')
1495396Ssaidi@eecs.umich.edu    ))
1504781Snate@binkert.org
1511852SN/A
152955SN/A# The absolute path to the current directory (where this file lives).
153955SN/AROOT = Dir('.').abspath
154955SN/A
1553717Sstever@eecs.umich.edu# Path to the M5 source tree.
1563716Sstever@eecs.umich.eduSRCDIR = joinpath(ROOT, 'src')
157955SN/A
1581533SN/A# tell python where to find m5 python code
1593716Sstever@eecs.umich.edusys.path.append(joinpath(ROOT, 'src/python'))
1601533SN/A
1614678Snate@binkert.orgdef check_style_hook(ui):
1624678Snate@binkert.org    ui.readconfig(joinpath(ROOT, '.hg', 'hgrc'))
1634678Snate@binkert.org    style_hook = ui.config('hooks', 'pretxncommit.style', None)
1644678Snate@binkert.org
1654678Snate@binkert.org    if not style_hook:
1664678Snate@binkert.org        print """\
1674678Snate@binkert.orgYou're missing the M5 style hook.
1684678Snate@binkert.orgPlease install the hook so we can ensure that all code fits a common style.
1694678Snate@binkert.org
1704678Snate@binkert.orgAll you'd need to do is add the following lines to your repository .hg/hgrc
1714678Snate@binkert.orgor your personal .hgrc
1724678Snate@binkert.org----------------
1734678Snate@binkert.org
1744678Snate@binkert.org[extensions]
1754678Snate@binkert.orgstyle = %s/util/style.py
1764678Snate@binkert.org
1774678Snate@binkert.org[hooks]
1784678Snate@binkert.orgpretxncommit.style = python:style.check_whitespace
1794678Snate@binkert.org""" % (ROOT)
1804678Snate@binkert.org        sys.exit(1)
1814678Snate@binkert.org
1824973Ssaidi@eecs.umich.eduif ARGUMENTS.get('IGNORE_STYLE') != 'True' and isdir(joinpath(ROOT, '.hg')):
1834678Snate@binkert.org    try:
1844678Snate@binkert.org        from mercurial import ui
1854678Snate@binkert.org        check_style_hook(ui.ui())
1864678Snate@binkert.org    except ImportError:
1874678Snate@binkert.org        pass
1884678Snate@binkert.org
189955SN/A###################################################
190955SN/A#
1912632Sstever@eecs.umich.edu# Figure out which configurations to set up based on the path(s) of
1922632Sstever@eecs.umich.edu# the target(s).
193955SN/A#
194955SN/A###################################################
195955SN/A
196955SN/A# Find default configuration & binary.
1972632Sstever@eecs.umich.eduDefault(os.environ.get('M5_DEFAULT_BINARY', 'build/ALPHA_SE/m5.debug'))
198955SN/A
1992632Sstever@eecs.umich.edu# helper function: find last occurrence of element in list
2002632Sstever@eecs.umich.edudef rfind(l, elt, offs = -1):
2012632Sstever@eecs.umich.edu    for i in range(len(l)+offs, 0, -1):
2022632Sstever@eecs.umich.edu        if l[i] == elt:
2032632Sstever@eecs.umich.edu            return i
2042632Sstever@eecs.umich.edu    raise ValueError, "element not found"
2052632Sstever@eecs.umich.edu
2062632Sstever@eecs.umich.edu# Each target must have 'build' in the interior of the path; the
2072632Sstever@eecs.umich.edu# directory below this will determine the build parameters.  For
2082632Sstever@eecs.umich.edu# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
2092632Sstever@eecs.umich.edu# recognize that ALPHA_SE specifies the configuration because it
2102632Sstever@eecs.umich.edu# follow 'build' in the bulid path.
2112632Sstever@eecs.umich.edu
2123718Sstever@eecs.umich.edu# Generate absolute paths to targets so we can see where the build dir is
2133718Sstever@eecs.umich.eduif COMMAND_LINE_TARGETS:
2143718Sstever@eecs.umich.edu    # Ask SCons which directory it was invoked from
2153718Sstever@eecs.umich.edu    launch_dir = GetLaunchDir()
2163718Sstever@eecs.umich.edu    # Make targets relative to invocation directory
2173718Sstever@eecs.umich.edu    abs_targets = map(lambda x: os.path.normpath(joinpath(launch_dir, str(x))),
2183718Sstever@eecs.umich.edu                      COMMAND_LINE_TARGETS)
2193718Sstever@eecs.umich.eduelse:
2203718Sstever@eecs.umich.edu    # Default targets are relative to root of tree
2213718Sstever@eecs.umich.edu    abs_targets = map(lambda x: os.path.normpath(joinpath(ROOT, str(x))),
2223718Sstever@eecs.umich.edu                      DEFAULT_TARGETS)
2233718Sstever@eecs.umich.edu
2243718Sstever@eecs.umich.edu
2252634Sstever@eecs.umich.edu# Generate a list of the unique build roots and configs that the
2262634Sstever@eecs.umich.edu# collected targets reference.
2272632Sstever@eecs.umich.edubuild_paths = []
2282638Sstever@eecs.umich.edubuild_root = None
2292632Sstever@eecs.umich.edufor t in abs_targets:
2302632Sstever@eecs.umich.edu    path_dirs = t.split('/')
2312632Sstever@eecs.umich.edu    try:
2322632Sstever@eecs.umich.edu        build_top = rfind(path_dirs, 'build', -2)
2332632Sstever@eecs.umich.edu    except:
2342632Sstever@eecs.umich.edu        print "Error: no non-leaf 'build' dir found on target path", t
2351858SN/A        Exit(1)
2363716Sstever@eecs.umich.edu    this_build_root = joinpath('/',*path_dirs[:build_top+1])
2372638Sstever@eecs.umich.edu    if not build_root:
2382638Sstever@eecs.umich.edu        build_root = this_build_root
2392638Sstever@eecs.umich.edu    else:
2402638Sstever@eecs.umich.edu        if this_build_root != build_root:
2412638Sstever@eecs.umich.edu            print "Error: build targets not under same build root\n"\
2422638Sstever@eecs.umich.edu                  "  %s\n  %s" % (build_root, this_build_root)
2432638Sstever@eecs.umich.edu            Exit(1)
2443716Sstever@eecs.umich.edu    build_path = joinpath('/',*path_dirs[:build_top+2])
2452634Sstever@eecs.umich.edu    if build_path not in build_paths:
2462634Sstever@eecs.umich.edu        build_paths.append(build_path)
247955SN/A
2485341Sstever@gmail.com# Make sure build_root exists (might not if this is the first build there)
2495341Sstever@gmail.comif not isdir(build_root):
2505341Sstever@gmail.com    os.mkdir(build_root)
2515341Sstever@gmail.com
252955SN/A###################################################
253955SN/A#
254955SN/A# Set up the default build environment.  This environment is copied
255955SN/A# and modified according to each selected configuration.
256955SN/A#
257955SN/A###################################################
258955SN/A
2591858SN/Aenv = Environment(ENV = os.environ,  # inherit user's environment vars
2601858SN/A                  ROOT = ROOT,
2612632Sstever@eecs.umich.edu                  SRCDIR = SRCDIR)
262955SN/A
2634494Ssaidi@eecs.umich.eduExport('env')
2644494Ssaidi@eecs.umich.edu
2653716Sstever@eecs.umich.eduenv.SConsignFile(joinpath(build_root,"sconsign"))
2661105SN/A
2672667Sstever@eecs.umich.edu# Default duplicate option is to use hard links, but this messes up
2682667Sstever@eecs.umich.edu# when you use emacs to edit a file in the target dir, as emacs moves
2692667Sstever@eecs.umich.edu# file to file~ then copies to file, breaking the link.  Symbolic
2702667Sstever@eecs.umich.edu# (soft) links work better.
2712667Sstever@eecs.umich.eduenv.SetOption('duplicate', 'soft-copy')
2722667Sstever@eecs.umich.edu
2731869SN/A# I waffle on this setting... it does avoid a few painful but
2741869SN/A# unnecessary builds, but it also seems to make trivial builds take
2751869SN/A# noticeably longer.
2761869SN/Aif False:
2771869SN/A    env.TargetSignatures('content')
2781065SN/A
2795341Sstever@gmail.com#
2805341Sstever@gmail.com# Set up global sticky options... these are common to an entire build
2815341Sstever@gmail.com# tree (not specific to a particular build like ALPHA_SE)
2825341Sstever@gmail.com#
2835341Sstever@gmail.com
2845341Sstever@gmail.com# Option validators & converters for global sticky options
2855341Sstever@gmail.comdef PathListMakeAbsolute(val):
2865341Sstever@gmail.com    if not val:
2875341Sstever@gmail.com        return val
2885341Sstever@gmail.com    f = lambda p: os.path.abspath(os.path.expanduser(p))
2895341Sstever@gmail.com    return ':'.join(map(f, val.split(':')))
2905341Sstever@gmail.com
2915341Sstever@gmail.comdef PathListAllExist(key, val, env):
2925341Sstever@gmail.com    if not val:
2935341Sstever@gmail.com        return
2945341Sstever@gmail.com    paths = val.split(':')
2955341Sstever@gmail.com    for path in paths:
2965341Sstever@gmail.com        if not isdir(path):
2975341Sstever@gmail.com            raise SCons.Errors.UserError("Path does not exist: '%s'" % path)
2985341Sstever@gmail.com
2995341Sstever@gmail.comglobal_sticky_opts_file = joinpath(build_root, 'options.global')
3005341Sstever@gmail.com
3015341Sstever@gmail.comglobal_sticky_opts = Options(global_sticky_opts_file, args=ARGUMENTS)
3025341Sstever@gmail.com
3035341Sstever@gmail.comglobal_sticky_opts.AddOptions(
3045341Sstever@gmail.com    ('CC', 'C compiler', os.environ.get('CC', env['CC'])),
3055341Sstever@gmail.com    ('CXX', 'C++ compiler', os.environ.get('CXX', env['CXX'])),
3065341Sstever@gmail.com    ('EXTRAS', 'Add Extra directories to the compilation', '',
3075341Sstever@gmail.com     PathListAllExist, PathListMakeAbsolute)
3085341Sstever@gmail.com    )    
3095341Sstever@gmail.com
3105341Sstever@gmail.com
3115341Sstever@gmail.com# base help text
3125341Sstever@gmail.comhelp_text = '''
3135341Sstever@gmail.comUsage: scons [scons options] [build options] [target(s)]
3145341Sstever@gmail.com
3155341Sstever@gmail.com'''
3165341Sstever@gmail.com
3175341Sstever@gmail.comhelp_text += "Global sticky options:\n" \
3185341Sstever@gmail.com             + global_sticky_opts.GenerateHelpText(env)
3195341Sstever@gmail.com
3205341Sstever@gmail.com# Update env with values from ARGUMENTS & file global_sticky_opts_file
3215341Sstever@gmail.comglobal_sticky_opts.Update(env)
3225341Sstever@gmail.com
3235341Sstever@gmail.com# Save sticky option settings back to current options file
3245341Sstever@gmail.comglobal_sticky_opts.Save(global_sticky_opts_file, env)
3255341Sstever@gmail.com
3265341Sstever@gmail.com# Parse EXTRAS option to build list of all directories where we're
3275341Sstever@gmail.com# look for sources etc.  This list is exported as base_dir_list.
3285344Sstever@gmail.combase_dir_list = [joinpath(ROOT, 'src')]
3295341Sstever@gmail.comif env['EXTRAS']:
3305341Sstever@gmail.com    base_dir_list += env['EXTRAS'].split(':')
3315341Sstever@gmail.com
3325341Sstever@gmail.comExport('base_dir_list')
3335341Sstever@gmail.com
3342632Sstever@eecs.umich.edu# M5_PLY is used by isa_parser.py to find the PLY package.
3355199Sstever@gmail.comenv.Append(ENV = { 'M5_PLY' : str(Dir('ext/ply')) })
3363918Ssaidi@eecs.umich.eduenv['GCC'] = False
3373918Ssaidi@eecs.umich.eduenv['SUNCC'] = False
3383940Ssaidi@eecs.umich.eduenv['ICC'] = False
3394781Snate@binkert.orgenv['GCC'] = subprocess.Popen(env['CXX'] + ' --version', shell=True,
3404781Snate@binkert.org        stdout=subprocess.PIPE, stderr=subprocess.STDOUT,
3413918Ssaidi@eecs.umich.edu        close_fds=True).communicate()[0].find('GCC') >= 0
3424781Snate@binkert.orgenv['SUNCC'] = subprocess.Popen(env['CXX'] + ' -V', shell=True,
3434781Snate@binkert.org        stdout=subprocess.PIPE, stderr=subprocess.STDOUT,
3443918Ssaidi@eecs.umich.edu        close_fds=True).communicate()[0].find('Sun C++') >= 0
3454781Snate@binkert.orgenv['ICC'] = subprocess.Popen(env['CXX'] + ' -V', shell=True,
3464781Snate@binkert.org        stdout=subprocess.PIPE, stderr=subprocess.STDOUT,
3473940Ssaidi@eecs.umich.edu        close_fds=True).communicate()[0].find('Intel') >= 0
3483942Ssaidi@eecs.umich.eduif env['GCC'] + env['SUNCC'] + env['ICC'] > 1:
3493940Ssaidi@eecs.umich.edu    print 'Error: How can we have two at the same time?'
3503918Ssaidi@eecs.umich.edu    Exit(1)
3513918Ssaidi@eecs.umich.edu
352955SN/A
3531858SN/A# Set up default C++ compiler flags
3543918Ssaidi@eecs.umich.eduif env['GCC']:
3553918Ssaidi@eecs.umich.edu    env.Append(CCFLAGS='-pipe')
3563918Ssaidi@eecs.umich.edu    env.Append(CCFLAGS='-fno-strict-aliasing')
3573918Ssaidi@eecs.umich.edu    env.Append(CCFLAGS=Split('-Wall -Wno-sign-compare -Werror -Wundef'))
3583940Ssaidi@eecs.umich.eduelif env['ICC']:
3593940Ssaidi@eecs.umich.edu    pass #Fix me... add warning flags once we clean up icc warnings
3603918Ssaidi@eecs.umich.eduelif env['SUNCC']:
3613918Ssaidi@eecs.umich.edu    env.Append(CCFLAGS='-Qoption ccfe')
3623918Ssaidi@eecs.umich.edu    env.Append(CCFLAGS='-features=gcc')
3633918Ssaidi@eecs.umich.edu    env.Append(CCFLAGS='-features=extensions')
3643918Ssaidi@eecs.umich.edu    env.Append(CCFLAGS='-library=stlport4')
3653918Ssaidi@eecs.umich.edu    env.Append(CCFLAGS='-xar')
3663918Ssaidi@eecs.umich.edu#    env.Append(CCFLAGS='-instances=semiexplicit')
3673918Ssaidi@eecs.umich.eduelse:
3683918Ssaidi@eecs.umich.edu    print 'Error: Don\'t know what compiler options to use for your compiler.'
3693940Ssaidi@eecs.umich.edu    print '       Please fix SConstruct and src/SConscript and try again.'
3703918Ssaidi@eecs.umich.edu    Exit(1)
3713918Ssaidi@eecs.umich.edu
3721851SN/Aif sys.platform == 'cygwin':
3731851SN/A    # cygwin has some header file issues...
3741858SN/A    env.Append(CCFLAGS=Split("-Wno-uninitialized"))
3755200Sstever@gmail.comenv.Append(CPPPATH=[Dir('ext/dnet')])
376955SN/A
3773053Sstever@eecs.umich.edu# Check for SWIG
3783053Sstever@eecs.umich.eduif not env.has_key('SWIG'):
3793053Sstever@eecs.umich.edu    print 'Error: SWIG utility not found.'
3803053Sstever@eecs.umich.edu    print '       Please install (see http://www.swig.org) and retry.'
3813053Sstever@eecs.umich.edu    Exit(1)
3823053Sstever@eecs.umich.edu
3833053Sstever@eecs.umich.edu# Check for appropriate SWIG version
3843053Sstever@eecs.umich.eduswig_version = os.popen('swig -version').read().split()
3853053Sstever@eecs.umich.edu# First 3 words should be "SWIG Version x.y.z"
3864742Sstever@eecs.umich.eduif len(swig_version) < 3 or \
3874742Sstever@eecs.umich.edu        swig_version[0] != 'SWIG' or swig_version[1] != 'Version':
3883053Sstever@eecs.umich.edu    print 'Error determining SWIG version.'
3893053Sstever@eecs.umich.edu    Exit(1)
3903053Sstever@eecs.umich.edu
3913053Sstever@eecs.umich.edumin_swig_version = '1.3.28'
3923053Sstever@eecs.umich.eduif compare_versions(swig_version[2], min_swig_version) < 0:
3933053Sstever@eecs.umich.edu    print 'Error: SWIG version', min_swig_version, 'or newer required.'
3943053Sstever@eecs.umich.edu    print '       Installed version:', swig_version[2]
3953053Sstever@eecs.umich.edu    Exit(1)
3963053Sstever@eecs.umich.edu
3972667Sstever@eecs.umich.edu# Set up SWIG flags & scanner
3984554Sbinkertn@umich.eduswig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
3994554Sbinkertn@umich.eduenv.Append(SWIGFLAGS=swig_flags)
4002667Sstever@eecs.umich.edu
4014554Sbinkertn@umich.edu# filter out all existing swig scanners, they mess up the dependency
4024554Sbinkertn@umich.edu# stuff for some reason
4034554Sbinkertn@umich.eduscanners = []
4044554Sbinkertn@umich.edufor scanner in env['SCANNERS']:
4054554Sbinkertn@umich.edu    skeys = scanner.skeys
4064554Sbinkertn@umich.edu    if skeys == '.i':
4074554Sbinkertn@umich.edu        continue
4084781Snate@binkert.org
4094554Sbinkertn@umich.edu    if isinstance(skeys, (list, tuple)) and '.i' in skeys:
4104554Sbinkertn@umich.edu        continue
4112667Sstever@eecs.umich.edu
4124554Sbinkertn@umich.edu    scanners.append(scanner)
4134554Sbinkertn@umich.edu
4144554Sbinkertn@umich.edu# add the new swig scanner that we like better
4154554Sbinkertn@umich.edufrom SCons.Scanner import ClassicCPP as CPPScanner
4162667Sstever@eecs.umich.eduswig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
4174554Sbinkertn@umich.eduscanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re))
4182667Sstever@eecs.umich.edu
4194554Sbinkertn@umich.edu# replace the scanners list that has what we want
4204554Sbinkertn@umich.eduenv['SCANNERS'] = scanners
4212667Sstever@eecs.umich.edu
4222638Sstever@eecs.umich.edu# Platform-specific configuration.  Note again that we assume that all
4232638Sstever@eecs.umich.edu# builds under a given build root run on the same host platform.
4242638Sstever@eecs.umich.educonf = Configure(env,
4253716Sstever@eecs.umich.edu                 conf_dir = joinpath(build_root, '.scons_config'),
4263716Sstever@eecs.umich.edu                 log_file = joinpath(build_root, 'scons_config.log'))
4271858SN/A
4285227Ssaidi@eecs.umich.edu# Check if we should compile a 64 bit binary on Mac OS X/Darwin
4295227Ssaidi@eecs.umich.edutry:
4305227Ssaidi@eecs.umich.edu    import platform
4315227Ssaidi@eecs.umich.edu    uname = platform.uname()
4325227Ssaidi@eecs.umich.edu    if uname[0] == 'Darwin' and compare_versions(uname[2], '9.0.0') >= 0:
4335227Ssaidi@eecs.umich.edu        if int(subprocess.Popen('sysctl -n hw.cpu64bit_capable', shell=True,
4345227Ssaidi@eecs.umich.edu               stdout=subprocess.PIPE, stderr=subprocess.STDOUT,
4355227Ssaidi@eecs.umich.edu               close_fds=True).communicate()[0][0]):
4365227Ssaidi@eecs.umich.edu            env.Append(CCFLAGS='-arch x86_64')
4375227Ssaidi@eecs.umich.edu            env.Append(CFLAGS='-arch x86_64')
4385227Ssaidi@eecs.umich.edu            env.Append(LINKFLAGS='-arch x86_64')
4395227Ssaidi@eecs.umich.edu            env.Append(ASFLAGS='-arch x86_64')
4405274Ssaidi@eecs.umich.edu            env['OSX64bit'] = True
4415227Ssaidi@eecs.umich.eduexcept:
4425227Ssaidi@eecs.umich.edu    pass
4435227Ssaidi@eecs.umich.edu
4445204Sstever@gmail.com# Recent versions of scons substitute a "Null" object for Configure()
4455204Sstever@gmail.com# when configuration isn't necessary, e.g., if the "--help" option is
4465204Sstever@gmail.com# present.  Unfortuantely this Null object always returns false,
4475204Sstever@gmail.com# breaking all our configuration checks.  We replace it with our own
4485204Sstever@gmail.com# more optimistic null object that returns True instead.
4495204Sstever@gmail.comif not conf:
4505204Sstever@gmail.com    def NullCheck(*args, **kwargs):
4515204Sstever@gmail.com        return True
4525204Sstever@gmail.com
4535204Sstever@gmail.com    class NullConf:
4545204Sstever@gmail.com        def __init__(self, env):
4555204Sstever@gmail.com            self.env = env
4565204Sstever@gmail.com        def Finish(self):
4575204Sstever@gmail.com            return self.env
4585204Sstever@gmail.com        def __getattr__(self, mname):
4595204Sstever@gmail.com            return NullCheck
4605204Sstever@gmail.com
4615204Sstever@gmail.com    conf = NullConf(env)
4625204Sstever@gmail.com
4633118Sstever@eecs.umich.edu# Find Python include and library directories for embedding the
4643118Sstever@eecs.umich.edu# interpreter.  For consistency, we will use the same Python
4653118Sstever@eecs.umich.edu# installation used to run scons (and thus this script).  If you want
4663118Sstever@eecs.umich.edu# to link in an alternate version, see above for instructions on how
4673118Sstever@eecs.umich.edu# to invoke scons with a different copy of the Python interpreter.
4683118Sstever@eecs.umich.edu
4693118Sstever@eecs.umich.edu# Get brief Python version name (e.g., "python2.4") for locating
4703118Sstever@eecs.umich.edu# include & library files
4713118Sstever@eecs.umich.edupy_version_name = 'python' + sys.version[:3]
4723118Sstever@eecs.umich.edu
4733118Sstever@eecs.umich.edu# include path, e.g. /usr/local/include/python2.4
4743716Sstever@eecs.umich.edupy_header_path = joinpath(sys.exec_prefix, 'include', py_version_name)
4753118Sstever@eecs.umich.eduenv.Append(CPPPATH = py_header_path)
4763118Sstever@eecs.umich.edu# verify that it works
4773118Sstever@eecs.umich.eduif not conf.CheckHeader('Python.h', '<>'):
4783118Sstever@eecs.umich.edu    print "Error: can't find Python.h header in", py_header_path
4793118Sstever@eecs.umich.edu    Exit(1)
4803118Sstever@eecs.umich.edu
4813118Sstever@eecs.umich.edu# add library path too if it's not in the default place
4823118Sstever@eecs.umich.edupy_lib_path = None
4833118Sstever@eecs.umich.eduif sys.exec_prefix != '/usr':
4843716Sstever@eecs.umich.edu    py_lib_path = joinpath(sys.exec_prefix, 'lib')
4853118Sstever@eecs.umich.eduelif sys.platform == 'cygwin':
4863118Sstever@eecs.umich.edu    # cygwin puts the .dll in /bin for some reason
4873118Sstever@eecs.umich.edu    py_lib_path = '/bin'
4883118Sstever@eecs.umich.eduif py_lib_path:
4893118Sstever@eecs.umich.edu    env.Append(LIBPATH = py_lib_path)
4903118Sstever@eecs.umich.edu    print 'Adding', py_lib_path, 'to LIBPATH for', py_version_name
4913118Sstever@eecs.umich.eduif not conf.CheckLib(py_version_name):
4923118Sstever@eecs.umich.edu    print "Error: can't find Python library", py_version_name
4933118Sstever@eecs.umich.edu    Exit(1)
4943118Sstever@eecs.umich.edu
4953483Ssaidi@eecs.umich.edu# On Solaris you need to use libsocket for socket ops
4963494Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
4973494Ssaidi@eecs.umich.edu   if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
4983483Ssaidi@eecs.umich.edu       print "Can't find library with socket calls (e.g. accept())"
4993483Ssaidi@eecs.umich.edu       Exit(1)
5003483Ssaidi@eecs.umich.edu
5013053Sstever@eecs.umich.edu# Check for zlib.  If the check passes, libz will be automatically
5023053Sstever@eecs.umich.edu# added to the LIBS environment variable.
5033918Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
5043053Sstever@eecs.umich.edu    print 'Error: did not find needed zlib compression library '\
5053053Sstever@eecs.umich.edu          'and/or zlib.h header file.'
5063053Sstever@eecs.umich.edu    print '       Please install zlib and try again.'
5073053Sstever@eecs.umich.edu    Exit(1)
5083053Sstever@eecs.umich.edu
5091858SN/A# Check for <fenv.h> (C99 FP environment control)
5101858SN/Ahave_fenv = conf.CheckHeader('fenv.h', '<>')
5111858SN/Aif not have_fenv:
5121858SN/A    print "Warning: Header file <fenv.h> not found."
5131858SN/A    print "         This host has no IEEE FP rounding mode control."
5141858SN/A
5151859SN/A# Check for mysql.
5161858SN/Amysql_config = WhereIs('mysql_config')
5171858SN/Ahave_mysql = mysql_config != None
5181858SN/A
5191859SN/A# Check MySQL version.
5201859SN/Aif have_mysql:
5211862SN/A    mysql_version = os.popen(mysql_config + ' --version').read()
5223053Sstever@eecs.umich.edu    min_mysql_version = '4.1'
5233053Sstever@eecs.umich.edu    if compare_versions(mysql_version, min_mysql_version) < 0:
5243053Sstever@eecs.umich.edu        print 'Warning: MySQL', min_mysql_version, 'or newer required.'
5253053Sstever@eecs.umich.edu        print '         Version', mysql_version, 'detected.'
5261859SN/A        have_mysql = False
5271859SN/A
5281859SN/A# Set up mysql_config commands.
5291859SN/Aif have_mysql:
5301859SN/A    mysql_config_include = mysql_config + ' --include'
5311859SN/A    if os.system(mysql_config_include + ' > /dev/null') != 0:
5321859SN/A        # older mysql_config versions don't support --include, use
5331859SN/A        # --cflags instead
5341862SN/A        mysql_config_include = mysql_config + ' --cflags | sed s/\\\'//g'
5351859SN/A    # This seems to work in all versions
5361859SN/A    mysql_config_libs = mysql_config + ' --libs'
5371859SN/A
5381858SN/Aenv = conf.Finish()
5391858SN/A
5402139SN/A# Define the universe of supported ISAs
5414202Sbinkertn@umich.eduall_isa_list = [ ]
5424202Sbinkertn@umich.eduExport('all_isa_list')
5432139SN/A
5442155SN/A# Define the universe of supported CPU models
5454202Sbinkertn@umich.eduall_cpu_list = [ ]
5464202Sbinkertn@umich.edudefault_cpus = [ ]
5474202Sbinkertn@umich.eduExport('all_cpu_list', 'default_cpus')
5482155SN/A
5491869SN/A# Sticky options get saved in the options file so they persist from
5501869SN/A# one invocation to the next (unless overridden, in which case the new
5511869SN/A# value becomes sticky).
5521869SN/Asticky_opts = Options(args=ARGUMENTS)
5534202Sbinkertn@umich.eduExport('sticky_opts')
5544202Sbinkertn@umich.edu
5554202Sbinkertn@umich.edu# Non-sticky options only apply to the current build.
5564202Sbinkertn@umich.edunonsticky_opts = Options(args=ARGUMENTS)
5574202Sbinkertn@umich.eduExport('nonsticky_opts')
5584202Sbinkertn@umich.edu
5594202Sbinkertn@umich.edu# Walk the tree and execute all SConsopts scripts that wil add to the
5604202Sbinkertn@umich.edu# above options
5615341Sstever@gmail.comfor base_dir in base_dir_list:
5625341Sstever@gmail.com    for root, dirs, files in os.walk(base_dir):
5635341Sstever@gmail.com        if 'SConsopts' in files:
5645342Sstever@gmail.com            print "Reading", joinpath(root, 'SConsopts')
5655342Sstever@gmail.com            SConscript(joinpath(root, 'SConsopts'))
5664202Sbinkertn@umich.edu
5674202Sbinkertn@umich.eduall_isa_list.sort()
5684202Sbinkertn@umich.eduall_cpu_list.sort()
5694202Sbinkertn@umich.edudefault_cpus.sort()
5704202Sbinkertn@umich.edu
5711869SN/Asticky_opts.AddOptions(
5724202Sbinkertn@umich.edu    EnumOption('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list),
5731869SN/A    BoolOption('FULL_SYSTEM', 'Full-system support', False),
5742508SN/A    # There's a bug in scons 0.96.1 that causes ListOptions with list
5752508SN/A    # values (more than one value) not to be able to be restored from
5762508SN/A    # a saved option file.  If this causes trouble then upgrade to
5772508SN/A    # scons 0.96.90 or later.
5784202Sbinkertn@umich.edu    ListOption('CPU_MODELS', 'CPU models', default_cpus, all_cpu_list),
5791869SN/A    BoolOption('NO_FAST_ALLOC', 'Disable fast object allocator', False),
5805385Sstever@gmail.com    BoolOption('FAST_ALLOC_DEBUG', 'Enable fast object allocator debugging',
5815385Sstever@gmail.com               False),
5825385Sstever@gmail.com    BoolOption('FAST_ALLOC_STATS', 'Enable fast object allocator statistics',
5835385Sstever@gmail.com               False),
5841869SN/A    BoolOption('EFENCE', 'Link with Electric Fence malloc debugger',
5851869SN/A               False),
5861869SN/A    BoolOption('SS_COMPATIBLE_FP',
5871869SN/A               'Make floating-point results compatible with SimpleScalar',
5881869SN/A               False),
5891965SN/A    BoolOption('USE_SSE2',
5901965SN/A               'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
5911965SN/A               False),
5921869SN/A    BoolOption('USE_MYSQL', 'Use MySQL for stats output', have_mysql),
5931869SN/A    BoolOption('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
5942733Sktlim@umich.edu    BoolOption('USE_CHECKER', 'Use checker for detailed CPU models', False),
5951884SN/A    BoolOption('BATCH', 'Use batch pool for build and tests', False),
5963356Sbinkertn@umich.edu    ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
5973356Sbinkertn@umich.edu    ('PYTHONHOME',
5983356Sbinkertn@umich.edu     'Override the default PYTHONHOME for this system (use with caution)',
5994773Snate@binkert.org     '%s:%s' % (sys.prefix, sys.exec_prefix)),
6001869SN/A    )
6011858SN/A
6021869SN/Anonsticky_opts.AddOptions(
6031869SN/A    BoolOption('update_ref', 'Update test reference outputs', False)
6041869SN/A    )
6051858SN/A
6062761Sstever@eecs.umich.edu# These options get exported to #defines in config/*.hh (see src/SConscript).
6071869SN/Aenv.ExportOptions = ['FULL_SYSTEM', 'ALPHA_TLASER', 'USE_FENV', \
6085385Sstever@gmail.com                     'USE_MYSQL', 'NO_FAST_ALLOC', 'FAST_ALLOC_DEBUG', \
6095385Sstever@gmail.com                     'FAST_ALLOC_STATS', 'SS_COMPATIBLE_FP', \
6103584Ssaidi@eecs.umich.edu                     'USE_CHECKER', 'PYTHONHOME', 'TARGET_ISA']
6111869SN/A
6121869SN/A# Define a handy 'no-op' action
6131869SN/Adef no_action(target, source, env):
6141869SN/A    return 0
6151869SN/A
6161869SN/Aenv.NoAction = Action(no_action, None)
6171858SN/A
618955SN/A###################################################
619955SN/A#
6201869SN/A# Define a SCons builder for configuration flag headers.
6211869SN/A#
6221869SN/A###################################################
6231869SN/A
6241869SN/A# This function generates a config header file that #defines the
6251869SN/A# option symbol to the current option setting (0 or 1).  The source
6261869SN/A# operands are the name of the option and a Value node containing the
6271869SN/A# value of the option.
6281869SN/Adef build_config_file(target, source, env):
6291869SN/A    (option, value) = [s.get_contents() for s in source]
6301869SN/A    f = file(str(target[0]), 'w')
6311869SN/A    print >> f, '#define', option, value
6321869SN/A    f.close()
6331869SN/A    return None
6341869SN/A
6351869SN/A# Generate the message to be printed when building the config file.
6361869SN/Adef build_config_file_string(target, source, env):
6371869SN/A    (option, value) = [s.get_contents() for s in source]
6381869SN/A    return "Defining %s as %s in %s." % (option, value, target[0])
6391869SN/A
6401869SN/A# Combine the two functions into a scons Action object.
6411869SN/Aconfig_action = Action(build_config_file, build_config_file_string)
6421869SN/A
6431869SN/A# The emitter munges the source & target node lists to reflect what
6441869SN/A# we're really doing.
6451869SN/Adef config_emitter(target, source, env):
6461869SN/A    # extract option name from Builder arg
6471869SN/A    option = str(target[0])
6481869SN/A    # True target is config header file
6493716Sstever@eecs.umich.edu    target = joinpath('config', option.lower() + '.hh')
6503356Sbinkertn@umich.edu    val = env[option]
6513356Sbinkertn@umich.edu    if isinstance(val, bool):
6523356Sbinkertn@umich.edu        # Force value to 0/1
6533356Sbinkertn@umich.edu        val = int(val)
6543356Sbinkertn@umich.edu    elif isinstance(val, str):
6553356Sbinkertn@umich.edu        val = '"' + val + '"'
6564781Snate@binkert.org
6571869SN/A    # Sources are option name & value (packaged in SCons Value nodes)
6581869SN/A    return ([target], [Value(option), Value(val)])
6591869SN/A
6601869SN/Aconfig_builder = Builder(emitter = config_emitter, action = config_action)
6611869SN/A
6621869SN/Aenv.Append(BUILDERS = { 'ConfigFile' : config_builder })
6631869SN/A
6642655Sstever@eecs.umich.edu###################################################
6652655Sstever@eecs.umich.edu#
6662655Sstever@eecs.umich.edu# Define a SCons builder for copying files.  This is used by the
6672655Sstever@eecs.umich.edu# Python zipfile code in src/python/SConscript, but is placed up here
6682655Sstever@eecs.umich.edu# since it's potentially more generally applicable.
6692655Sstever@eecs.umich.edu#
6702655Sstever@eecs.umich.edu###################################################
6712655Sstever@eecs.umich.edu
6722655Sstever@eecs.umich.educopy_builder = Builder(action = Copy("$TARGET", "$SOURCE"))
6732655Sstever@eecs.umich.edu
6742655Sstever@eecs.umich.eduenv.Append(BUILDERS = { 'CopyFile' : copy_builder })
6752655Sstever@eecs.umich.edu
6762655Sstever@eecs.umich.edu###################################################
6772655Sstever@eecs.umich.edu#
6782655Sstever@eecs.umich.edu# Define a simple SCons builder to concatenate files.
6792655Sstever@eecs.umich.edu#
6802655Sstever@eecs.umich.edu# Used to append the Python zip archive to the executable.
6812655Sstever@eecs.umich.edu#
6822655Sstever@eecs.umich.edu###################################################
6832655Sstever@eecs.umich.edu
6842655Sstever@eecs.umich.educoncat_builder = Builder(action = Action(['cat $SOURCES > $TARGET',
6852655Sstever@eecs.umich.edu                                          'chmod +x $TARGET']))
6862655Sstever@eecs.umich.edu
6872655Sstever@eecs.umich.eduenv.Append(BUILDERS = { 'Concat' : concat_builder })
6882655Sstever@eecs.umich.edu
6892655Sstever@eecs.umich.edu
6902638Sstever@eecs.umich.edu# libelf build is shared across all configs in the build root.
6912638Sstever@eecs.umich.eduenv.SConscript('ext/libelf/SConscript',
6923716Sstever@eecs.umich.edu               build_dir = joinpath(build_root, 'libelf'),
6932638Sstever@eecs.umich.edu               exports = 'env')
6942638Sstever@eecs.umich.edu
6951869SN/A###################################################
6961869SN/A#
6973546Sgblack@eecs.umich.edu# This function is used to set up a directory with switching headers
6983546Sgblack@eecs.umich.edu#
6993546Sgblack@eecs.umich.edu###################################################
7003546Sgblack@eecs.umich.edu
7014202Sbinkertn@umich.eduenv['ALL_ISA_LIST'] = all_isa_list
7023546Sgblack@eecs.umich.edudef make_switching_dir(dirname, switch_headers, env):
7033546Sgblack@eecs.umich.edu    # Generate the header.  target[0] is the full path of the output
7043546Sgblack@eecs.umich.edu    # header to generate.  'source' is a dummy variable, since we get the
7053546Sgblack@eecs.umich.edu    # list of ISAs from env['ALL_ISA_LIST'].
7063546Sgblack@eecs.umich.edu    def gen_switch_hdr(target, source, env):
7074781Snate@binkert.org        fname = str(target[0])
7084781Snate@binkert.org        basename = os.path.basename(fname)
7094781Snate@binkert.org        f = open(fname, 'w')
7104781Snate@binkert.org        f.write('#include "arch/isa_specific.hh"\n')
7114781Snate@binkert.org        cond = '#if'
7124781Snate@binkert.org        for isa in all_isa_list:
7134781Snate@binkert.org            f.write('%s THE_ISA == %s_ISA\n#include "%s/%s/%s"\n'
7144781Snate@binkert.org                    % (cond, isa.upper(), dirname, isa, basename))
7154781Snate@binkert.org            cond = '#elif'
7164781Snate@binkert.org        f.write('#else\n#error "THE_ISA not set"\n#endif\n')
7174781Snate@binkert.org        f.close()
7184781Snate@binkert.org        return 0
7193546Sgblack@eecs.umich.edu
7203546Sgblack@eecs.umich.edu    # String to print when generating header
7213546Sgblack@eecs.umich.edu    def gen_switch_hdr_string(target, source, env):
7224781Snate@binkert.org        return "Generating switch header " + str(target[0])
7233546Sgblack@eecs.umich.edu
7243546Sgblack@eecs.umich.edu    # Build SCons Action object. 'varlist' specifies env vars that this
7253546Sgblack@eecs.umich.edu    # action depends on; when env['ALL_ISA_LIST'] changes these actions
7263546Sgblack@eecs.umich.edu    # should get re-executed.
7273546Sgblack@eecs.umich.edu    switch_hdr_action = Action(gen_switch_hdr, gen_switch_hdr_string,
7283546Sgblack@eecs.umich.edu                               varlist=['ALL_ISA_LIST'])
7293546Sgblack@eecs.umich.edu
7303546Sgblack@eecs.umich.edu    # Instantiate actions for each header
7313546Sgblack@eecs.umich.edu    for hdr in switch_headers:
7323546Sgblack@eecs.umich.edu        env.Command(hdr, [], switch_hdr_action)
7334202Sbinkertn@umich.eduExport('make_switching_dir')
7343546Sgblack@eecs.umich.edu
7353546Sgblack@eecs.umich.edu###################################################
7363546Sgblack@eecs.umich.edu#
737955SN/A# Define build environments for selected configurations.
738955SN/A#
739955SN/A###################################################
740955SN/A
7411858SN/A# rename base env
7421858SN/Abase_env = env
7431858SN/A
7442632Sstever@eecs.umich.edufor build_path in build_paths:
7452632Sstever@eecs.umich.edu    print "Building in", build_path
7465343Sstever@gmail.com
7475343Sstever@gmail.com    # Make a copy of the build-root environment to use for this config.
7485343Sstever@gmail.com    env = base_env.Copy()
7494773Snate@binkert.org    env['BUILDDIR'] = build_path
7504773Snate@binkert.org
7512632Sstever@eecs.umich.edu    # build_dir is the tail component of build path, and is used to
7522632Sstever@eecs.umich.edu    # determine the build parameters (e.g., 'ALPHA_SE')
7532632Sstever@eecs.umich.edu    (build_root, build_dir) = os.path.split(build_path)
7542023SN/A
7552632Sstever@eecs.umich.edu    # Set env options according to the build directory config.
7562632Sstever@eecs.umich.edu    sticky_opts.files = []
7572632Sstever@eecs.umich.edu    # Options for $BUILD_ROOT/$BUILD_DIR are stored in
7582632Sstever@eecs.umich.edu    # $BUILD_ROOT/options/$BUILD_DIR so you can nuke
7592632Sstever@eecs.umich.edu    # $BUILD_ROOT/$BUILD_DIR without losing your options settings.
7603716Sstever@eecs.umich.edu    current_opts_file = joinpath(build_root, 'options', build_dir)
7615342Sstever@gmail.com    if isfile(current_opts_file):
7622632Sstever@eecs.umich.edu        sticky_opts.files.append(current_opts_file)
7632632Sstever@eecs.umich.edu        print "Using saved options file %s" % current_opts_file
7642632Sstever@eecs.umich.edu    else:
7652632Sstever@eecs.umich.edu        # Build dir-specific options file doesn't exist.
7662023SN/A
7672632Sstever@eecs.umich.edu        # Make sure the directory is there so we can create it later
7682632Sstever@eecs.umich.edu        opt_dir = os.path.dirname(current_opts_file)
7695342Sstever@gmail.com        if not isdir(opt_dir):
7701889SN/A            os.mkdir(opt_dir)
7712632Sstever@eecs.umich.edu
7722632Sstever@eecs.umich.edu        # Get default build options from source tree.  Options are
7732632Sstever@eecs.umich.edu        # normally determined by name of $BUILD_DIR, but can be
7742632Sstever@eecs.umich.edu        # overriden by 'default=' arg on command line.
7753716Sstever@eecs.umich.edu        default_opts_file = joinpath('build_opts',
7763716Sstever@eecs.umich.edu                                     ARGUMENTS.get('default', build_dir))
7775342Sstever@gmail.com        if isfile(default_opts_file):
7782632Sstever@eecs.umich.edu            sticky_opts.files.append(default_opts_file)
7792632Sstever@eecs.umich.edu            print "Options file %s not found,\n  using defaults in %s" \
7802632Sstever@eecs.umich.edu                  % (current_opts_file, default_opts_file)
7812632Sstever@eecs.umich.edu        else:
7822632Sstever@eecs.umich.edu            print "Error: cannot find options file %s or %s" \
7832632Sstever@eecs.umich.edu                  % (current_opts_file, default_opts_file)
7842632Sstever@eecs.umich.edu            Exit(1)
7851888SN/A
7861888SN/A    # Apply current option settings to env
7871869SN/A    sticky_opts.Update(env)
7881869SN/A    nonsticky_opts.Update(env)
7891858SN/A
7905341Sstever@gmail.com    help_text += "\nSticky options for %s:\n" % build_dir \
7912598SN/A                 + sticky_opts.GenerateHelpText(env) \
7922598SN/A                 + "\nNon-sticky options for %s:\n" % build_dir \
7932598SN/A                 + nonsticky_opts.GenerateHelpText(env)
7942598SN/A
7951858SN/A    # Process option settings.
7961858SN/A
7971858SN/A    if not have_fenv and env['USE_FENV']:
7981858SN/A        print "Warning: <fenv.h> not available; " \
7991858SN/A              "forcing USE_FENV to False in", build_dir + "."
8001858SN/A        env['USE_FENV'] = False
8011858SN/A
8021858SN/A    if not env['USE_FENV']:
8031858SN/A        print "Warning: No IEEE FP rounding mode control in", build_dir + "."
8041871SN/A        print "         FP results may deviate slightly from other platforms."
8051858SN/A
8061858SN/A    if env['EFENCE']:
8071858SN/A        env.Append(LIBS=['efence'])
8081858SN/A
8091858SN/A    if env['USE_MYSQL']:
8101858SN/A        if not have_mysql:
8111858SN/A            print "Warning: MySQL not available; " \
8121858SN/A                  "forcing USE_MYSQL to False in", build_dir + "."
8131858SN/A            env['USE_MYSQL'] = False
8141858SN/A        else:
8151858SN/A            print "Compiling in", build_dir, "with MySQL support."
8161859SN/A            env.ParseConfig(mysql_config_libs)
8171859SN/A            env.ParseConfig(mysql_config_include)
8181869SN/A
8191888SN/A    # Save sticky option settings back to current options file
8202632Sstever@eecs.umich.edu    sticky_opts.Save(current_opts_file, env)
8211869SN/A
8221884SN/A    # Do this after we save setting back, or else we'll tack on an
8231884SN/A    # extra 'qdo' every time we run scons.
8241884SN/A    if env['BATCH']:
8251884SN/A        env['CC']  = env['BATCH_CMD'] + ' ' + env['CC']
8261884SN/A        env['CXX'] = env['BATCH_CMD'] + ' ' + env['CXX']
8271884SN/A
8281965SN/A    if env['USE_SSE2']:
8291965SN/A        env.Append(CCFLAGS='-msse2')
8301965SN/A
8312761Sstever@eecs.umich.edu    # The src/SConscript file sets up the build rules in 'env' according
8321869SN/A    # to the configured options.  It returns a list of environments,
8331869SN/A    # one for each variant build (debug, opt, etc.)
8342632Sstever@eecs.umich.edu    envList = SConscript('src/SConscript', build_dir = build_path,
8352667Sstever@eecs.umich.edu                         exports = 'env')
8361869SN/A
8371869SN/A    # Set up the regression tests for each build.
8382929Sktlim@umich.edu    for e in envList:
8392929Sktlim@umich.edu        SConscript('tests/SConscript',
8403716Sstever@eecs.umich.edu                   build_dir = joinpath(build_path, 'tests', e.Label),
8412929Sktlim@umich.edu                   exports = { 'env' : e }, duplicate = False)
842955SN/A
8432598SN/AHelp(help_text)
8442598SN/A
8453546Sgblack@eecs.umich.edu
846955SN/A###################################################
847955SN/A#
848955SN/A# Let SCons do its thing.  At this point SCons will use the defined
8491530SN/A# build environments to build the requested targets.
850955SN/A#
851955SN/A###################################################
852955SN/A
853