SConstruct revision 8482
1955SN/A# -*- mode:python -*-
2955SN/A
37816Ssteve.reinhardt@amd.com# Copyright (c) 2011 Advanced Micro Devices, Inc.
45871Snate@binkert.org# Copyright (c) 2009 The Hewlett-Packard Development Company
51762SN/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
29955SN/A# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
302665Ssaidi@eecs.umich.edu#
312665Ssaidi@eecs.umich.edu# Authors: Steve Reinhardt
325863Snate@binkert.org#          Nathan Binkert
33955SN/A
34955SN/A###################################################
35955SN/A#
36955SN/A# SCons top-level build description (SConstruct) file.
37955SN/A#
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
412632Sstever@eecs.umich.edu# the optimized full-system version).
42955SN/A#
432632Sstever@eecs.umich.edu# You can build M5 in a different directory as long as there is a
442632Sstever@eecs.umich.edu# 'build/<CONFIG>' somewhere along the target path.  The build system
452761Sstever@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#
482632Sstever@eecs.umich.edu# Examples:
492761Sstever@eecs.umich.edu#
502761Sstever@eecs.umich.edu#   The following two commands are equivalent.  The '-u' option tells
512761Sstever@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
532632Sstever@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
582761Sstever@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
652632Sstever@eecs.umich.edu# options as well.
66955SN/A#
67955SN/A###################################################
68955SN/A
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
995863Snate@binkert.org
1006654Snate@binkert.org# Global Python includes
101955SN/Aimport os
1025396Ssaidi@eecs.umich.eduimport re
1035863Snate@binkert.orgimport subprocess
1045863Snate@binkert.orgimport sys
1054202Sbinkertn@umich.edu
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
1095863Snate@binkert.orgfrom os.path import join as joinpath, split as splitpath
110955SN/A
1116654Snate@binkert.org# SCons includes
1125273Sstever@gmail.comimport SCons
1135871Snate@binkert.orgimport SCons.Node
1145273Sstever@gmail.com
1156655Snate@binkert.orgextra_python_paths = [
1166655Snate@binkert.org    Dir('src/python').srcnode().abspath, # M5 includes
1176655Snate@binkert.org    Dir('ext/ply').srcnode().abspath, # ply is used by several files
1186655Snate@binkert.org    ]
1196655Snate@binkert.org    
1206655Snate@binkert.orgsys.path[1:1] = extra_python_paths
1215871Snate@binkert.org
1226654Snate@binkert.orgfrom m5.util import compareVersions, readCommand
1235396Ssaidi@eecs.umich.edu
1248120Sgblack@eecs.umich.eduhelp_texts = {
1258120Sgblack@eecs.umich.edu    "options" : "",
1268120Sgblack@eecs.umich.edu    "global_vars" : "",
1278120Sgblack@eecs.umich.edu    "local_vars" : ""
1288120Sgblack@eecs.umich.edu}
1298120Sgblack@eecs.umich.edu
1308120Sgblack@eecs.umich.eduExport("help_texts")
1318120Sgblack@eecs.umich.edu
1328120Sgblack@eecs.umich.edudef AddM5Option(*args, **kwargs):
1338120Sgblack@eecs.umich.edu    col_width = 30
1348120Sgblack@eecs.umich.edu
1358120Sgblack@eecs.umich.edu    help = "  " + ", ".join(args)
1368120Sgblack@eecs.umich.edu    if "help" in kwargs:
1378120Sgblack@eecs.umich.edu        length = len(help)
1388120Sgblack@eecs.umich.edu        if length >= col_width:
1398120Sgblack@eecs.umich.edu            help += "\n" + " " * col_width
1408120Sgblack@eecs.umich.edu        else:
1418120Sgblack@eecs.umich.edu            help += " " * (col_width - length)
1428120Sgblack@eecs.umich.edu        help += kwargs["help"]
1438120Sgblack@eecs.umich.edu    help_texts["options"] += help + "\n"
1448120Sgblack@eecs.umich.edu
1458120Sgblack@eecs.umich.edu    AddOption(*args, **kwargs)
1468120Sgblack@eecs.umich.edu
1478120Sgblack@eecs.umich.eduAddM5Option('--colors', dest='use_colors', action='store_true',
1488120Sgblack@eecs.umich.edu            help="Add color to abbreviated scons output")
1498120Sgblack@eecs.umich.eduAddM5Option('--no-colors', dest='use_colors', action='store_false',
1508120Sgblack@eecs.umich.edu            help="Don't add color to abbreviated scons output")
1518120Sgblack@eecs.umich.eduAddM5Option('--default', dest='default', type='string', action='store',
1528120Sgblack@eecs.umich.edu            help='Override which build_opts file to use for defaults')
1538120Sgblack@eecs.umich.eduAddM5Option('--ignore-style', dest='ignore_style', action='store_true',
1548120Sgblack@eecs.umich.edu            help='Disable style checking hooks')
1558120Sgblack@eecs.umich.eduAddM5Option('--update-ref', dest='update_ref', action='store_true',
1568120Sgblack@eecs.umich.edu            help='Update test reference outputs')
1578120Sgblack@eecs.umich.eduAddM5Option('--verbose', dest='verbose', action='store_true',
1588120Sgblack@eecs.umich.edu            help='Print full tool command lines')
1598120Sgblack@eecs.umich.edu
1607816Ssteve.reinhardt@amd.comuse_colors = GetOption('use_colors')
1617816Ssteve.reinhardt@amd.comif use_colors:
1627816Ssteve.reinhardt@amd.com    from m5.util.terminal import termcap
1637816Ssteve.reinhardt@amd.comelif use_colors is None:
1647816Ssteve.reinhardt@amd.com    # option unspecified; default behavior is to use colors iff isatty
1657816Ssteve.reinhardt@amd.com    from m5.util.terminal import tty_termcap as termcap
1667816Ssteve.reinhardt@amd.comelse:
1677816Ssteve.reinhardt@amd.com    from m5.util.terminal import no_termcap as termcap
1687816Ssteve.reinhardt@amd.com
1695871Snate@binkert.org########################################################################
1705871Snate@binkert.org#
1716121Snate@binkert.org# Set up the main build environment.
1725871Snate@binkert.org#
1735871Snate@binkert.org########################################################################
1746003Snate@binkert.orguse_vars = set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH', 'PATH',
1756655Snate@binkert.org                 'PYTHONPATH', 'RANLIB' ])
176955SN/A
1775871Snate@binkert.orguse_env = {}
1785871Snate@binkert.orgfor key,val in os.environ.iteritems():
1795871Snate@binkert.org    if key in use_vars or key.startswith("M5"):
1805871Snate@binkert.org        use_env[key] = val
181955SN/A
1826121Snate@binkert.orgmain = Environment(ENV=use_env)
1836121Snate@binkert.orgmain.root = Dir(".")         # The current directory (where this file lives).
1846121Snate@binkert.orgmain.srcdir = Dir("src")     # The source directory
1851533SN/A
1866655Snate@binkert.org# add useful python code PYTHONPATH so it can be used by subprocesses
1876655Snate@binkert.org# as well
1886655Snate@binkert.orgmain.AppendENVPath('PYTHONPATH', extra_python_paths)
1896655Snate@binkert.org
1905871Snate@binkert.org########################################################################
1915871Snate@binkert.org#
1925863Snate@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########################################################################
1985863Snate@binkert.org
1996121Snate@binkert.orghgdir = main.root.Dir(".hg")
2005863Snate@binkert.org
2015871Snate@binkert.orgmercurial_style_message = """
2028336Ssteve.reinhardt@amd.comYou're missing the gem5 style hook, which automatically checks your code
2038336Ssteve.reinhardt@amd.comagainst the gem5 style rules on hg commit and qrefresh commands.  This
2048336Ssteve.reinhardt@amd.comscript will now install the hook in your .hg/hgrc file.
2058336Ssteve.reinhardt@amd.comPress enter to continue, or ctrl-c to abort: """
2064678Snate@binkert.org
2078336Ssteve.reinhardt@amd.commercurial_style_hook = """
2088336Ssteve.reinhardt@amd.com# The following lines were automatically added by gem5/SConstruct
2098336Ssteve.reinhardt@amd.com# to provide the gem5 style-checking hooks
2104678Snate@binkert.org[extensions]
2114678Snate@binkert.orgstyle = %s/util/style.py
2124678Snate@binkert.org
2134678Snate@binkert.org[hooks]
2147827Snate@binkert.orgpretxncommit.style = python:style.check_style
2157827Snate@binkert.orgpre-qrefresh.style = python:style.check_style
2168336Ssteve.reinhardt@amd.com# End of SConstruct additions
2174678Snate@binkert.org
2188336Ssteve.reinhardt@amd.com""" % (main.root.abspath)
2198336Ssteve.reinhardt@amd.com
2208336Ssteve.reinhardt@amd.commercurial_lib_not_found = """
2218336Ssteve.reinhardt@amd.comMercurial libraries cannot be found, ignoring style hook.  If
2228336Ssteve.reinhardt@amd.comyou are a gem5 developer, please fix this and run the style
2238336Ssteve.reinhardt@amd.comhook. It is important.
2245871Snate@binkert.org"""
2255871Snate@binkert.org
2268336Ssteve.reinhardt@amd.com# Check for style hook and prompt for installation if it's not there.
2278336Ssteve.reinhardt@amd.com# Skip this if --ignore-style was specified, there's no .hg dir to
2288336Ssteve.reinhardt@amd.com# install a hook in, or there's no interactive terminal to prompt.
2298336Ssteve.reinhardt@amd.comif not GetOption('ignore_style') and hgdir.exists() and sys.stdin.isatty():
2308336Ssteve.reinhardt@amd.com    style_hook = True
2315871Snate@binkert.org    try:
2328336Ssteve.reinhardt@amd.com        from mercurial import ui
2338336Ssteve.reinhardt@amd.com        ui = ui.ui()
2348336Ssteve.reinhardt@amd.com        ui.readconfig(hgdir.File('hgrc').abspath)
2358336Ssteve.reinhardt@amd.com        style_hook = ui.config('hooks', 'pretxncommit.style', None) and \
2368336Ssteve.reinhardt@amd.com                     ui.config('hooks', 'pre-qrefresh.style', None)
2374678Snate@binkert.org    except ImportError:
2385871Snate@binkert.org        print mercurial_lib_not_found
2394678Snate@binkert.org
2408336Ssteve.reinhardt@amd.com    if not style_hook:
2418336Ssteve.reinhardt@amd.com        print mercurial_style_message,
2428336Ssteve.reinhardt@amd.com        # continue unless user does ctrl-c/ctrl-d etc.
2438336Ssteve.reinhardt@amd.com        try:
2448336Ssteve.reinhardt@amd.com            raw_input()
2458336Ssteve.reinhardt@amd.com        except:
2468336Ssteve.reinhardt@amd.com            print "Input exception, exiting scons.\n"
2478336Ssteve.reinhardt@amd.com            sys.exit(1)
2488336Ssteve.reinhardt@amd.com        hgrc_path = '%s/.hg/hgrc' % main.root.abspath
2498336Ssteve.reinhardt@amd.com        print "Adding style hook to", hgrc_path, "\n"
2508336Ssteve.reinhardt@amd.com        try:
2518336Ssteve.reinhardt@amd.com            hgrc = open(hgrc_path, 'a')
2528336Ssteve.reinhardt@amd.com            hgrc.write(mercurial_style_hook)
2538336Ssteve.reinhardt@amd.com            hgrc.close()
2548336Ssteve.reinhardt@amd.com        except:
2558336Ssteve.reinhardt@amd.com            print "Error updating", hgrc_path
2568336Ssteve.reinhardt@amd.com            sys.exit(1)
2575871Snate@binkert.org
2586121Snate@binkert.org
259955SN/A###################################################
260955SN/A#
2612632Sstever@eecs.umich.edu# Figure out which configurations to set up based on the path(s) of
2622632Sstever@eecs.umich.edu# the target(s).
263955SN/A#
264955SN/A###################################################
265955SN/A
266955SN/A# Find default configuration & binary.
2675863Snate@binkert.orgDefault(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA_SE/m5.debug'))
268955SN/A
2692632Sstever@eecs.umich.edu# helper function: find last occurrence of element in list
2702632Sstever@eecs.umich.edudef rfind(l, elt, offs = -1):
2712632Sstever@eecs.umich.edu    for i in range(len(l)+offs, 0, -1):
2722632Sstever@eecs.umich.edu        if l[i] == elt:
2732632Sstever@eecs.umich.edu            return i
2742632Sstever@eecs.umich.edu    raise ValueError, "element not found"
2752632Sstever@eecs.umich.edu
2768268Ssteve.reinhardt@amd.com# Take a list of paths (or SCons Nodes) and return a list with all
2778268Ssteve.reinhardt@amd.com# paths made absolute and ~-expanded.  Paths will be interpreted
2788268Ssteve.reinhardt@amd.com# relative to the launch directory unless a different root is provided
2798268Ssteve.reinhardt@amd.comdef makePathListAbsolute(path_list, root=GetLaunchDir()):
2808268Ssteve.reinhardt@amd.com    return [abspath(joinpath(root, expanduser(str(p))))
2818268Ssteve.reinhardt@amd.com            for p in path_list]
2828268Ssteve.reinhardt@amd.com
2832632Sstever@eecs.umich.edu# Each target must have 'build' in the interior of the path; the
2842632Sstever@eecs.umich.edu# directory below this will determine the build parameters.  For
2852632Sstever@eecs.umich.edu# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
2862632Sstever@eecs.umich.edu# recognize that ALPHA_SE specifies the configuration because it
2878268Ssteve.reinhardt@amd.com# follow 'build' in the build path.
2882632Sstever@eecs.umich.edu
2898268Ssteve.reinhardt@amd.com# The funky assignment to "[:]" is needed to replace the list contents
2908268Ssteve.reinhardt@amd.com# in place rather than reassign the symbol to a new list, which
2918268Ssteve.reinhardt@amd.com# doesn't work (obviously!).
2928268Ssteve.reinhardt@amd.comBUILD_TARGETS[:] = makePathListAbsolute(BUILD_TARGETS)
2933718Sstever@eecs.umich.edu
2942634Sstever@eecs.umich.edu# Generate a list of the unique build roots and configs that the
2952634Sstever@eecs.umich.edu# collected targets reference.
2965863Snate@binkert.orgvariant_paths = []
2972638Sstever@eecs.umich.edubuild_root = None
2988268Ssteve.reinhardt@amd.comfor t in BUILD_TARGETS:
2992632Sstever@eecs.umich.edu    path_dirs = t.split('/')
3002632Sstever@eecs.umich.edu    try:
3012632Sstever@eecs.umich.edu        build_top = rfind(path_dirs, 'build', -2)
3022632Sstever@eecs.umich.edu    except:
3032632Sstever@eecs.umich.edu        print "Error: no non-leaf 'build' dir found on target path", t
3041858SN/A        Exit(1)
3053716Sstever@eecs.umich.edu    this_build_root = joinpath('/',*path_dirs[:build_top+1])
3062638Sstever@eecs.umich.edu    if not build_root:
3072638Sstever@eecs.umich.edu        build_root = this_build_root
3082638Sstever@eecs.umich.edu    else:
3092638Sstever@eecs.umich.edu        if this_build_root != build_root:
3102638Sstever@eecs.umich.edu            print "Error: build targets not under same build root\n"\
3112638Sstever@eecs.umich.edu                  "  %s\n  %s" % (build_root, this_build_root)
3122638Sstever@eecs.umich.edu            Exit(1)
3135863Snate@binkert.org    variant_path = joinpath('/',*path_dirs[:build_top+2])
3145863Snate@binkert.org    if variant_path not in variant_paths:
3155863Snate@binkert.org        variant_paths.append(variant_path)
316955SN/A
3175341Sstever@gmail.com# Make sure build_root exists (might not if this is the first build there)
3185341Sstever@gmail.comif not isdir(build_root):
3195863Snate@binkert.org    mkdir(build_root)
3207756SAli.Saidi@ARM.commain['BUILDROOT'] = build_root
3215341Sstever@gmail.com
3226121Snate@binkert.orgExport('main')
3234494Ssaidi@eecs.umich.edu
3246121Snate@binkert.orgmain.SConsignFile(joinpath(build_root, "sconsign"))
3251105SN/A
3262667Sstever@eecs.umich.edu# Default duplicate option is to use hard links, but this messes up
3272667Sstever@eecs.umich.edu# when you use emacs to edit a file in the target dir, as emacs moves
3282667Sstever@eecs.umich.edu# file to file~ then copies to file, breaking the link.  Symbolic
3292667Sstever@eecs.umich.edu# (soft) links work better.
3306121Snate@binkert.orgmain.SetOption('duplicate', 'soft-copy')
3312667Sstever@eecs.umich.edu
3325341Sstever@gmail.com#
3335863Snate@binkert.org# Set up global sticky variables... these are common to an entire build
3345341Sstever@gmail.com# tree (not specific to a particular build like ALPHA_SE)
3355341Sstever@gmail.com#
3365341Sstever@gmail.com
3378120Sgblack@eecs.umich.eduglobal_vars_file = joinpath(build_root, 'variables.global')
3385341Sstever@gmail.com
3398120Sgblack@eecs.umich.eduglobal_vars = Variables(global_vars_file, args=ARGUMENTS)
3405341Sstever@gmail.com
3418120Sgblack@eecs.umich.eduglobal_vars.AddVariables(
3426121Snate@binkert.org    ('CC', 'C compiler', environ.get('CC', main['CC'])),
3436121Snate@binkert.org    ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])),
3445397Ssaidi@eecs.umich.edu    ('BATCH', 'Use batch pool for build and tests', False),
3455397Ssaidi@eecs.umich.edu    ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
3467727SAli.Saidi@ARM.com    ('M5_BUILD_CACHE', 'Cache built objects in this directory', False),
3478268Ssteve.reinhardt@amd.com    ('EXTRAS', 'Add extra directories to the compilation', '')
3486168Snate@binkert.org    )
3495341Sstever@gmail.com
3508120Sgblack@eecs.umich.edu# Update main environment with values from ARGUMENTS & global_vars_file
3518120Sgblack@eecs.umich.eduglobal_vars.Update(main)
3528120Sgblack@eecs.umich.eduhelp_texts["global_vars"] += global_vars.GenerateHelpText(main)
3536814Sgblack@eecs.umich.edu
3545863Snate@binkert.org# Save sticky variable settings back to current variables file
3558120Sgblack@eecs.umich.eduglobal_vars.Save(global_vars_file, main)
3565341Sstever@gmail.com
3575863Snate@binkert.org# Parse EXTRAS variable to build list of all directories where we're
3588268Ssteve.reinhardt@amd.com# look for sources etc.  This list is exported as extras_dir_list.
3596121Snate@binkert.orgbase_dir = main.srcdir.abspath
3606121Snate@binkert.orgif main['EXTRAS']:
3618268Ssteve.reinhardt@amd.com    extras_dir_list = makePathListAbsolute(main['EXTRAS'].split(':'))
3625742Snate@binkert.orgelse:
3635742Snate@binkert.org    extras_dir_list = []
3645341Sstever@gmail.com
3655742Snate@binkert.orgExport('base_dir')
3665742Snate@binkert.orgExport('extras_dir_list')
3675341Sstever@gmail.com
3686017Snate@binkert.org# the ext directory should be on the #includes path
3696121Snate@binkert.orgmain.Append(CPPPATH=[Dir('ext')])
3706017Snate@binkert.org
3717816Ssteve.reinhardt@amd.comdef strip_build_path(path, env):
3727756SAli.Saidi@ARM.com    path = str(path)
3737756SAli.Saidi@ARM.com    variant_base = env['BUILDROOT'] + os.path.sep
3747756SAli.Saidi@ARM.com    if path.startswith(variant_base):
3757756SAli.Saidi@ARM.com        path = path[len(variant_base):]
3767756SAli.Saidi@ARM.com    elif path.startswith('build/'):
3777756SAli.Saidi@ARM.com        path = path[6:]
3787756SAli.Saidi@ARM.com    return path
3797756SAli.Saidi@ARM.com
3807816Ssteve.reinhardt@amd.com# Generate a string of the form:
3817816Ssteve.reinhardt@amd.com#   common/path/prefix/src1, src2 -> tgt1, tgt2
3827816Ssteve.reinhardt@amd.com# to print while building.
3837816Ssteve.reinhardt@amd.comclass Transform(object):
3847816Ssteve.reinhardt@amd.com    # all specific color settings should be here and nowhere else
3857816Ssteve.reinhardt@amd.com    tool_color = termcap.Normal
3867816Ssteve.reinhardt@amd.com    pfx_color = termcap.Yellow
3877816Ssteve.reinhardt@amd.com    srcs_color = termcap.Yellow + termcap.Bold
3887816Ssteve.reinhardt@amd.com    arrow_color = termcap.Blue + termcap.Bold
3897816Ssteve.reinhardt@amd.com    tgts_color = termcap.Yellow + termcap.Bold
3907756SAli.Saidi@ARM.com
3917816Ssteve.reinhardt@amd.com    def __init__(self, tool, max_sources=99):
3927816Ssteve.reinhardt@amd.com        self.format = self.tool_color + (" [%8s] " % tool) \
3937816Ssteve.reinhardt@amd.com                      + self.pfx_color + "%s" \
3947816Ssteve.reinhardt@amd.com                      + self.srcs_color + "%s" \
3957816Ssteve.reinhardt@amd.com                      + self.arrow_color + " -> " \
3967816Ssteve.reinhardt@amd.com                      + self.tgts_color + "%s" \
3977816Ssteve.reinhardt@amd.com                      + termcap.Normal
3987816Ssteve.reinhardt@amd.com        self.max_sources = max_sources
3997816Ssteve.reinhardt@amd.com
4007816Ssteve.reinhardt@amd.com    def __call__(self, target, source, env, for_signature=None):
4017816Ssteve.reinhardt@amd.com        # truncate source list according to max_sources param
4027816Ssteve.reinhardt@amd.com        source = source[0:self.max_sources]
4037816Ssteve.reinhardt@amd.com        def strip(f):
4047816Ssteve.reinhardt@amd.com            return strip_build_path(str(f), env)
4057816Ssteve.reinhardt@amd.com        if len(source) > 0:
4067816Ssteve.reinhardt@amd.com            srcs = map(strip, source)
4077816Ssteve.reinhardt@amd.com        else:
4087816Ssteve.reinhardt@amd.com            srcs = ['']
4097816Ssteve.reinhardt@amd.com        tgts = map(strip, target)
4107816Ssteve.reinhardt@amd.com        # surprisingly, os.path.commonprefix is a dumb char-by-char string
4117816Ssteve.reinhardt@amd.com        # operation that has nothing to do with paths.
4127816Ssteve.reinhardt@amd.com        com_pfx = os.path.commonprefix(srcs + tgts)
4137816Ssteve.reinhardt@amd.com        com_pfx_len = len(com_pfx)
4147816Ssteve.reinhardt@amd.com        if com_pfx:
4157816Ssteve.reinhardt@amd.com            # do some cleanup and sanity checking on common prefix
4167816Ssteve.reinhardt@amd.com            if com_pfx[-1] == ".":
4177816Ssteve.reinhardt@amd.com                # prefix matches all but file extension: ok
4187816Ssteve.reinhardt@amd.com                # back up one to change 'foo.cc -> o' to 'foo.cc -> .o'
4197816Ssteve.reinhardt@amd.com                com_pfx = com_pfx[0:-1]
4207816Ssteve.reinhardt@amd.com            elif com_pfx[-1] == "/":
4217816Ssteve.reinhardt@amd.com                # common prefix is directory path: OK
4227816Ssteve.reinhardt@amd.com                pass
4237816Ssteve.reinhardt@amd.com            else:
4247816Ssteve.reinhardt@amd.com                src0_len = len(srcs[0])
4257816Ssteve.reinhardt@amd.com                tgt0_len = len(tgts[0])
4267816Ssteve.reinhardt@amd.com                if src0_len == com_pfx_len:
4277816Ssteve.reinhardt@amd.com                    # source is a substring of target, OK
4287816Ssteve.reinhardt@amd.com                    pass
4297816Ssteve.reinhardt@amd.com                elif tgt0_len == com_pfx_len:
4307816Ssteve.reinhardt@amd.com                    # target is a substring of source, need to back up to
4317816Ssteve.reinhardt@amd.com                    # avoid empty string on RHS of arrow
4327816Ssteve.reinhardt@amd.com                    sep_idx = com_pfx.rfind(".")
4337816Ssteve.reinhardt@amd.com                    if sep_idx != -1:
4347816Ssteve.reinhardt@amd.com                        com_pfx = com_pfx[0:sep_idx]
4357816Ssteve.reinhardt@amd.com                    else:
4367816Ssteve.reinhardt@amd.com                        com_pfx = ''
4377816Ssteve.reinhardt@amd.com                elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".":
4387816Ssteve.reinhardt@amd.com                    # still splitting at file extension: ok
4397816Ssteve.reinhardt@amd.com                    pass
4407816Ssteve.reinhardt@amd.com                else:
4417816Ssteve.reinhardt@amd.com                    # probably a fluke; ignore it
4427816Ssteve.reinhardt@amd.com                    com_pfx = ''
4437816Ssteve.reinhardt@amd.com        # recalculate length in case com_pfx was modified
4447816Ssteve.reinhardt@amd.com        com_pfx_len = len(com_pfx)
4457816Ssteve.reinhardt@amd.com        def fmt(files):
4467816Ssteve.reinhardt@amd.com            f = map(lambda s: s[com_pfx_len:], files)
4477816Ssteve.reinhardt@amd.com            return ', '.join(f)
4487816Ssteve.reinhardt@amd.com        return self.format % (com_pfx, fmt(srcs), fmt(tgts))
4497816Ssteve.reinhardt@amd.com
4507816Ssteve.reinhardt@amd.comExport('Transform')
4517816Ssteve.reinhardt@amd.com
4527756SAli.Saidi@ARM.com
4538120Sgblack@eecs.umich.eduif GetOption('verbose'):
4547756SAli.Saidi@ARM.com    def MakeAction(action, string, *args, **kwargs):
4557756SAli.Saidi@ARM.com        return Action(action, *args, **kwargs)
4567756SAli.Saidi@ARM.comelse:
4577756SAli.Saidi@ARM.com    MakeAction = Action
4587816Ssteve.reinhardt@amd.com    main['CCCOMSTR']        = Transform("CC")
4597816Ssteve.reinhardt@amd.com    main['CXXCOMSTR']       = Transform("CXX")
4607816Ssteve.reinhardt@amd.com    main['ASCOMSTR']        = Transform("AS")
4617816Ssteve.reinhardt@amd.com    main['SWIGCOMSTR']      = Transform("SWIG")
4627816Ssteve.reinhardt@amd.com    main['ARCOMSTR']        = Transform("AR", 0)
4637816Ssteve.reinhardt@amd.com    main['LINKCOMSTR']      = Transform("LINK", 0)
4647816Ssteve.reinhardt@amd.com    main['RANLIBCOMSTR']    = Transform("RANLIB", 0)
4657816Ssteve.reinhardt@amd.com    main['M4COMSTR']        = Transform("M4")
4667816Ssteve.reinhardt@amd.com    main['SHCCCOMSTR']      = Transform("SHCC")
4677816Ssteve.reinhardt@amd.com    main['SHCXXCOMSTR']     = Transform("SHCXX")
4687756SAli.Saidi@ARM.comExport('MakeAction')
4697756SAli.Saidi@ARM.com
4706654Snate@binkert.orgCXX_version = readCommand([main['CXX'],'--version'], exception=False)
4716654Snate@binkert.orgCXX_V = readCommand([main['CXX'],'-V'], exception=False)
4725871Snate@binkert.org
4736121Snate@binkert.orgmain['GCC'] = CXX_version and CXX_version.find('g++') >= 0
4746121Snate@binkert.orgmain['SUNCC'] = CXX_V and CXX_V.find('Sun C++') >= 0
4756121Snate@binkert.orgmain['ICC'] = CXX_V and CXX_V.find('Intel') >= 0
4766121Snate@binkert.orgif main['GCC'] + main['SUNCC'] + main['ICC'] > 1:
4773940Ssaidi@eecs.umich.edu    print 'Error: How can we have two at the same time?'
4783918Ssaidi@eecs.umich.edu    Exit(1)
4793918Ssaidi@eecs.umich.edu
4801858SN/A# Set up default C++ compiler flags
4816121Snate@binkert.orgif main['GCC']:
4827739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=['-pipe'])
4837739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=['-fno-strict-aliasing'])
4846143Snate@binkert.org    main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef'])
4857739Sgblack@eecs.umich.edu    main.Append(CXXFLAGS=['-Wno-deprecated'])
4867618SAli.Saidi@arm.com    # Read the GCC version to check for versions with bugs
4877618SAli.Saidi@arm.com    # Note CCVERSION doesn't work here because it is run with the CC
4887618SAli.Saidi@arm.com    # before we override it from the command line
4897618SAli.Saidi@arm.com    gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False)
4907618SAli.Saidi@arm.com    if not compareVersions(gcc_version, '4.4.1') or \
4917618SAli.Saidi@arm.com       not compareVersions(gcc_version, '4.4.2'):
4927618SAli.Saidi@arm.com        print 'Info: Tree vectorizer in GCC 4.4.1 & 4.4.2 is buggy, disabling.'
4937739Sgblack@eecs.umich.edu        main.Append(CCFLAGS=['-fno-tree-vectorize'])
4946121Snate@binkert.orgelif main['ICC']:
4953940Ssaidi@eecs.umich.edu    pass #Fix me... add warning flags once we clean up icc warnings
4966121Snate@binkert.orgelif main['SUNCC']:
4977739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=['-Qoption ccfe'])
4987739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=['-features=gcc'])
4997739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=['-features=extensions'])
5007739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=['-library=stlport4'])
5017739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=['-xar'])
5027739Sgblack@eecs.umich.edu    #main.Append(CCFLAGS=['-instances=semiexplicit'])
5033918Ssaidi@eecs.umich.eduelse:
5043918Ssaidi@eecs.umich.edu    print 'Error: Don\'t know what compiler options to use for your compiler.'
5053940Ssaidi@eecs.umich.edu    print '       Please fix SConstruct and src/SConscript and try again.'
5063918Ssaidi@eecs.umich.edu    Exit(1)
5073918Ssaidi@eecs.umich.edu
5086157Snate@binkert.org# Set up common yacc/bison flags (needed for Ruby)
5096157Snate@binkert.orgmain['YACCFLAGS'] = '-d'
5106157Snate@binkert.orgmain['YACCHXXFILESUFFIX'] = '.hh'
5116157Snate@binkert.org
5125397Ssaidi@eecs.umich.edu# Do this after we save setting back, or else we'll tack on an
5135397Ssaidi@eecs.umich.edu# extra 'qdo' every time we run scons.
5146121Snate@binkert.orgif main['BATCH']:
5156121Snate@binkert.org    main['CC']     = main['BATCH_CMD'] + ' ' + main['CC']
5166121Snate@binkert.org    main['CXX']    = main['BATCH_CMD'] + ' ' + main['CXX']
5176121Snate@binkert.org    main['AS']     = main['BATCH_CMD'] + ' ' + main['AS']
5186121Snate@binkert.org    main['AR']     = main['BATCH_CMD'] + ' ' + main['AR']
5196121Snate@binkert.org    main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB']
5205397Ssaidi@eecs.umich.edu
5211851SN/Aif sys.platform == 'cygwin':
5221851SN/A    # cygwin has some header file issues...
5237739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=["-Wno-uninitialized"])
524955SN/A
5253053Sstever@eecs.umich.edu# Check for SWIG
5266121Snate@binkert.orgif not main.has_key('SWIG'):
5273053Sstever@eecs.umich.edu    print 'Error: SWIG utility not found.'
5283053Sstever@eecs.umich.edu    print '       Please install (see http://www.swig.org) and retry.'
5293053Sstever@eecs.umich.edu    Exit(1)
5303053Sstever@eecs.umich.edu
5313053Sstever@eecs.umich.edu# Check for appropriate SWIG version
5326654Snate@binkert.orgswig_version = readCommand(('swig', '-version'), exception='').split()
5333053Sstever@eecs.umich.edu# First 3 words should be "SWIG Version x.y.z"
5344742Sstever@eecs.umich.eduif len(swig_version) < 3 or \
5354742Sstever@eecs.umich.edu        swig_version[0] != 'SWIG' or swig_version[1] != 'Version':
5363053Sstever@eecs.umich.edu    print 'Error determining SWIG version.'
5373053Sstever@eecs.umich.edu    Exit(1)
5383053Sstever@eecs.umich.edu
5393053Sstever@eecs.umich.edumin_swig_version = '1.3.28'
5406654Snate@binkert.orgif compareVersions(swig_version[2], min_swig_version) < 0:
5413053Sstever@eecs.umich.edu    print 'Error: SWIG version', min_swig_version, 'or newer required.'
5423053Sstever@eecs.umich.edu    print '       Installed version:', swig_version[2]
5433053Sstever@eecs.umich.edu    Exit(1)
5443053Sstever@eecs.umich.edu
5452667Sstever@eecs.umich.edu# Set up SWIG flags & scanner
5464554Sbinkertn@umich.eduswig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
5476121Snate@binkert.orgmain.Append(SWIGFLAGS=swig_flags)
5482667Sstever@eecs.umich.edu
5494554Sbinkertn@umich.edu# filter out all existing swig scanners, they mess up the dependency
5504554Sbinkertn@umich.edu# stuff for some reason
5514554Sbinkertn@umich.eduscanners = []
5526121Snate@binkert.orgfor scanner in main['SCANNERS']:
5534554Sbinkertn@umich.edu    skeys = scanner.skeys
5544554Sbinkertn@umich.edu    if skeys == '.i':
5554554Sbinkertn@umich.edu        continue
5564781Snate@binkert.org
5574554Sbinkertn@umich.edu    if isinstance(skeys, (list, tuple)) and '.i' in skeys:
5584554Sbinkertn@umich.edu        continue
5592667Sstever@eecs.umich.edu
5604554Sbinkertn@umich.edu    scanners.append(scanner)
5614554Sbinkertn@umich.edu
5624554Sbinkertn@umich.edu# add the new swig scanner that we like better
5634554Sbinkertn@umich.edufrom SCons.Scanner import ClassicCPP as CPPScanner
5642667Sstever@eecs.umich.eduswig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
5654554Sbinkertn@umich.eduscanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re))
5662667Sstever@eecs.umich.edu
5674554Sbinkertn@umich.edu# replace the scanners list that has what we want
5686121Snate@binkert.orgmain['SCANNERS'] = scanners
5692667Sstever@eecs.umich.edu
5705522Snate@binkert.org# Add a custom Check function to the Configure context so that we can
5715522Snate@binkert.org# figure out if the compiler adds leading underscores to global
5725522Snate@binkert.org# variables.  This is needed for the autogenerated asm files that we
5735522Snate@binkert.org# use for embedding the python code.
5745522Snate@binkert.orgdef CheckLeading(context):
5755522Snate@binkert.org    context.Message("Checking for leading underscore in global variables...")
5765522Snate@binkert.org    # 1) Define a global variable called x from asm so the C compiler
5775522Snate@binkert.org    #    won't change the symbol at all.
5785522Snate@binkert.org    # 2) Declare that variable.
5795522Snate@binkert.org    # 3) Use the variable
5805522Snate@binkert.org    #
5815522Snate@binkert.org    # If the compiler prepends an underscore, this will successfully
5825522Snate@binkert.org    # link because the external symbol 'x' will be called '_x' which
5835522Snate@binkert.org    # was defined by the asm statement.  If the compiler does not
5845522Snate@binkert.org    # prepend an underscore, this will not successfully link because
5855522Snate@binkert.org    # '_x' will have been defined by assembly, while the C portion of
5865522Snate@binkert.org    # the code will be trying to use 'x'
5875522Snate@binkert.org    ret = context.TryLink('''
5885522Snate@binkert.org        asm(".globl _x; _x: .byte 0");
5895522Snate@binkert.org        extern int x;
5905522Snate@binkert.org        int main() { return x; }
5915522Snate@binkert.org        ''', extension=".c")
5925522Snate@binkert.org    context.env.Append(LEADING_UNDERSCORE=ret)
5935522Snate@binkert.org    context.Result(ret)
5945522Snate@binkert.org    return ret
5955522Snate@binkert.org
5962638Sstever@eecs.umich.edu# Platform-specific configuration.  Note again that we assume that all
5972638Sstever@eecs.umich.edu# builds under a given build root run on the same host platform.
5986121Snate@binkert.orgconf = Configure(main,
5993716Sstever@eecs.umich.edu                 conf_dir = joinpath(build_root, '.scons_config'),
6005522Snate@binkert.org                 log_file = joinpath(build_root, 'scons_config.log'),
6015522Snate@binkert.org                 custom_tests = { 'CheckLeading' : CheckLeading })
6025522Snate@binkert.org
6035522Snate@binkert.org# Check for leading underscores.  Don't really need to worry either
6045522Snate@binkert.org# way so don't need to check the return code.
6055522Snate@binkert.orgconf.CheckLeading()
6061858SN/A
6075227Ssaidi@eecs.umich.edu# Check if we should compile a 64 bit binary on Mac OS X/Darwin
6085227Ssaidi@eecs.umich.edutry:
6095227Ssaidi@eecs.umich.edu    import platform
6105227Ssaidi@eecs.umich.edu    uname = platform.uname()
6116654Snate@binkert.org    if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0:
6126654Snate@binkert.org        if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
6137769SAli.Saidi@ARM.com            main.Append(CCFLAGS=['-arch', 'x86_64'])
6147769SAli.Saidi@ARM.com            main.Append(CFLAGS=['-arch', 'x86_64'])
6157769SAli.Saidi@ARM.com            main.Append(LINKFLAGS=['-arch', 'x86_64'])
6167769SAli.Saidi@ARM.com            main.Append(ASFLAGS=['-arch', 'x86_64'])
6175227Ssaidi@eecs.umich.eduexcept:
6185227Ssaidi@eecs.umich.edu    pass
6195227Ssaidi@eecs.umich.edu
6205204Sstever@gmail.com# Recent versions of scons substitute a "Null" object for Configure()
6215204Sstever@gmail.com# when configuration isn't necessary, e.g., if the "--help" option is
6225204Sstever@gmail.com# present.  Unfortuantely this Null object always returns false,
6235204Sstever@gmail.com# breaking all our configuration checks.  We replace it with our own
6245204Sstever@gmail.com# more optimistic null object that returns True instead.
6255204Sstever@gmail.comif not conf:
6265204Sstever@gmail.com    def NullCheck(*args, **kwargs):
6275204Sstever@gmail.com        return True
6285204Sstever@gmail.com
6295204Sstever@gmail.com    class NullConf:
6305204Sstever@gmail.com        def __init__(self, env):
6315204Sstever@gmail.com            self.env = env
6325204Sstever@gmail.com        def Finish(self):
6335204Sstever@gmail.com            return self.env
6345204Sstever@gmail.com        def __getattr__(self, mname):
6355204Sstever@gmail.com            return NullCheck
6365204Sstever@gmail.com
6376121Snate@binkert.org    conf = NullConf(main)
6385204Sstever@gmail.com
6393118Sstever@eecs.umich.edu# Find Python include and library directories for embedding the
6403118Sstever@eecs.umich.edu# interpreter.  For consistency, we will use the same Python
6413118Sstever@eecs.umich.edu# installation used to run scons (and thus this script).  If you want
6423118Sstever@eecs.umich.edu# to link in an alternate version, see above for instructions on how
6433118Sstever@eecs.umich.edu# to invoke scons with a different copy of the Python interpreter.
6445863Snate@binkert.orgfrom distutils import sysconfig
6453118Sstever@eecs.umich.edu
6465863Snate@binkert.orgpy_getvar = sysconfig.get_config_var
6473118Sstever@eecs.umich.edu
6487457Snate@binkert.orgpy_debug = getattr(sys, 'pydebug', False)
6497457Snate@binkert.orgpy_version = 'python' + py_getvar('VERSION') + (py_debug and "_d" or "")
6505863Snate@binkert.org
6515863Snate@binkert.orgpy_general_include = sysconfig.get_python_inc()
6525863Snate@binkert.orgpy_platform_include = sysconfig.get_python_inc(plat_specific=True)
6535863Snate@binkert.orgpy_includes = [ py_general_include ]
6545863Snate@binkert.orgif py_platform_include != py_general_include:
6555863Snate@binkert.org    py_includes.append(py_platform_include)
6565863Snate@binkert.org
6576003Snate@binkert.orgpy_lib_path = [ py_getvar('LIBDIR') ]
6585863Snate@binkert.org# add the prefix/lib/pythonX.Y/config dir, but only if there is no
6595863Snate@binkert.org# shared library in prefix/lib/.
6605863Snate@binkert.orgif not py_getvar('Py_ENABLE_SHARED'):
6616120Snate@binkert.org    py_lib_path.append(py_getvar('LIBPL'))
6625863Snate@binkert.org
6635863Snate@binkert.orgpy_libs = []
6645863Snate@binkert.orgfor lib in py_getvar('LIBS').split() + py_getvar('SYSLIBS').split():
6656120Snate@binkert.org    assert lib.startswith('-l')
6666120Snate@binkert.org    lib = lib[2:]   
6675863Snate@binkert.org    if lib not in py_libs:
6685863Snate@binkert.org        py_libs.append(lib)
6696120Snate@binkert.orgpy_libs.append(py_version)
6705863Snate@binkert.org
6716121Snate@binkert.orgmain.Append(CPPPATH=py_includes)
6726121Snate@binkert.orgmain.Append(LIBPATH=py_lib_path)
6735863Snate@binkert.org
6747727SAli.Saidi@ARM.com# Cache build files in the supplied directory.
6757727SAli.Saidi@ARM.comif main['M5_BUILD_CACHE']:
6767727SAli.Saidi@ARM.com    print 'Using build cache located at', main['M5_BUILD_CACHE']
6777727SAli.Saidi@ARM.com    CacheDir(main['M5_BUILD_CACHE'])
6787727SAli.Saidi@ARM.com
6797727SAli.Saidi@ARM.com
6805863Snate@binkert.org# verify that this stuff works
6813118Sstever@eecs.umich.eduif not conf.CheckHeader('Python.h', '<>'):
6825863Snate@binkert.org    print "Error: can't find Python.h header in", py_includes
6833118Sstever@eecs.umich.edu    Exit(1)
6843118Sstever@eecs.umich.edu
6855863Snate@binkert.orgfor lib in py_libs:
6865863Snate@binkert.org    if not conf.CheckLib(lib):
6875863Snate@binkert.org        print "Error: can't find library %s required by python" % lib
6885863Snate@binkert.org        Exit(1)
6893118Sstever@eecs.umich.edu
6903483Ssaidi@eecs.umich.edu# On Solaris you need to use libsocket for socket ops
6913494Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
6923494Ssaidi@eecs.umich.edu   if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
6933483Ssaidi@eecs.umich.edu       print "Can't find library with socket calls (e.g. accept())"
6943483Ssaidi@eecs.umich.edu       Exit(1)
6953483Ssaidi@eecs.umich.edu
6963053Sstever@eecs.umich.edu# Check for zlib.  If the check passes, libz will be automatically
6973053Sstever@eecs.umich.edu# added to the LIBS environment variable.
6983918Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
6993053Sstever@eecs.umich.edu    print 'Error: did not find needed zlib compression library '\
7003053Sstever@eecs.umich.edu          'and/or zlib.h header file.'
7013053Sstever@eecs.umich.edu    print '       Please install zlib and try again.'
7023053Sstever@eecs.umich.edu    Exit(1)
7033053Sstever@eecs.umich.edu
7047840Snate@binkert.org# Check for librt.
7057865Sgblack@eecs.umich.eduhave_posix_clock = \
7067865Sgblack@eecs.umich.edu    conf.CheckLibWithHeader(None, 'time.h', 'C',
7077865Sgblack@eecs.umich.edu                            'clock_nanosleep(0,0,NULL,NULL);') or \
7087865Sgblack@eecs.umich.edu    conf.CheckLibWithHeader('rt', 'time.h', 'C',
7097865Sgblack@eecs.umich.edu                            'clock_nanosleep(0,0,NULL,NULL);')
7107840Snate@binkert.org
7117840Snate@binkert.orgif not have_posix_clock:
7127840Snate@binkert.org    print "Can't find library for POSIX clocks."
7137840Snate@binkert.org
7141858SN/A# Check for <fenv.h> (C99 FP environment control)
7151858SN/Ahave_fenv = conf.CheckHeader('fenv.h', '<>')
7161858SN/Aif not have_fenv:
7171858SN/A    print "Warning: Header file <fenv.h> not found."
7181858SN/A    print "         This host has no IEEE FP rounding mode control."
7191858SN/A
7205863Snate@binkert.org######################################################################
7215863Snate@binkert.org#
7225863Snate@binkert.org# Finish the configuration
7235863Snate@binkert.org#
7246121Snate@binkert.orgmain = conf.Finish()
7251858SN/A
7265863Snate@binkert.org######################################################################
7275863Snate@binkert.org#
7285863Snate@binkert.org# Collect all non-global variables
7295863Snate@binkert.org#
7305863Snate@binkert.org
7312139SN/A# Define the universe of supported ISAs
7324202Sbinkertn@umich.eduall_isa_list = [ ]
7334202Sbinkertn@umich.eduExport('all_isa_list')
7342139SN/A
7356994Snate@binkert.orgclass CpuModel(object):
7366994Snate@binkert.org    '''The CpuModel class encapsulates everything the ISA parser needs to
7376994Snate@binkert.org    know about a particular CPU model.'''
7386994Snate@binkert.org
7396994Snate@binkert.org    # Dict of available CPU model objects.  Accessible as CpuModel.dict.
7406994Snate@binkert.org    dict = {}
7416994Snate@binkert.org    list = []
7426994Snate@binkert.org    defaults = []
7436994Snate@binkert.org
7446994Snate@binkert.org    # Constructor.  Automatically adds models to CpuModel.dict.
7456994Snate@binkert.org    def __init__(self, name, filename, includes, strings, default=False):
7466994Snate@binkert.org        self.name = name           # name of model
7476994Snate@binkert.org        self.filename = filename   # filename for output exec code
7486994Snate@binkert.org        self.includes = includes   # include files needed in exec file
7496994Snate@binkert.org        # The 'strings' dict holds all the per-CPU symbols we can
7506994Snate@binkert.org        # substitute into templates etc.
7516994Snate@binkert.org        self.strings = strings
7526994Snate@binkert.org
7536994Snate@binkert.org        # This cpu is enabled by default
7546994Snate@binkert.org        self.default = default
7556994Snate@binkert.org
7566994Snate@binkert.org        # Add self to dict
7576994Snate@binkert.org        if name in CpuModel.dict:
7586994Snate@binkert.org            raise AttributeError, "CpuModel '%s' already registered" % name
7596994Snate@binkert.org        CpuModel.dict[name] = self
7606994Snate@binkert.org        CpuModel.list.append(name)
7616994Snate@binkert.org
7626994Snate@binkert.orgExport('CpuModel')
7632155SN/A
7645863Snate@binkert.org# Sticky variables get saved in the variables file so they persist from
7651869SN/A# one invocation to the next (unless overridden, in which case the new
7661869SN/A# value becomes sticky).
7675863Snate@binkert.orgsticky_vars = Variables(args=ARGUMENTS)
7685863Snate@binkert.orgExport('sticky_vars')
7694202Sbinkertn@umich.edu
7706108Snate@binkert.org# Sticky variables that should be exported
7716108Snate@binkert.orgexport_vars = []
7726108Snate@binkert.orgExport('export_vars')
7736108Snate@binkert.org
7744202Sbinkertn@umich.edu# Walk the tree and execute all SConsopts scripts that wil add to the
7755863Snate@binkert.org# above variables
7768474Sgblack@eecs.umich.eduif not GetOption('verbose'):
7778474Sgblack@eecs.umich.edu    print "Reading SConsopts"
7785742Snate@binkert.orgfor bdir in [ base_dir ] + extras_dir_list:
7798268Ssteve.reinhardt@amd.com    if not isdir(bdir):
7808268Ssteve.reinhardt@amd.com        print "Error: directory '%s' does not exist" % bdir
7818268Ssteve.reinhardt@amd.com        Exit(1)
7825742Snate@binkert.org    for root, dirs, files in os.walk(bdir):
7835341Sstever@gmail.com        if 'SConsopts' in files:
7848474Sgblack@eecs.umich.edu            if GetOption('verbose'):
7858474Sgblack@eecs.umich.edu                print "Reading", joinpath(root, 'SConsopts')
7865342Sstever@gmail.com            SConscript(joinpath(root, 'SConsopts'))
7874202Sbinkertn@umich.edu
7884202Sbinkertn@umich.eduall_isa_list.sort()
7894202Sbinkertn@umich.edu
7905863Snate@binkert.orgsticky_vars.AddVariables(
7915863Snate@binkert.org    EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list),
7925863Snate@binkert.org    BoolVariable('FULL_SYSTEM', 'Full-system support', False),
7936994Snate@binkert.org    ListVariable('CPU_MODELS', 'CPU models',
7946994Snate@binkert.org                 sorted(n for n,m in CpuModel.dict.iteritems() if m.default),
7956994Snate@binkert.org                 sorted(CpuModel.list)),
7965863Snate@binkert.org    BoolVariable('NO_FAST_ALLOC', 'Disable fast object allocator', False),
7978152Ssteve.reinhardt@amd.com    BoolVariable('FORCE_FAST_ALLOC',
7988152Ssteve.reinhardt@amd.com                 'Enable fast object allocator, even for m5.debug', False),
7995863Snate@binkert.org    BoolVariable('FAST_ALLOC_STATS', 'Enable fast object allocator statistics',
8005863Snate@binkert.org                 False),
8015863Snate@binkert.org    BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
8025863Snate@binkert.org                 False),
8035863Snate@binkert.org    BoolVariable('SS_COMPATIBLE_FP',
8045863Snate@binkert.org                 'Make floating-point results compatible with SimpleScalar',
8055863Snate@binkert.org                 False),
8065863Snate@binkert.org    BoolVariable('USE_SSE2',
8075863Snate@binkert.org                 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
8085863Snate@binkert.org                 False),
8097840Snate@binkert.org    BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock),
8105863Snate@binkert.org    BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
8115863Snate@binkert.org    BoolVariable('USE_CHECKER', 'Use checker for detailed CPU models', False),
8125952Ssaidi@eecs.umich.edu    BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False),
8131869SN/A    )
8141858SN/A
8155863Snate@binkert.org# These variables get exported to #defines in config/*.hh (see src/SConscript).
8168297Snate@binkert.orgexport_vars += ['FULL_SYSTEM', 'USE_FENV',
8178152Ssteve.reinhardt@amd.com                'NO_FAST_ALLOC', 'FORCE_FAST_ALLOC', 'FAST_ALLOC_STATS',
8187840Snate@binkert.org                'SS_COMPATIBLE_FP', 'USE_CHECKER', 'TARGET_ISA', 'CP_ANNOTATE',
8197840Snate@binkert.org                'USE_POSIX_CLOCK' ]
8201858SN/A
821955SN/A###################################################
822955SN/A#
8231869SN/A# Define a SCons builder for configuration flag headers.
8241869SN/A#
8251869SN/A###################################################
8261869SN/A
8271869SN/A# This function generates a config header file that #defines the
8285863Snate@binkert.org# variable symbol to the current variable setting (0 or 1).  The source
8295863Snate@binkert.org# operands are the name of the variable and a Value node containing the
8305863Snate@binkert.org# value of the variable.
8311869SN/Adef build_config_file(target, source, env):
8325863Snate@binkert.org    (variable, value) = [s.get_contents() for s in source]
8331869SN/A    f = file(str(target[0]), 'w')
8345863Snate@binkert.org    print >> f, '#define', variable, value
8351869SN/A    f.close()
8361869SN/A    return None
8371869SN/A
8381869SN/A# Generate the message to be printed when building the config file.
8391869SN/Adef build_config_file_string(target, source, env):
8405863Snate@binkert.org    (variable, value) = [s.get_contents() for s in source]
8415863Snate@binkert.org    return "Defining %s as %s in %s." % (variable, value, target[0])
8421869SN/A
8431869SN/A# Combine the two functions into a scons Action object.
8441869SN/Aconfig_action = Action(build_config_file, build_config_file_string)
8451869SN/A
8461869SN/A# The emitter munges the source & target node lists to reflect what
8471869SN/A# we're really doing.
8481869SN/Adef config_emitter(target, source, env):
8495863Snate@binkert.org    # extract variable name from Builder arg
8505863Snate@binkert.org    variable = str(target[0])
8511869SN/A    # True target is config header file
8525863Snate@binkert.org    target = joinpath('config', variable.lower() + '.hh')
8535863Snate@binkert.org    val = env[variable]
8543356Sbinkertn@umich.edu    if isinstance(val, bool):
8553356Sbinkertn@umich.edu        # Force value to 0/1
8563356Sbinkertn@umich.edu        val = int(val)
8573356Sbinkertn@umich.edu    elif isinstance(val, str):
8583356Sbinkertn@umich.edu        val = '"' + val + '"'
8594781Snate@binkert.org
8605863Snate@binkert.org    # Sources are variable name & value (packaged in SCons Value nodes)
8615863Snate@binkert.org    return ([target], [Value(variable), Value(val)])
8621869SN/A
8631869SN/Aconfig_builder = Builder(emitter = config_emitter, action = config_action)
8641869SN/A
8656121Snate@binkert.orgmain.Append(BUILDERS = { 'ConfigFile' : config_builder })
8661869SN/A
8672638Sstever@eecs.umich.edu# libelf build is shared across all configs in the build root.
8686121Snate@binkert.orgmain.SConscript('ext/libelf/SConscript',
8696121Snate@binkert.org                variant_dir = joinpath(build_root, 'libelf'))
8702638Sstever@eecs.umich.edu
8715749Scws3k@cs.virginia.edu# gzstream build is shared across all configs in the build root.
8726121Snate@binkert.orgmain.SConscript('ext/gzstream/SConscript',
8736121Snate@binkert.org                variant_dir = joinpath(build_root, 'gzstream'))
8745749Scws3k@cs.virginia.edu
8751869SN/A###################################################
8761869SN/A#
8773546Sgblack@eecs.umich.edu# This function is used to set up a directory with switching headers
8783546Sgblack@eecs.umich.edu#
8793546Sgblack@eecs.umich.edu###################################################
8803546Sgblack@eecs.umich.edu
8816121Snate@binkert.orgmain['ALL_ISA_LIST'] = all_isa_list
8825863Snate@binkert.orgdef make_switching_dir(dname, switch_headers, env):
8833546Sgblack@eecs.umich.edu    # Generate the header.  target[0] is the full path of the output
8843546Sgblack@eecs.umich.edu    # header to generate.  'source' is a dummy variable, since we get the
8853546Sgblack@eecs.umich.edu    # list of ISAs from env['ALL_ISA_LIST'].
8863546Sgblack@eecs.umich.edu    def gen_switch_hdr(target, source, env):
8874781Snate@binkert.org        fname = str(target[0])
8884781Snate@binkert.org        f = open(fname, 'w')
8896658Snate@binkert.org        isa = env['TARGET_ISA'].lower()
8906658Snate@binkert.org        print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname))
8914781Snate@binkert.org        f.close()
8923546Sgblack@eecs.umich.edu
8933546Sgblack@eecs.umich.edu    # Build SCons Action object. 'varlist' specifies env vars that this
8943546Sgblack@eecs.umich.edu    # action depends on; when env['ALL_ISA_LIST'] changes these actions
8953546Sgblack@eecs.umich.edu    # should get re-executed.
8967756SAli.Saidi@ARM.com    switch_hdr_action = MakeAction(gen_switch_hdr,
8977816Ssteve.reinhardt@amd.com                          Transform("GENERATE"), varlist=['ALL_ISA_LIST'])
8983546Sgblack@eecs.umich.edu
8993546Sgblack@eecs.umich.edu    # Instantiate actions for each header
9003546Sgblack@eecs.umich.edu    for hdr in switch_headers:
9013546Sgblack@eecs.umich.edu        env.Command(hdr, [], switch_hdr_action)
9024202Sbinkertn@umich.eduExport('make_switching_dir')
9033546Sgblack@eecs.umich.edu
9043546Sgblack@eecs.umich.edu###################################################
9053546Sgblack@eecs.umich.edu#
906955SN/A# Define build environments for selected configurations.
907955SN/A#
908955SN/A###################################################
909955SN/A
9105863Snate@binkert.orgfor variant_path in variant_paths:
9115863Snate@binkert.org    print "Building in", variant_path
9125343Sstever@gmail.com
9135343Sstever@gmail.com    # Make a copy of the build-root environment to use for this config.
9146121Snate@binkert.org    env = main.Clone()
9155863Snate@binkert.org    env['BUILDDIR'] = variant_path
9164773Snate@binkert.org
9175863Snate@binkert.org    # variant_dir is the tail component of build path, and is used to
9182632Sstever@eecs.umich.edu    # determine the build parameters (e.g., 'ALPHA_SE')
9195863Snate@binkert.org    (build_root, variant_dir) = splitpath(variant_path)
9202023SN/A
9215863Snate@binkert.org    # Set env variables according to the build directory config.
9225863Snate@binkert.org    sticky_vars.files = []
9235863Snate@binkert.org    # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
9245863Snate@binkert.org    # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
9255863Snate@binkert.org    # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
9265863Snate@binkert.org    current_vars_file = joinpath(build_root, 'variables', variant_dir)
9275863Snate@binkert.org    if isfile(current_vars_file):
9285863Snate@binkert.org        sticky_vars.files.append(current_vars_file)
9295863Snate@binkert.org        print "Using saved variables file %s" % current_vars_file
9302632Sstever@eecs.umich.edu    else:
9315863Snate@binkert.org        # Build dir-specific variables file doesn't exist.
9322023SN/A
9332632Sstever@eecs.umich.edu        # Make sure the directory is there so we can create it later
9345863Snate@binkert.org        opt_dir = dirname(current_vars_file)
9355342Sstever@gmail.com        if not isdir(opt_dir):
9365863Snate@binkert.org            mkdir(opt_dir)
9372632Sstever@eecs.umich.edu
9385863Snate@binkert.org        # Get default build variables from source tree.  Variables are
9395863Snate@binkert.org        # normally determined by name of $VARIANT_DIR, but can be
9408267Ssteve.reinhardt@amd.com        # overridden by '--default=' arg on command line.
9418120Sgblack@eecs.umich.edu        default = GetOption('default')
9428267Ssteve.reinhardt@amd.com        opts_dir = joinpath(main.root.abspath, 'build_opts')
9438267Ssteve.reinhardt@amd.com        if default:
9448267Ssteve.reinhardt@amd.com            default_vars_files = [joinpath(build_root, 'variables', default),
9458267Ssteve.reinhardt@amd.com                                  joinpath(opts_dir, default)]
9468267Ssteve.reinhardt@amd.com        else:
9478267Ssteve.reinhardt@amd.com            default_vars_files = [joinpath(opts_dir, variant_dir)]
9488267Ssteve.reinhardt@amd.com        existing_files = filter(isfile, default_vars_files)
9498267Ssteve.reinhardt@amd.com        if existing_files:
9508267Ssteve.reinhardt@amd.com            default_vars_file = existing_files[0]
9515863Snate@binkert.org            sticky_vars.files.append(default_vars_file)
9525863Snate@binkert.org            print "Variables file %s not found,\n  using defaults in %s" \
9535863Snate@binkert.org                  % (current_vars_file, default_vars_file)
9542632Sstever@eecs.umich.edu        else:
9558267Ssteve.reinhardt@amd.com            print "Error: cannot find variables file %s or " \
9568267Ssteve.reinhardt@amd.com                  "default file(s) %s" \
9578267Ssteve.reinhardt@amd.com                  % (current_vars_file, ' or '.join(default_vars_files))
9582632Sstever@eecs.umich.edu            Exit(1)
9591888SN/A
9605863Snate@binkert.org    # Apply current variable settings to env
9615863Snate@binkert.org    sticky_vars.Update(env)
9621858SN/A
9638120Sgblack@eecs.umich.edu    help_texts["local_vars"] += \
9648120Sgblack@eecs.umich.edu        "Build variables for %s:\n" % variant_dir \
9657756SAli.Saidi@ARM.com                 + sticky_vars.GenerateHelpText(env)
9662598SN/A
9675863Snate@binkert.org    # Process variable settings.
9681858SN/A
9691858SN/A    if not have_fenv and env['USE_FENV']:
9701858SN/A        print "Warning: <fenv.h> not available; " \
9715863Snate@binkert.org              "forcing USE_FENV to False in", variant_dir + "."
9721858SN/A        env['USE_FENV'] = False
9731858SN/A
9741858SN/A    if not env['USE_FENV']:
9755863Snate@binkert.org        print "Warning: No IEEE FP rounding mode control in", variant_dir + "."
9761871SN/A        print "         FP results may deviate slightly from other platforms."
9771858SN/A
9781858SN/A    if env['EFENCE']:
9791858SN/A        env.Append(LIBS=['efence'])
9801858SN/A
9815863Snate@binkert.org    # Save sticky variable settings back to current variables file
9825863Snate@binkert.org    sticky_vars.Save(current_vars_file, env)
9831869SN/A
9841965SN/A    if env['USE_SSE2']:
9857739Sgblack@eecs.umich.edu        env.Append(CCFLAGS=['-msse2'])
9861965SN/A
9878482Snilay@cs.wisc.edu    if env['PROTOCOL'] != 'None':
9888482Snilay@cs.wisc.edu        env['RUBY'] = True
9898482Snilay@cs.wisc.edu    else:
9908482Snilay@cs.wisc.edu        env['RUBY'] = False
9918482Snilay@cs.wisc.edu
9922761Sstever@eecs.umich.edu    # The src/SConscript file sets up the build rules in 'env' according
9935863Snate@binkert.org    # to the configured variables.  It returns a list of environments,
9941869SN/A    # one for each variant build (debug, opt, etc.)
9955863Snate@binkert.org    envList = SConscript('src/SConscript', variant_dir = variant_path,
9962667Sstever@eecs.umich.edu                         exports = 'env')
9971869SN/A
9981869SN/A    # Set up the regression tests for each build.
9992929Sktlim@umich.edu    for e in envList:
10002929Sktlim@umich.edu        SConscript('tests/SConscript',
10015863Snate@binkert.org                   variant_dir = joinpath(variant_path, 'tests', e.Label),
10022929Sktlim@umich.edu                   exports = { 'env' : e }, duplicate = False)
1003955SN/A
10048120Sgblack@eecs.umich.edu# base help text
10058120Sgblack@eecs.umich.eduHelp('''
10068120Sgblack@eecs.umich.eduUsage: scons [scons options] [build variables] [target(s)]
10078120Sgblack@eecs.umich.edu
10088120Sgblack@eecs.umich.eduExtra scons options:
10098120Sgblack@eecs.umich.edu%(options)s
10108120Sgblack@eecs.umich.edu
10118120Sgblack@eecs.umich.eduGlobal build variables:
10128120Sgblack@eecs.umich.edu%(global_vars)s
10138120Sgblack@eecs.umich.edu
10148120Sgblack@eecs.umich.edu%(local_vars)s
10158120Sgblack@eecs.umich.edu''' % help_texts)
1016