SConstruct revision 8120
1955SN/A# -*- mode:python -*-
2955SN/A
35871Snate@binkert.org# Copyright (c) 2011 Advanced Micro Devices, Inc.
41762SN/A# Copyright (c) 2009 The Hewlett-Packard Development Company
5955SN/A# Copyright (c) 2004-2005 The Regents of The University of Michigan
6955SN/A# All rights reserved.
7955SN/A#
8955SN/A# Redistribution and use in source and binary forms, with or without
9955SN/A# modification, are permitted provided that the following conditions are
10955SN/A# met: redistributions of source code must retain the above copyright
11955SN/A# notice, this list of conditions and the following disclaimer;
12955SN/A# redistributions in binary form must reproduce the above copyright
13955SN/A# notice, this list of conditions and the following disclaimer in the
14955SN/A# documentation and/or other materials provided with the distribution;
15955SN/A# neither the name of the copyright holders nor the names of its
16955SN/A# contributors may be used to endorse or promote products derived from
17955SN/A# this software without specific prior written permission.
18955SN/A#
19955SN/A# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20955SN/A# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21955SN/A# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22955SN/A# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23955SN/A# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24955SN/A# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25955SN/A# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26955SN/A# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27955SN/A# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28955SN/A# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
292665Ssaidi@eecs.umich.edu# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
302665Ssaidi@eecs.umich.edu#
315863Snate@binkert.org# Authors: Steve Reinhardt
32955SN/A#          Nathan Binkert
33955SN/A
34955SN/A###################################################
35955SN/A#
36955SN/A# SCons top-level build description (SConstruct) file.
372632Sstever@eecs.umich.edu#
382632Sstever@eecs.umich.edu# While in this directory ('m5'), just type 'scons' to build the default
392632Sstever@eecs.umich.edu# configuration (see below), or type 'scons build/<CONFIG>/<binary>'
402632Sstever@eecs.umich.edu# to build some other configuration (e.g., 'build/ALPHA_FS/m5.opt' for
41955SN/A# the optimized full-system version).
422632Sstever@eecs.umich.edu#
432632Sstever@eecs.umich.edu# You can build M5 in a different directory as long as there is a
442761Sstever@eecs.umich.edu# 'build/<CONFIG>' somewhere along the target path.  The build system
452632Sstever@eecs.umich.edu# expects that all configs under the same build directory are being
462632Sstever@eecs.umich.edu# built for the same host system.
472632Sstever@eecs.umich.edu#
482761Sstever@eecs.umich.edu# Examples:
492761Sstever@eecs.umich.edu#
502761Sstever@eecs.umich.edu#   The following two commands are equivalent.  The '-u' option tells
512632Sstever@eecs.umich.edu#   scons to search up the directory tree for this SConstruct file.
522632Sstever@eecs.umich.edu#   % cd <path-to-src>/m5 ; scons build/ALPHA_FS/m5.debug
532761Sstever@eecs.umich.edu#   % cd <path-to-src>/m5/build/ALPHA_FS; scons -u m5.debug
542761Sstever@eecs.umich.edu#
552761Sstever@eecs.umich.edu#   The following two commands are equivalent and demonstrate building
562761Sstever@eecs.umich.edu#   in a directory outside of the source tree.  The '-C' option tells
572761Sstever@eecs.umich.edu#   scons to chdir to the specified directory to find this SConstruct
582632Sstever@eecs.umich.edu#   file.
592632Sstever@eecs.umich.edu#   % cd <path-to-src>/m5 ; scons /local/foo/build/ALPHA_FS/m5.debug
602632Sstever@eecs.umich.edu#   % cd /local/foo/build/ALPHA_FS; scons -C <path-to-src>/m5 m5.debug
612632Sstever@eecs.umich.edu#
622632Sstever@eecs.umich.edu# You can use 'scons -H' to print scons options.  If you're in this
632632Sstever@eecs.umich.edu# 'm5' directory (or use -u or -C to tell scons where to find this
642632Sstever@eecs.umich.edu# file), you can use 'scons -h' to print all the M5-specific build
65955SN/A# options as well.
66955SN/A#
67955SN/A###################################################
685863Snate@binkert.org
695863Snate@binkert.org# Check for recent-enough Python and SCons versions.
705863Snate@binkert.orgtry:
715863Snate@binkert.org    # Really old versions of scons only take two options for the
725863Snate@binkert.org    # function, so check once without the revision and once with the
735863Snate@binkert.org    # revision, the first instance will fail for stuff other than
745863Snate@binkert.org    # 0.98, and the second will fail for 0.98.0
755863Snate@binkert.org    EnsureSConsVersion(0, 98)
765863Snate@binkert.org    EnsureSConsVersion(0, 98, 1)
775863Snate@binkert.orgexcept SystemExit, e:
785863Snate@binkert.org    print """
795863Snate@binkert.orgFor more details, see:
805863Snate@binkert.org    http://m5sim.org/wiki/index.php/Compiling_M5
815863Snate@binkert.org"""
825863Snate@binkert.org    raise
835863Snate@binkert.org
845863Snate@binkert.org# We ensure the python version early because we have stuff that
855863Snate@binkert.org# requires python 2.4
865863Snate@binkert.orgtry:
875863Snate@binkert.org    EnsurePythonVersion(2, 4)
885863Snate@binkert.orgexcept SystemExit, e:
895863Snate@binkert.org    print """
905863Snate@binkert.orgYou can use a non-default installation of the Python interpreter by
915863Snate@binkert.orgeither (1) rearranging your PATH so that scons finds the non-default
925863Snate@binkert.org'python' first or (2) explicitly invoking an alternative interpreter
935863Snate@binkert.orgon the scons script.
945863Snate@binkert.org
955863Snate@binkert.orgFor more details, see:
965863Snate@binkert.org    http://m5sim.org/wiki/index.php/Using_a_non-default_Python_installation
975863Snate@binkert.org"""
985863Snate@binkert.org    raise
996654Snate@binkert.org
100955SN/A# Global Python includes
1015396Ssaidi@eecs.umich.eduimport os
1025863Snate@binkert.orgimport re
1035863Snate@binkert.orgimport subprocess
1044202Sbinkertn@umich.eduimport sys
1055863Snate@binkert.org
1065863Snate@binkert.orgfrom os import mkdir, environ
1075863Snate@binkert.orgfrom os.path import abspath, basename, dirname, expanduser, normpath
1085863Snate@binkert.orgfrom os.path import exists,  isdir, isfile
109955SN/Afrom os.path import join as joinpath, split as splitpath
1106654Snate@binkert.org
1115273Sstever@gmail.com# SCons includes
1125871Snate@binkert.orgimport SCons
1135273Sstever@gmail.comimport SCons.Node
1146654Snate@binkert.org
1156654Snate@binkert.orgextra_python_paths = [
1165871Snate@binkert.org    Dir('src/python').srcnode().abspath, # M5 includes
1176654Snate@binkert.org    Dir('ext/ply').srcnode().abspath, # ply is used by several files
1185396Ssaidi@eecs.umich.edu    ]
1195871Snate@binkert.org    
1205871Snate@binkert.orgsys.path[1:1] = extra_python_paths
1216121Snate@binkert.org
1225871Snate@binkert.orgfrom m5.util import compareVersions, readCommand
1235871Snate@binkert.org
1246003Snate@binkert.orghelp_texts = {
1256003Snate@binkert.org    "options" : "",
126955SN/A    "global_vars" : "",
1275871Snate@binkert.org    "local_vars" : ""
1285871Snate@binkert.org}
1295871Snate@binkert.org
1305871Snate@binkert.orgExport("help_texts")
131955SN/A
1326121Snate@binkert.orgdef AddM5Option(*args, **kwargs):
1336121Snate@binkert.org    col_width = 30
1346121Snate@binkert.org
1351533SN/A    help = "  " + ", ".join(args)
1365871Snate@binkert.org    if "help" in kwargs:
1375871Snate@binkert.org        length = len(help)
1385863Snate@binkert.org        if length >= col_width:
1395871Snate@binkert.org            help += "\n" + " " * col_width
1405871Snate@binkert.org        else:
1415871Snate@binkert.org            help += " " * (col_width - length)
1425871Snate@binkert.org        help += kwargs["help"]
1435871Snate@binkert.org    help_texts["options"] += help + "\n"
1445863Snate@binkert.org
1456121Snate@binkert.org    AddOption(*args, **kwargs)
1465863Snate@binkert.org
1475871Snate@binkert.orgAddM5Option('--colors', dest='use_colors', action='store_true',
1484678Snate@binkert.org            help="Add color to abbreviated scons output")
1494678Snate@binkert.orgAddM5Option('--no-colors', dest='use_colors', action='store_false',
1504678Snate@binkert.org            help="Don't add color to abbreviated scons output")
1514678Snate@binkert.orgAddM5Option('--default', dest='default', type='string', action='store',
1524678Snate@binkert.org            help='Override which build_opts file to use for defaults')
1534678Snate@binkert.orgAddM5Option('--ignore-style', dest='ignore_style', action='store_true',
1544678Snate@binkert.org            help='Disable style checking hooks')
1554678Snate@binkert.orgAddM5Option('--update-ref', dest='update_ref', action='store_true',
1564678Snate@binkert.org            help='Update test reference outputs')
1574678Snate@binkert.orgAddM5Option('--verbose', dest='verbose', action='store_true',
1584678Snate@binkert.org            help='Print full tool command lines')
1594678Snate@binkert.org
1606121Snate@binkert.orguse_colors = GetOption('use_colors')
1614678Snate@binkert.orgif use_colors:
1625871Snate@binkert.org    from m5.util.terminal import termcap
1635871Snate@binkert.orgelif use_colors is None:
1645871Snate@binkert.org    # option unspecified; default behavior is to use colors iff isatty
1655871Snate@binkert.org    from m5.util.terminal import tty_termcap as termcap
1665871Snate@binkert.orgelse:
1675871Snate@binkert.org    from m5.util.terminal import no_termcap as termcap
1685871Snate@binkert.org
1695871Snate@binkert.org########################################################################
1705871Snate@binkert.org#
1715871Snate@binkert.org# Set up the main build environment.
1725871Snate@binkert.org#
1735871Snate@binkert.org########################################################################
1745871Snate@binkert.orguse_vars = set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH', 'PATH',
1755990Ssaidi@eecs.umich.edu                 'PYTHONPATH', 'RANLIB' ])
1765871Snate@binkert.org
1775871Snate@binkert.orguse_env = {}
1785871Snate@binkert.orgfor key,val in os.environ.iteritems():
1794678Snate@binkert.org    if key in use_vars or key.startswith("M5"):
1806654Snate@binkert.org        use_env[key] = val
1815871Snate@binkert.org
1825871Snate@binkert.orgmain = Environment(ENV=use_env)
1835871Snate@binkert.orgmain.root = Dir(".")         # The current directory (where this file lives).
1845871Snate@binkert.orgmain.srcdir = Dir("src")     # The source directory
1855871Snate@binkert.org
1865871Snate@binkert.org# add useful python code PYTHONPATH so it can be used by subprocesses
1875871Snate@binkert.org# as well
1885871Snate@binkert.orgmain.AppendENVPath('PYTHONPATH', extra_python_paths)
1895871Snate@binkert.org
1904678Snate@binkert.org########################################################################
1915871Snate@binkert.org#
1924678Snate@binkert.org# Mercurial Stuff.
1935871Snate@binkert.org#
1945871Snate@binkert.org# If the M5 directory is a mercurial repository, we should do some
1955871Snate@binkert.org# extra things.
1965871Snate@binkert.org#
1975871Snate@binkert.org########################################################################
1985871Snate@binkert.org
1995871Snate@binkert.orghgdir = main.root.Dir(".hg")
2005871Snate@binkert.org
2015871Snate@binkert.orgmercurial_style_message = """
2026121Snate@binkert.orgYou're missing the M5 style hook.
2036121Snate@binkert.orgPlease install the hook so we can ensure that all code fits a common style.
2045863Snate@binkert.org
205955SN/AAll you'd need to do is add the following lines to your repository .hg/hgrc
206955SN/Aor your personal .hgrc
2072632Sstever@eecs.umich.edu----------------
2082632Sstever@eecs.umich.edu
209955SN/A[extensions]
210955SN/Astyle = %s/util/style.py
211955SN/A
212955SN/A[hooks]
2135863Snate@binkert.orgpretxncommit.style = python:style.check_style
214955SN/Apre-qrefresh.style = python:style.check_style
2152632Sstever@eecs.umich.edu""" % (main.root)
2162632Sstever@eecs.umich.edu
2172632Sstever@eecs.umich.edumercurial_bin_not_found = """
2182632Sstever@eecs.umich.eduMercurial binary cannot be found, unfortunately this means that we
2192632Sstever@eecs.umich.educannot easily determine the version of M5 that you are running and
2202632Sstever@eecs.umich.eduthis makes error messages more difficult to collect.  Please consider
2212632Sstever@eecs.umich.eduinstalling mercurial if you choose to post an error message
2222632Sstever@eecs.umich.edu"""
2232632Sstever@eecs.umich.edu
2242632Sstever@eecs.umich.edumercurial_lib_not_found = """
2252632Sstever@eecs.umich.eduMercurial libraries cannot be found, ignoring style hook
2262632Sstever@eecs.umich.eduIf you are actually a M5 developer, please fix this and
2272632Sstever@eecs.umich.edurun the style hook. It is important.
2283718Sstever@eecs.umich.edu"""
2293718Sstever@eecs.umich.edu
2303718Sstever@eecs.umich.eduhg_info = "Unknown"
2313718Sstever@eecs.umich.eduif hgdir.exists():
2323718Sstever@eecs.umich.edu    # 1) Grab repository revision if we know it.
2335863Snate@binkert.org    cmd = "hg id -n -i -t -b"
2345863Snate@binkert.org    try:
2353718Sstever@eecs.umich.edu        hg_info = readCommand(cmd, cwd=main.root.abspath).strip()
2363718Sstever@eecs.umich.edu    except OSError:
2376121Snate@binkert.org        print mercurial_bin_not_found
2385863Snate@binkert.org
2393718Sstever@eecs.umich.edu    # 2) Ensure that the style hook is in place.
2403718Sstever@eecs.umich.edu    try:
2412634Sstever@eecs.umich.edu        ui = None
2422634Sstever@eecs.umich.edu        if GetOption('ignore_style'):
2435863Snate@binkert.org            from mercurial import ui
2442638Sstever@eecs.umich.edu            ui = ui.ui()
2452632Sstever@eecs.umich.edu    except ImportError:
2462632Sstever@eecs.umich.edu        print mercurial_lib_not_found
2472632Sstever@eecs.umich.edu
2482632Sstever@eecs.umich.edu    if ui is not None:
2492632Sstever@eecs.umich.edu        ui.readconfig(hgdir.File('hgrc').abspath)
2502632Sstever@eecs.umich.edu        style_hook = ui.config('hooks', 'pretxncommit.style', None)
2511858SN/A
2523716Sstever@eecs.umich.edu        if not style_hook:
2532638Sstever@eecs.umich.edu            print mercurial_style_message
2542638Sstever@eecs.umich.edu            sys.exit(1)
2552638Sstever@eecs.umich.eduelse:
2562638Sstever@eecs.umich.edu    print ".hg directory not found"
2572638Sstever@eecs.umich.edu
2582638Sstever@eecs.umich.edumain['HG_INFO'] = hg_info
2592638Sstever@eecs.umich.edu
2605863Snate@binkert.org###################################################
2615863Snate@binkert.org#
2625863Snate@binkert.org# Figure out which configurations to set up based on the path(s) of
263955SN/A# the target(s).
2645341Sstever@gmail.com#
2655341Sstever@gmail.com###################################################
2665863Snate@binkert.org
2675341Sstever@gmail.com# Find default configuration & binary.
2686121Snate@binkert.orgDefault(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA_SE/m5.debug'))
2694494Ssaidi@eecs.umich.edu
2706121Snate@binkert.org# helper function: find last occurrence of element in list
2711105SN/Adef rfind(l, elt, offs = -1):
2722667Sstever@eecs.umich.edu    for i in range(len(l)+offs, 0, -1):
2732667Sstever@eecs.umich.edu        if l[i] == elt:
2742667Sstever@eecs.umich.edu            return i
2752667Sstever@eecs.umich.edu    raise ValueError, "element not found"
2766121Snate@binkert.org
2772667Sstever@eecs.umich.edu# Each target must have 'build' in the interior of the path; the
2785341Sstever@gmail.com# directory below this will determine the build parameters.  For
2795863Snate@binkert.org# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
2805341Sstever@gmail.com# recognize that ALPHA_SE specifies the configuration because it
2815341Sstever@gmail.com# follow 'build' in the bulid path.
2825341Sstever@gmail.com
2835863Snate@binkert.org# Generate absolute paths to targets so we can see where the build dir is
2845341Sstever@gmail.comif COMMAND_LINE_TARGETS:
2855341Sstever@gmail.com    # Ask SCons which directory it was invoked from
2865341Sstever@gmail.com    launch_dir = GetLaunchDir()
2875863Snate@binkert.org    # Make targets relative to invocation directory
2885341Sstever@gmail.com    abs_targets = [ normpath(joinpath(launch_dir, str(x))) for x in \
2895341Sstever@gmail.com                    COMMAND_LINE_TARGETS]
2905341Sstever@gmail.comelse:
2915341Sstever@gmail.com    # Default targets are relative to root of tree
2925341Sstever@gmail.com    abs_targets = [ normpath(joinpath(main.root.abspath, str(x))) for x in \
2935341Sstever@gmail.com                    DEFAULT_TARGETS]
2945341Sstever@gmail.com
2955341Sstever@gmail.com
2965341Sstever@gmail.com# Generate a list of the unique build roots and configs that the
2975341Sstever@gmail.com# collected targets reference.
2985863Snate@binkert.orgvariant_paths = []
2995341Sstever@gmail.combuild_root = None
3005863Snate@binkert.orgfor t in abs_targets:
3015341Sstever@gmail.com    path_dirs = t.split('/')
3025863Snate@binkert.org    try:
3036121Snate@binkert.org        build_top = rfind(path_dirs, 'build', -2)
3046121Snate@binkert.org    except:
3055397Ssaidi@eecs.umich.edu        print "Error: no non-leaf 'build' dir found on target path", t
3065397Ssaidi@eecs.umich.edu        Exit(1)
3075341Sstever@gmail.com    this_build_root = joinpath('/',*path_dirs[:build_top+1])
3086168Snate@binkert.org    if not build_root:
3096168Snate@binkert.org        build_root = this_build_root
3106168Snate@binkert.org    else:
3115341Sstever@gmail.com        if this_build_root != build_root:
3125341Sstever@gmail.com            print "Error: build targets not under same build root\n"\
3135341Sstever@gmail.com                  "  %s\n  %s" % (build_root, this_build_root)
3145341Sstever@gmail.com            Exit(1)
3155341Sstever@gmail.com    variant_path = joinpath('/',*path_dirs[:build_top+2])
3165863Snate@binkert.org    if variant_path not in variant_paths:
3175341Sstever@gmail.com        variant_paths.append(variant_path)
3185341Sstever@gmail.com
3196121Snate@binkert.org# Make sure build_root exists (might not if this is the first build there)
3205341Sstever@gmail.comif not isdir(build_root):
3216121Snate@binkert.org    mkdir(build_root)
3226121Snate@binkert.orgmain['BUILDROOT'] = build_root
3235341Sstever@gmail.com
3245863Snate@binkert.orgExport('main')
3256121Snate@binkert.org
3265341Sstever@gmail.commain.SConsignFile(joinpath(build_root, "sconsign"))
3275863Snate@binkert.org
3285341Sstever@gmail.com# Default duplicate option is to use hard links, but this messes up
3296121Snate@binkert.org# when you use emacs to edit a file in the target dir, as emacs moves
3306121Snate@binkert.org# file to file~ then copies to file, breaking the link.  Symbolic
3316121Snate@binkert.org# (soft) links work better.
3325742Snate@binkert.orgmain.SetOption('duplicate', 'soft-copy')
3335742Snate@binkert.org
3345341Sstever@gmail.com#
3355742Snate@binkert.org# Set up global sticky variables... these are common to an entire build
3365742Snate@binkert.org# tree (not specific to a particular build like ALPHA_SE)
3375341Sstever@gmail.com#
3386017Snate@binkert.org
3396121Snate@binkert.org# Variable validators & converters for global sticky variables
3406017Snate@binkert.orgdef PathListMakeAbsolute(val):
3412632Sstever@eecs.umich.edu    if not val:
3426121Snate@binkert.org        return val
3435871Snate@binkert.org    f = lambda p: abspath(expanduser(p))
3446654Snate@binkert.org    return ':'.join(map(f, val.split(':')))
3456654Snate@binkert.org
3465871Snate@binkert.orgdef PathListAllExist(key, val, env):
3476121Snate@binkert.org    if not val:
3486121Snate@binkert.org        return
3496121Snate@binkert.org    paths = val.split(':')
3506121Snate@binkert.org    for path in paths:
3513940Ssaidi@eecs.umich.edu        if not isdir(path):
3523918Ssaidi@eecs.umich.edu            raise SCons.Errors.UserError("Path does not exist: '%s'" % path)
3533918Ssaidi@eecs.umich.edu
3541858SN/Aglobal_vars_file = joinpath(build_root, 'variables.global')
3556121Snate@binkert.org
3566121Snate@binkert.orgglobal_vars = Variables(global_vars_file, args=ARGUMENTS)
3576121Snate@binkert.org
3586143Snate@binkert.orgglobal_vars.AddVariables(
3596121Snate@binkert.org    ('CC', 'C compiler', environ.get('CC', main['CC'])),
3606121Snate@binkert.org    ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])),
3613940Ssaidi@eecs.umich.edu    ('BATCH', 'Use batch pool for build and tests', False),
3626121Snate@binkert.org    ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
3636121Snate@binkert.org    ('M5_BUILD_CACHE', 'Cache built objects in this directory', False),
3646121Snate@binkert.org    ('EXTRAS', 'Add Extra directories to the compilation', '',
3656121Snate@binkert.org     PathListAllExist, PathListMakeAbsolute),
3666121Snate@binkert.org    )
3676121Snate@binkert.org
3686121Snate@binkert.org# Update main environment with values from ARGUMENTS & global_vars_file
3693918Ssaidi@eecs.umich.eduglobal_vars.Update(main)
3703918Ssaidi@eecs.umich.eduhelp_texts["global_vars"] += global_vars.GenerateHelpText(main)
3713940Ssaidi@eecs.umich.edu
3723918Ssaidi@eecs.umich.edu# Save sticky variable settings back to current variables file
3733918Ssaidi@eecs.umich.eduglobal_vars.Save(global_vars_file, main)
3746157Snate@binkert.org
3756157Snate@binkert.org# Parse EXTRAS variable to build list of all directories where we're
3766157Snate@binkert.org# look for sources etc.  This list is exported as base_dir_list.
3776157Snate@binkert.orgbase_dir = main.srcdir.abspath
3785397Ssaidi@eecs.umich.eduif main['EXTRAS']:
3795397Ssaidi@eecs.umich.edu    extras_dir_list = main['EXTRAS'].split(':')
3806121Snate@binkert.orgelse:
3816121Snate@binkert.org    extras_dir_list = []
3826121Snate@binkert.org
3836121Snate@binkert.orgExport('base_dir')
3846121Snate@binkert.orgExport('extras_dir_list')
3856121Snate@binkert.org
3865397Ssaidi@eecs.umich.edu# the ext directory should be on the #includes path
3871851SN/Amain.Append(CPPPATH=[Dir('ext')])
3881851SN/A
3896121Snate@binkert.orgdef strip_build_path(path, env):
390955SN/A    path = str(path)
3913053Sstever@eecs.umich.edu    variant_base = env['BUILDROOT'] + os.path.sep
3926121Snate@binkert.org    if path.startswith(variant_base):
3933053Sstever@eecs.umich.edu        path = path[len(variant_base):]
3943053Sstever@eecs.umich.edu    elif path.startswith('build/'):
3953053Sstever@eecs.umich.edu        path = path[6:]
3963053Sstever@eecs.umich.edu    return path
3973053Sstever@eecs.umich.edu
3986654Snate@binkert.org# Generate a string of the form:
3993053Sstever@eecs.umich.edu#   common/path/prefix/src1, src2 -> tgt1, tgt2
4004742Sstever@eecs.umich.edu# to print while building.
4014742Sstever@eecs.umich.educlass Transform(object):
4023053Sstever@eecs.umich.edu    # all specific color settings should be here and nowhere else
4033053Sstever@eecs.umich.edu    tool_color = termcap.Normal
4043053Sstever@eecs.umich.edu    pfx_color = termcap.Yellow
4053053Sstever@eecs.umich.edu    srcs_color = termcap.Yellow + termcap.Bold
4066654Snate@binkert.org    arrow_color = termcap.Blue + termcap.Bold
4073053Sstever@eecs.umich.edu    tgts_color = termcap.Yellow + termcap.Bold
4083053Sstever@eecs.umich.edu
4093053Sstever@eecs.umich.edu    def __init__(self, tool, max_sources=99):
4103053Sstever@eecs.umich.edu        self.format = self.tool_color + (" [%8s] " % tool) \
4112667Sstever@eecs.umich.edu                      + self.pfx_color + "%s" \
4124554Sbinkertn@umich.edu                      + self.srcs_color + "%s" \
4136121Snate@binkert.org                      + self.arrow_color + " -> " \
4142667Sstever@eecs.umich.edu                      + self.tgts_color + "%s" \
4154554Sbinkertn@umich.edu                      + termcap.Normal
4164554Sbinkertn@umich.edu        self.max_sources = max_sources
4174554Sbinkertn@umich.edu
4186121Snate@binkert.org    def __call__(self, target, source, env, for_signature=None):
4194554Sbinkertn@umich.edu        # truncate source list according to max_sources param
4204554Sbinkertn@umich.edu        source = source[0:self.max_sources]
4214554Sbinkertn@umich.edu        def strip(f):
4224781Snate@binkert.org            return strip_build_path(str(f), env)
4234554Sbinkertn@umich.edu        if len(source) > 0:
4244554Sbinkertn@umich.edu            srcs = map(strip, source)
4252667Sstever@eecs.umich.edu        else:
4264554Sbinkertn@umich.edu            srcs = ['']
4274554Sbinkertn@umich.edu        tgts = map(strip, target)
4284554Sbinkertn@umich.edu        # surprisingly, os.path.commonprefix is a dumb char-by-char string
4294554Sbinkertn@umich.edu        # operation that has nothing to do with paths.
4302667Sstever@eecs.umich.edu        com_pfx = os.path.commonprefix(srcs + tgts)
4314554Sbinkertn@umich.edu        com_pfx_len = len(com_pfx)
4322667Sstever@eecs.umich.edu        if com_pfx:
4334554Sbinkertn@umich.edu            # do some cleanup and sanity checking on common prefix
4346121Snate@binkert.org            if com_pfx[-1] == ".":
4352667Sstever@eecs.umich.edu                # prefix matches all but file extension: ok
4365522Snate@binkert.org                # back up one to change 'foo.cc -> o' to 'foo.cc -> .o'
4375522Snate@binkert.org                com_pfx = com_pfx[0:-1]
4385522Snate@binkert.org            elif com_pfx[-1] == "/":
4395522Snate@binkert.org                # common prefix is directory path: OK
4405522Snate@binkert.org                pass
4415522Snate@binkert.org            else:
4425522Snate@binkert.org                src0_len = len(srcs[0])
4435522Snate@binkert.org                tgt0_len = len(tgts[0])
4445522Snate@binkert.org                if src0_len == com_pfx_len:
4455522Snate@binkert.org                    # source is a substring of target, OK
4465522Snate@binkert.org                    pass
4475522Snate@binkert.org                elif tgt0_len == com_pfx_len:
4485522Snate@binkert.org                    # target is a substring of source, need to back up to
4495522Snate@binkert.org                    # avoid empty string on RHS of arrow
4505522Snate@binkert.org                    sep_idx = com_pfx.rfind(".")
4515522Snate@binkert.org                    if sep_idx != -1:
4525522Snate@binkert.org                        com_pfx = com_pfx[0:sep_idx]
4535522Snate@binkert.org                    else:
4545522Snate@binkert.org                        com_pfx = ''
4555522Snate@binkert.org                elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".":
4565522Snate@binkert.org                    # still splitting at file extension: ok
4575522Snate@binkert.org                    pass
4585522Snate@binkert.org                else:
4595522Snate@binkert.org                    # probably a fluke; ignore it
4605522Snate@binkert.org                    com_pfx = ''
4615522Snate@binkert.org        # recalculate length in case com_pfx was modified
4622638Sstever@eecs.umich.edu        com_pfx_len = len(com_pfx)
4632638Sstever@eecs.umich.edu        def fmt(files):
4646121Snate@binkert.org            f = map(lambda s: s[com_pfx_len:], files)
4653716Sstever@eecs.umich.edu            return ', '.join(f)
4665522Snate@binkert.org        return self.format % (com_pfx, fmt(srcs), fmt(tgts))
4675522Snate@binkert.org
4685522Snate@binkert.orgExport('Transform')
4695522Snate@binkert.org
4705522Snate@binkert.org
4715522Snate@binkert.orgif GetOption('verbose'):
4721858SN/A    def MakeAction(action, string, *args, **kwargs):
4735227Ssaidi@eecs.umich.edu        return Action(action, *args, **kwargs)
4745227Ssaidi@eecs.umich.eduelse:
4755227Ssaidi@eecs.umich.edu    MakeAction = Action
4765227Ssaidi@eecs.umich.edu    main['CCCOMSTR']        = Transform("CC")
4776654Snate@binkert.org    main['CXXCOMSTR']       = Transform("CXX")
4786654Snate@binkert.org    main['ASCOMSTR']        = Transform("AS")
4796121Snate@binkert.org    main['SWIGCOMSTR']      = Transform("SWIG")
4806121Snate@binkert.org    main['ARCOMSTR']        = Transform("AR", 0)
4816121Snate@binkert.org    main['LINKCOMSTR']      = Transform("LINK", 0)
4826121Snate@binkert.org    main['RANLIBCOMSTR']    = Transform("RANLIB", 0)
4835227Ssaidi@eecs.umich.edu    main['M4COMSTR']        = Transform("M4")
4845227Ssaidi@eecs.umich.edu    main['SHCCCOMSTR']      = Transform("SHCC")
4855227Ssaidi@eecs.umich.edu    main['SHCXXCOMSTR']     = Transform("SHCXX")
4865204Sstever@gmail.comExport('MakeAction')
4875204Sstever@gmail.com
4885204Sstever@gmail.comCXX_version = readCommand([main['CXX'],'--version'], exception=False)
4895204Sstever@gmail.comCXX_V = readCommand([main['CXX'],'-V'], exception=False)
4905204Sstever@gmail.com
4915204Sstever@gmail.commain['GCC'] = CXX_version and CXX_version.find('g++') >= 0
4925204Sstever@gmail.commain['SUNCC'] = CXX_V and CXX_V.find('Sun C++') >= 0
4935204Sstever@gmail.commain['ICC'] = CXX_V and CXX_V.find('Intel') >= 0
4945204Sstever@gmail.comif main['GCC'] + main['SUNCC'] + main['ICC'] > 1:
4955204Sstever@gmail.com    print 'Error: How can we have two at the same time?'
4965204Sstever@gmail.com    Exit(1)
4975204Sstever@gmail.com
4985204Sstever@gmail.com# Set up default C++ compiler flags
4995204Sstever@gmail.comif main['GCC']:
5005204Sstever@gmail.com    main.Append(CCFLAGS=['-pipe'])
5015204Sstever@gmail.com    main.Append(CCFLAGS=['-fno-strict-aliasing'])
5025204Sstever@gmail.com    main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef'])
5036121Snate@binkert.org    main.Append(CXXFLAGS=['-Wno-deprecated'])
5045204Sstever@gmail.com    # Read the GCC version to check for versions with bugs
5053118Sstever@eecs.umich.edu    # Note CCVERSION doesn't work here because it is run with the CC
5063118Sstever@eecs.umich.edu    # before we override it from the command line
5073118Sstever@eecs.umich.edu    gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False)
5083118Sstever@eecs.umich.edu    if not compareVersions(gcc_version, '4.4.1') or \
5093118Sstever@eecs.umich.edu       not compareVersions(gcc_version, '4.4.2'):
5105863Snate@binkert.org        print 'Info: Tree vectorizer in GCC 4.4.1 & 4.4.2 is buggy, disabling.'
5113118Sstever@eecs.umich.edu        main.Append(CCFLAGS=['-fno-tree-vectorize'])
5125863Snate@binkert.orgelif main['ICC']:
5133118Sstever@eecs.umich.edu    pass #Fix me... add warning flags once we clean up icc warnings
5145863Snate@binkert.orgelif main['SUNCC']:
5155863Snate@binkert.org    main.Append(CCFLAGS=['-Qoption ccfe'])
5165863Snate@binkert.org    main.Append(CCFLAGS=['-features=gcc'])
5175863Snate@binkert.org    main.Append(CCFLAGS=['-features=extensions'])
5185863Snate@binkert.org    main.Append(CCFLAGS=['-library=stlport4'])
5195863Snate@binkert.org    main.Append(CCFLAGS=['-xar'])
5205863Snate@binkert.org    #main.Append(CCFLAGS=['-instances=semiexplicit'])
5215863Snate@binkert.orgelse:
5226003Snate@binkert.org    print 'Error: Don\'t know what compiler options to use for your compiler.'
5235863Snate@binkert.org    print '       Please fix SConstruct and src/SConscript and try again.'
5245863Snate@binkert.org    Exit(1)
5255863Snate@binkert.org
5266120Snate@binkert.org# Set up common yacc/bison flags (needed for Ruby)
5275863Snate@binkert.orgmain['YACCFLAGS'] = '-d'
5285863Snate@binkert.orgmain['YACCHXXFILESUFFIX'] = '.hh'
5295863Snate@binkert.org
5306120Snate@binkert.org# Do this after we save setting back, or else we'll tack on an
5316120Snate@binkert.org# extra 'qdo' every time we run scons.
5325863Snate@binkert.orgif main['BATCH']:
5335863Snate@binkert.org    main['CC']     = main['BATCH_CMD'] + ' ' + main['CC']
5346120Snate@binkert.org    main['CXX']    = main['BATCH_CMD'] + ' ' + main['CXX']
5355863Snate@binkert.org    main['AS']     = main['BATCH_CMD'] + ' ' + main['AS']
5366121Snate@binkert.org    main['AR']     = main['BATCH_CMD'] + ' ' + main['AR']
5376121Snate@binkert.org    main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB']
5385863Snate@binkert.org
5395863Snate@binkert.orgif sys.platform == 'cygwin':
5403118Sstever@eecs.umich.edu    # cygwin has some header file issues...
5415863Snate@binkert.org    main.Append(CCFLAGS=["-Wno-uninitialized"])
5423118Sstever@eecs.umich.edu
5433118Sstever@eecs.umich.edu# Check for SWIG
5445863Snate@binkert.orgif not main.has_key('SWIG'):
5455863Snate@binkert.org    print 'Error: SWIG utility not found.'
5465863Snate@binkert.org    print '       Please install (see http://www.swig.org) and retry.'
5475863Snate@binkert.org    Exit(1)
5483118Sstever@eecs.umich.edu
5493483Ssaidi@eecs.umich.edu# Check for appropriate SWIG version
5503494Ssaidi@eecs.umich.eduswig_version = readCommand(('swig', '-version'), exception='').split()
5513494Ssaidi@eecs.umich.edu# First 3 words should be "SWIG Version x.y.z"
5523483Ssaidi@eecs.umich.eduif len(swig_version) < 3 or \
5533483Ssaidi@eecs.umich.edu        swig_version[0] != 'SWIG' or swig_version[1] != 'Version':
5543483Ssaidi@eecs.umich.edu    print 'Error determining SWIG version.'
5553053Sstever@eecs.umich.edu    Exit(1)
5563053Sstever@eecs.umich.edu
5573918Ssaidi@eecs.umich.edumin_swig_version = '1.3.28'
5583053Sstever@eecs.umich.eduif compareVersions(swig_version[2], min_swig_version) < 0:
5593053Sstever@eecs.umich.edu    print 'Error: SWIG version', min_swig_version, 'or newer required.'
5603053Sstever@eecs.umich.edu    print '       Installed version:', swig_version[2]
5613053Sstever@eecs.umich.edu    Exit(1)
5623053Sstever@eecs.umich.edu
5631858SN/A# Set up SWIG flags & scanner
5641858SN/Aswig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
5651858SN/Amain.Append(SWIGFLAGS=swig_flags)
5661858SN/A
5671858SN/A# filter out all existing swig scanners, they mess up the dependency
5681858SN/A# stuff for some reason
5695863Snate@binkert.orgscanners = []
5705863Snate@binkert.orgfor scanner in main['SCANNERS']:
5711859SN/A    skeys = scanner.skeys
5725863Snate@binkert.org    if skeys == '.i':
5731858SN/A        continue
5745863Snate@binkert.org
5751858SN/A    if isinstance(skeys, (list, tuple)) and '.i' in skeys:
5761859SN/A        continue
5771859SN/A
5786654Snate@binkert.org    scanners.append(scanner)
5793053Sstever@eecs.umich.edu
5806654Snate@binkert.org# add the new swig scanner that we like better
5813053Sstever@eecs.umich.edufrom SCons.Scanner import ClassicCPP as CPPScanner
5823053Sstever@eecs.umich.eduswig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
5831859SN/Ascanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re))
5841859SN/A
5851859SN/A# replace the scanners list that has what we want
5861859SN/Amain['SCANNERS'] = scanners
5871859SN/A
5881859SN/A# Add a custom Check function to the Configure context so that we can
5891859SN/A# figure out if the compiler adds leading underscores to global
5901859SN/A# variables.  This is needed for the autogenerated asm files that we
5911862SN/A# use for embedding the python code.
5921859SN/Adef CheckLeading(context):
5931859SN/A    context.Message("Checking for leading underscore in global variables...")
5941859SN/A    # 1) Define a global variable called x from asm so the C compiler
5955863Snate@binkert.org    #    won't change the symbol at all.
5965863Snate@binkert.org    # 2) Declare that variable.
5975863Snate@binkert.org    # 3) Use the variable
5985863Snate@binkert.org    #
5996121Snate@binkert.org    # If the compiler prepends an underscore, this will successfully
6001858SN/A    # link because the external symbol 'x' will be called '_x' which
6015863Snate@binkert.org    # was defined by the asm statement.  If the compiler does not
6025863Snate@binkert.org    # prepend an underscore, this will not successfully link because
6035863Snate@binkert.org    # '_x' will have been defined by assembly, while the C portion of
6045863Snate@binkert.org    # the code will be trying to use 'x'
6055863Snate@binkert.org    ret = context.TryLink('''
6062139SN/A        asm(".globl _x; _x: .byte 0");
6074202Sbinkertn@umich.edu        extern int x;
6084202Sbinkertn@umich.edu        int main() { return x; }
6092139SN/A        ''', extension=".c")
6102155SN/A    context.env.Append(LEADING_UNDERSCORE=ret)
6114202Sbinkertn@umich.edu    context.Result(ret)
6124202Sbinkertn@umich.edu    return ret
6134202Sbinkertn@umich.edu
6142155SN/A# Platform-specific configuration.  Note again that we assume that all
6155863Snate@binkert.org# builds under a given build root run on the same host platform.
6161869SN/Aconf = Configure(main,
6171869SN/A                 conf_dir = joinpath(build_root, '.scons_config'),
6185863Snate@binkert.org                 log_file = joinpath(build_root, 'scons_config.log'),
6195863Snate@binkert.org                 custom_tests = { 'CheckLeading' : CheckLeading })
6204202Sbinkertn@umich.edu
6216108Snate@binkert.org# Check for leading underscores.  Don't really need to worry either
6226108Snate@binkert.org# way so don't need to check the return code.
6236108Snate@binkert.orgconf.CheckLeading()
6246108Snate@binkert.org
6255863Snate@binkert.org# Check if we should compile a 64 bit binary on Mac OS X/Darwin
6265863Snate@binkert.orgtry:
6275863Snate@binkert.org    import platform
6284202Sbinkertn@umich.edu    uname = platform.uname()
6294202Sbinkertn@umich.edu    if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0:
6305863Snate@binkert.org        if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
6315742Snate@binkert.org            main.Append(CCFLAGS=['-arch', 'x86_64'])
6325742Snate@binkert.org            main.Append(CFLAGS=['-arch', 'x86_64'])
6335341Sstever@gmail.com            main.Append(LINKFLAGS=['-arch', 'x86_64'])
6345342Sstever@gmail.com            main.Append(ASFLAGS=['-arch', 'x86_64'])
6355342Sstever@gmail.comexcept:
6364202Sbinkertn@umich.edu    pass
6374202Sbinkertn@umich.edu
6384202Sbinkertn@umich.edu# Recent versions of scons substitute a "Null" object for Configure()
6394202Sbinkertn@umich.edu# when configuration isn't necessary, e.g., if the "--help" option is
6404202Sbinkertn@umich.edu# present.  Unfortuantely this Null object always returns false,
6415863Snate@binkert.org# breaking all our configuration checks.  We replace it with our own
6425863Snate@binkert.org# more optimistic null object that returns True instead.
6435863Snate@binkert.orgif not conf:
6445863Snate@binkert.org    def NullCheck(*args, **kwargs):
6455863Snate@binkert.org        return True
6465863Snate@binkert.org
6475863Snate@binkert.org    class NullConf:
6485863Snate@binkert.org        def __init__(self, env):
6495863Snate@binkert.org            self.env = env
6505863Snate@binkert.org        def Finish(self):
6515863Snate@binkert.org            return self.env
6525863Snate@binkert.org        def __getattr__(self, mname):
6535863Snate@binkert.org            return NullCheck
6545863Snate@binkert.org
6555863Snate@binkert.org    conf = NullConf(main)
6565863Snate@binkert.org
6575863Snate@binkert.org# Find Python include and library directories for embedding the
6585863Snate@binkert.org# interpreter.  For consistency, we will use the same Python
6595863Snate@binkert.org# installation used to run scons (and thus this script).  If you want
6605863Snate@binkert.org# to link in an alternate version, see above for instructions on how
6615952Ssaidi@eecs.umich.edu# to invoke scons with a different copy of the Python interpreter.
6621869SN/Afrom distutils import sysconfig
6631858SN/A
6645863Snate@binkert.orgpy_getvar = sysconfig.get_config_var
6655863Snate@binkert.org
6661869SN/Apy_debug = getattr(sys, 'pydebug', False)
6671858SN/Apy_version = 'python' + py_getvar('VERSION') + (py_debug and "_d" or "")
6685863Snate@binkert.org
6696108Snate@binkert.orgpy_general_include = sysconfig.get_python_inc()
6706108Snate@binkert.orgpy_platform_include = sysconfig.get_python_inc(plat_specific=True)
6716108Snate@binkert.orgpy_includes = [ py_general_include ]
6721858SN/Aif py_platform_include != py_general_include:
673955SN/A    py_includes.append(py_platform_include)
674955SN/A
6751869SN/Apy_lib_path = [ py_getvar('LIBDIR') ]
6761869SN/A# add the prefix/lib/pythonX.Y/config dir, but only if there is no
6771869SN/A# shared library in prefix/lib/.
6781869SN/Aif not py_getvar('Py_ENABLE_SHARED'):
6791869SN/A    py_lib_path.append(py_getvar('LIBPL'))
6805863Snate@binkert.org
6815863Snate@binkert.orgpy_libs = []
6825863Snate@binkert.orgfor lib in py_getvar('LIBS').split() + py_getvar('SYSLIBS').split():
6831869SN/A    assert lib.startswith('-l')
6845863Snate@binkert.org    lib = lib[2:]   
6851869SN/A    if lib not in py_libs:
6865863Snate@binkert.org        py_libs.append(lib)
6871869SN/Apy_libs.append(py_version)
6881869SN/A
6891869SN/Amain.Append(CPPPATH=py_includes)
6901869SN/Amain.Append(LIBPATH=py_lib_path)
6911869SN/A
6925863Snate@binkert.org# Cache build files in the supplied directory.
6935863Snate@binkert.orgif main['M5_BUILD_CACHE']:
6941869SN/A    print 'Using build cache located at', main['M5_BUILD_CACHE']
6951869SN/A    CacheDir(main['M5_BUILD_CACHE'])
6961869SN/A
6971869SN/A
6981869SN/A# verify that this stuff works
6991869SN/Aif not conf.CheckHeader('Python.h', '<>'):
7001869SN/A    print "Error: can't find Python.h header in", py_includes
7015863Snate@binkert.org    Exit(1)
7025863Snate@binkert.org
7031869SN/Afor lib in py_libs:
7045863Snate@binkert.org    if not conf.CheckLib(lib):
7055863Snate@binkert.org        print "Error: can't find library %s required by python" % lib
7063356Sbinkertn@umich.edu        Exit(1)
7073356Sbinkertn@umich.edu
7083356Sbinkertn@umich.edu# On Solaris you need to use libsocket for socket ops
7093356Sbinkertn@umich.eduif not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
7103356Sbinkertn@umich.edu   if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
7114781Snate@binkert.org       print "Can't find library with socket calls (e.g. accept())"
7125863Snate@binkert.org       Exit(1)
7135863Snate@binkert.org
7141869SN/A# Check for zlib.  If the check passes, libz will be automatically
7151869SN/A# added to the LIBS environment variable.
7161869SN/Aif not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
7176121Snate@binkert.org    print 'Error: did not find needed zlib compression library '\
7181869SN/A          'and/or zlib.h header file.'
7192638Sstever@eecs.umich.edu    print '       Please install zlib and try again.'
7206121Snate@binkert.org    Exit(1)
7216121Snate@binkert.org
7222638Sstever@eecs.umich.edu# Check for librt.
7235749Scws3k@cs.virginia.eduhave_posix_clock = \
7246121Snate@binkert.org    conf.CheckLibWithHeader(None, 'time.h', 'C',
7256121Snate@binkert.org                            'clock_nanosleep(0,0,NULL,NULL);') or \
7265749Scws3k@cs.virginia.edu    conf.CheckLibWithHeader('rt', 'time.h', 'C',
7271869SN/A                            'clock_nanosleep(0,0,NULL,NULL);')
7281869SN/A
7293546Sgblack@eecs.umich.eduif not have_posix_clock:
7303546Sgblack@eecs.umich.edu    print "Can't find library for POSIX clocks."
7313546Sgblack@eecs.umich.edu
7323546Sgblack@eecs.umich.edu# Check for <fenv.h> (C99 FP environment control)
7336121Snate@binkert.orghave_fenv = conf.CheckHeader('fenv.h', '<>')
7345863Snate@binkert.orgif not have_fenv:
7353546Sgblack@eecs.umich.edu    print "Warning: Header file <fenv.h> not found."
7363546Sgblack@eecs.umich.edu    print "         This host has no IEEE FP rounding mode control."
7373546Sgblack@eecs.umich.edu
7383546Sgblack@eecs.umich.edu######################################################################
7394781Snate@binkert.org#
7405863Snate@binkert.org# Check for mysql.
7414781Snate@binkert.org#
7424781Snate@binkert.orgmysql_config = WhereIs('mysql_config')
7434781Snate@binkert.orghave_mysql = bool(mysql_config)
7444781Snate@binkert.org
7454781Snate@binkert.org# Check MySQL version.
7465863Snate@binkert.orgif have_mysql:
7474781Snate@binkert.org    mysql_version = readCommand(mysql_config + ' --version')
7484781Snate@binkert.org    min_mysql_version = '4.1'
7494781Snate@binkert.org    if compareVersions(mysql_version, min_mysql_version) < 0:
7504781Snate@binkert.org        print 'Warning: MySQL', min_mysql_version, 'or newer required.'
7513546Sgblack@eecs.umich.edu        print '         Version', mysql_version, 'detected.'
7523546Sgblack@eecs.umich.edu        have_mysql = False
7533546Sgblack@eecs.umich.edu
7544781Snate@binkert.org# Set up mysql_config commands.
7553546Sgblack@eecs.umich.eduif have_mysql:
7563546Sgblack@eecs.umich.edu    mysql_config_include = mysql_config + ' --include'
7573546Sgblack@eecs.umich.edu    if os.system(mysql_config_include + ' > /dev/null') != 0:
7583546Sgblack@eecs.umich.edu        # older mysql_config versions don't support --include, use
7593546Sgblack@eecs.umich.edu        # --cflags instead
7603546Sgblack@eecs.umich.edu        mysql_config_include = mysql_config + ' --cflags | sed s/\\\'//g'
7613546Sgblack@eecs.umich.edu    # This seems to work in all versions
7623546Sgblack@eecs.umich.edu    mysql_config_libs = mysql_config + ' --libs'
7633546Sgblack@eecs.umich.edu
7643546Sgblack@eecs.umich.edu######################################################################
7654202Sbinkertn@umich.edu#
7663546Sgblack@eecs.umich.edu# Finish the configuration
7673546Sgblack@eecs.umich.edu#
7683546Sgblack@eecs.umich.edumain = conf.Finish()
769955SN/A
770955SN/A######################################################################
771955SN/A#
772955SN/A# Collect all non-global variables
7735863Snate@binkert.org#
7745863Snate@binkert.org
7755343Sstever@gmail.com# Define the universe of supported ISAs
7765343Sstever@gmail.comall_isa_list = [ ]
7776121Snate@binkert.orgExport('all_isa_list')
7785863Snate@binkert.org
7794773Snate@binkert.orgclass CpuModel(object):
7805863Snate@binkert.org    '''The CpuModel class encapsulates everything the ISA parser needs to
7812632Sstever@eecs.umich.edu    know about a particular CPU model.'''
7825863Snate@binkert.org
7832023SN/A    # Dict of available CPU model objects.  Accessible as CpuModel.dict.
7845863Snate@binkert.org    dict = {}
7855863Snate@binkert.org    list = []
7865863Snate@binkert.org    defaults = []
7875863Snate@binkert.org
7885863Snate@binkert.org    # Constructor.  Automatically adds models to CpuModel.dict.
7895863Snate@binkert.org    def __init__(self, name, filename, includes, strings, default=False):
7905863Snate@binkert.org        self.name = name           # name of model
7915863Snate@binkert.org        self.filename = filename   # filename for output exec code
7925863Snate@binkert.org        self.includes = includes   # include files needed in exec file
7932632Sstever@eecs.umich.edu        # The 'strings' dict holds all the per-CPU symbols we can
7945863Snate@binkert.org        # substitute into templates etc.
7952023SN/A        self.strings = strings
7962632Sstever@eecs.umich.edu
7975863Snate@binkert.org        # This cpu is enabled by default
7985342Sstever@gmail.com        self.default = default
7995863Snate@binkert.org
8002632Sstever@eecs.umich.edu        # Add self to dict
8015863Snate@binkert.org        if name in CpuModel.dict:
8025863Snate@binkert.org            raise AttributeError, "CpuModel '%s' already registered" % name
8032632Sstever@eecs.umich.edu        CpuModel.dict[name] = self
8045863Snate@binkert.org        CpuModel.list.append(name)
8055863Snate@binkert.org
8065863Snate@binkert.orgExport('CpuModel')
8075863Snate@binkert.org
8085863Snate@binkert.org# Sticky variables get saved in the variables file so they persist from
8095863Snate@binkert.org# one invocation to the next (unless overridden, in which case the new
8102632Sstever@eecs.umich.edu# value becomes sticky).
8115863Snate@binkert.orgsticky_vars = Variables(args=ARGUMENTS)
8125863Snate@binkert.orgExport('sticky_vars')
8132632Sstever@eecs.umich.edu
8141888SN/A# Sticky variables that should be exported
8155863Snate@binkert.orgexport_vars = []
8165863Snate@binkert.orgExport('export_vars')
8175863Snate@binkert.org
8181858SN/A# Walk the tree and execute all SConsopts scripts that wil add to the
8195863Snate@binkert.org# above variables
8205863Snate@binkert.orgfor bdir in [ base_dir ] + extras_dir_list:
8215863Snate@binkert.org    for root, dirs, files in os.walk(bdir):
8225863Snate@binkert.org        if 'SConsopts' in files:
8232598SN/A            print "Reading", joinpath(root, 'SConsopts')
8245863Snate@binkert.org            SConscript(joinpath(root, 'SConsopts'))
8251858SN/A
8261858SN/Aall_isa_list.sort()
8271858SN/A
8285863Snate@binkert.orgsticky_vars.AddVariables(
8291858SN/A    EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list),
8301858SN/A    BoolVariable('FULL_SYSTEM', 'Full-system support', False),
8311858SN/A    ListVariable('CPU_MODELS', 'CPU models',
8325863Snate@binkert.org                 sorted(n for n,m in CpuModel.dict.iteritems() if m.default),
8331871SN/A                 sorted(CpuModel.list)),
8341858SN/A    BoolVariable('NO_FAST_ALLOC', 'Disable fast object allocator', False),
8351858SN/A    BoolVariable('FAST_ALLOC_DEBUG', 'Enable fast object allocator debugging',
8361858SN/A                 False),
8371858SN/A    BoolVariable('FAST_ALLOC_STATS', 'Enable fast object allocator statistics',
8381858SN/A                 False),
8391858SN/A    BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
8401858SN/A                 False),
8415863Snate@binkert.org    BoolVariable('SS_COMPATIBLE_FP',
8421858SN/A                 'Make floating-point results compatible with SimpleScalar',
8431858SN/A                 False),
8445863Snate@binkert.org    BoolVariable('USE_SSE2',
8451859SN/A                 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
8461859SN/A                 False),
8471869SN/A    BoolVariable('USE_MYSQL', 'Use MySQL for stats output', have_mysql),
8485863Snate@binkert.org    BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock),
8495863Snate@binkert.org    BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
8501869SN/A    BoolVariable('USE_CHECKER', 'Use checker for detailed CPU models', False),
8511965SN/A    BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False),
8521965SN/A    BoolVariable('RUBY', 'Build with Ruby', False),
8531965SN/A    )
8542761Sstever@eecs.umich.edu
8555863Snate@binkert.org# These variables get exported to #defines in config/*.hh (see src/SConscript).
8561869SN/Aexport_vars += ['FULL_SYSTEM', 'USE_FENV', 'USE_MYSQL',
8575863Snate@binkert.org                'NO_FAST_ALLOC', 'FAST_ALLOC_DEBUG', 'FAST_ALLOC_STATS',
8582667Sstever@eecs.umich.edu                'SS_COMPATIBLE_FP', 'USE_CHECKER', 'TARGET_ISA', 'CP_ANNOTATE',
8591869SN/A                'USE_POSIX_CLOCK' ]
8601869SN/A
8612929Sktlim@umich.edu###################################################
8622929Sktlim@umich.edu#
8635863Snate@binkert.org# Define a SCons builder for configuration flag headers.
8642929Sktlim@umich.edu#
865955SN/A###################################################
8662598SN/A
867# This function generates a config header file that #defines the
868# variable symbol to the current variable setting (0 or 1).  The source
869# operands are the name of the variable and a Value node containing the
870# value of the variable.
871def build_config_file(target, source, env):
872    (variable, value) = [s.get_contents() for s in source]
873    f = file(str(target[0]), 'w')
874    print >> f, '#define', variable, value
875    f.close()
876    return None
877
878# Generate the message to be printed when building the config file.
879def build_config_file_string(target, source, env):
880    (variable, value) = [s.get_contents() for s in source]
881    return "Defining %s as %s in %s." % (variable, value, target[0])
882
883# Combine the two functions into a scons Action object.
884config_action = Action(build_config_file, build_config_file_string)
885
886# The emitter munges the source & target node lists to reflect what
887# we're really doing.
888def config_emitter(target, source, env):
889    # extract variable name from Builder arg
890    variable = str(target[0])
891    # True target is config header file
892    target = joinpath('config', variable.lower() + '.hh')
893    val = env[variable]
894    if isinstance(val, bool):
895        # Force value to 0/1
896        val = int(val)
897    elif isinstance(val, str):
898        val = '"' + val + '"'
899
900    # Sources are variable name & value (packaged in SCons Value nodes)
901    return ([target], [Value(variable), Value(val)])
902
903config_builder = Builder(emitter = config_emitter, action = config_action)
904
905main.Append(BUILDERS = { 'ConfigFile' : config_builder })
906
907# libelf build is shared across all configs in the build root.
908main.SConscript('ext/libelf/SConscript',
909                variant_dir = joinpath(build_root, 'libelf'))
910
911# gzstream build is shared across all configs in the build root.
912main.SConscript('ext/gzstream/SConscript',
913                variant_dir = joinpath(build_root, 'gzstream'))
914
915###################################################
916#
917# This function is used to set up a directory with switching headers
918#
919###################################################
920
921main['ALL_ISA_LIST'] = all_isa_list
922def make_switching_dir(dname, switch_headers, env):
923    # Generate the header.  target[0] is the full path of the output
924    # header to generate.  'source' is a dummy variable, since we get the
925    # list of ISAs from env['ALL_ISA_LIST'].
926    def gen_switch_hdr(target, source, env):
927        fname = str(target[0])
928        f = open(fname, 'w')
929        isa = env['TARGET_ISA'].lower()
930        print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname))
931        f.close()
932
933    # Build SCons Action object. 'varlist' specifies env vars that this
934    # action depends on; when env['ALL_ISA_LIST'] changes these actions
935    # should get re-executed.
936    switch_hdr_action = MakeAction(gen_switch_hdr,
937                          Transform("GENERATE"), varlist=['ALL_ISA_LIST'])
938
939    # Instantiate actions for each header
940    for hdr in switch_headers:
941        env.Command(hdr, [], switch_hdr_action)
942Export('make_switching_dir')
943
944###################################################
945#
946# Define build environments for selected configurations.
947#
948###################################################
949
950for variant_path in variant_paths:
951    print "Building in", variant_path
952
953    # Make a copy of the build-root environment to use for this config.
954    env = main.Clone()
955    env['BUILDDIR'] = variant_path
956
957    # variant_dir is the tail component of build path, and is used to
958    # determine the build parameters (e.g., 'ALPHA_SE')
959    (build_root, variant_dir) = splitpath(variant_path)
960
961    # Set env variables according to the build directory config.
962    sticky_vars.files = []
963    # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
964    # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
965    # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
966    current_vars_file = joinpath(build_root, 'variables', variant_dir)
967    if isfile(current_vars_file):
968        sticky_vars.files.append(current_vars_file)
969        print "Using saved variables file %s" % current_vars_file
970    else:
971        # Build dir-specific variables file doesn't exist.
972
973        # Make sure the directory is there so we can create it later
974        opt_dir = dirname(current_vars_file)
975        if not isdir(opt_dir):
976            mkdir(opt_dir)
977
978        # Get default build variables from source tree.  Variables are
979        # normally determined by name of $VARIANT_DIR, but can be
980        # overriden by 'default=' arg on command line.
981        default = GetOption('default')
982        if not default:
983            default = variant_dir
984        default_vars_file = joinpath('build_opts', default)
985        if isfile(default_vars_file):
986            sticky_vars.files.append(default_vars_file)
987            print "Variables file %s not found,\n  using defaults in %s" \
988                  % (current_vars_file, default_vars_file)
989        else:
990            print "Error: cannot find variables file %s or %s" \
991                  % (current_vars_file, default_vars_file)
992            Exit(1)
993
994    # Apply current variable settings to env
995    sticky_vars.Update(env)
996
997    help_texts["local_vars"] += \
998        "Build variables for %s:\n" % variant_dir \
999                 + sticky_vars.GenerateHelpText(env)
1000
1001    # Process variable settings.
1002
1003    if not have_fenv and env['USE_FENV']:
1004        print "Warning: <fenv.h> not available; " \
1005              "forcing USE_FENV to False in", variant_dir + "."
1006        env['USE_FENV'] = False
1007
1008    if not env['USE_FENV']:
1009        print "Warning: No IEEE FP rounding mode control in", variant_dir + "."
1010        print "         FP results may deviate slightly from other platforms."
1011
1012    if env['EFENCE']:
1013        env.Append(LIBS=['efence'])
1014
1015    if env['USE_MYSQL']:
1016        if not have_mysql:
1017            print "Warning: MySQL not available; " \
1018                  "forcing USE_MYSQL to False in", variant_dir + "."
1019            env['USE_MYSQL'] = False
1020        else:
1021            print "Compiling in", variant_dir, "with MySQL support."
1022            env.ParseConfig(mysql_config_libs)
1023            env.ParseConfig(mysql_config_include)
1024
1025    # Save sticky variable settings back to current variables file
1026    sticky_vars.Save(current_vars_file, env)
1027
1028    if env['USE_SSE2']:
1029        env.Append(CCFLAGS=['-msse2'])
1030
1031    # The src/SConscript file sets up the build rules in 'env' according
1032    # to the configured variables.  It returns a list of environments,
1033    # one for each variant build (debug, opt, etc.)
1034    envList = SConscript('src/SConscript', variant_dir = variant_path,
1035                         exports = 'env')
1036
1037    # Set up the regression tests for each build.
1038    for e in envList:
1039        SConscript('tests/SConscript',
1040                   variant_dir = joinpath(variant_path, 'tests', e.Label),
1041                   exports = { 'env' : e }, duplicate = False)
1042
1043# base help text
1044Help('''
1045Usage: scons [scons options] [build variables] [target(s)]
1046
1047Extra scons options:
1048%(options)s
1049
1050Global build variables:
1051%(global_vars)s
1052
1053%(local_vars)s
1054''' % help_texts)
1055