SConstruct revision 8268
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 = """
2024678Snate@binkert.orgYou're missing the M5 style hook.
2034678Snate@binkert.orgPlease install the hook so we can ensure that all code fits a common style.
2044678Snate@binkert.org
2054678Snate@binkert.orgAll you'd need to do is add the following lines to your repository .hg/hgrc
2064678Snate@binkert.orgor your personal .hgrc
2074678Snate@binkert.org----------------
2084678Snate@binkert.org
2094678Snate@binkert.org[extensions]
2104678Snate@binkert.orgstyle = %s/util/style.py
2114678Snate@binkert.org
2124678Snate@binkert.org[hooks]
2137827Snate@binkert.orgpretxncommit.style = python:style.check_style
2147827Snate@binkert.orgpre-qrefresh.style = python:style.check_style
2156121Snate@binkert.org""" % (main.root)
2164678Snate@binkert.org
2175871Snate@binkert.orgmercurial_bin_not_found = """
2185871Snate@binkert.orgMercurial binary cannot be found, unfortunately this means that we
2195871Snate@binkert.orgcannot easily determine the version of M5 that you are running and
2205871Snate@binkert.orgthis makes error messages more difficult to collect.  Please consider
2215871Snate@binkert.orginstalling mercurial if you choose to post an error message
2225871Snate@binkert.org"""
2235871Snate@binkert.org
2245871Snate@binkert.orgmercurial_lib_not_found = """
2255871Snate@binkert.orgMercurial libraries cannot be found, ignoring style hook
2265871Snate@binkert.orgIf you are actually a M5 developer, please fix this and
2275871Snate@binkert.orgrun the style hook. It is important.
2285871Snate@binkert.org"""
2295871Snate@binkert.org
2305871Snate@binkert.orgif hgdir.exists():
2318126Sgblack@eecs.umich.edu    # Ensure that the style hook is in place.
2325871Snate@binkert.org    try:
2335871Snate@binkert.org        ui = None
2348122Sgblack@eecs.umich.edu        if not GetOption('ignore_style'):
2355871Snate@binkert.org            from mercurial import ui
2365871Snate@binkert.org            ui = ui.ui()
2374678Snate@binkert.org    except ImportError:
2385871Snate@binkert.org        print mercurial_lib_not_found
2394678Snate@binkert.org
2405871Snate@binkert.org    if ui is not None:
2415871Snate@binkert.org        ui.readconfig(hgdir.File('hgrc').abspath)
2425871Snate@binkert.org        style_hook = ui.config('hooks', 'pretxncommit.style', None)
2435871Snate@binkert.org
2445871Snate@binkert.org        if not style_hook:
2455871Snate@binkert.org            print mercurial_style_message
2465871Snate@binkert.org            sys.exit(1)
2475871Snate@binkert.orgelse:
2485871Snate@binkert.org    print ".hg directory not found"
2496121Snate@binkert.org
250955SN/A###################################################
251955SN/A#
2522632Sstever@eecs.umich.edu# Figure out which configurations to set up based on the path(s) of
2532632Sstever@eecs.umich.edu# the target(s).
254955SN/A#
255955SN/A###################################################
256955SN/A
257955SN/A# Find default configuration & binary.
2585863Snate@binkert.orgDefault(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA_SE/m5.debug'))
259955SN/A
2602632Sstever@eecs.umich.edu# helper function: find last occurrence of element in list
2612632Sstever@eecs.umich.edudef rfind(l, elt, offs = -1):
2622632Sstever@eecs.umich.edu    for i in range(len(l)+offs, 0, -1):
2632632Sstever@eecs.umich.edu        if l[i] == elt:
2642632Sstever@eecs.umich.edu            return i
2652632Sstever@eecs.umich.edu    raise ValueError, "element not found"
2662632Sstever@eecs.umich.edu
2678268Ssteve.reinhardt@amd.com# Take a list of paths (or SCons Nodes) and return a list with all
2688268Ssteve.reinhardt@amd.com# paths made absolute and ~-expanded.  Paths will be interpreted
2698268Ssteve.reinhardt@amd.com# relative to the launch directory unless a different root is provided
2708268Ssteve.reinhardt@amd.comdef makePathListAbsolute(path_list, root=GetLaunchDir()):
2718268Ssteve.reinhardt@amd.com    return [abspath(joinpath(root, expanduser(str(p))))
2728268Ssteve.reinhardt@amd.com            for p in path_list]
2738268Ssteve.reinhardt@amd.com
2742632Sstever@eecs.umich.edu# Each target must have 'build' in the interior of the path; the
2752632Sstever@eecs.umich.edu# directory below this will determine the build parameters.  For
2762632Sstever@eecs.umich.edu# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
2772632Sstever@eecs.umich.edu# recognize that ALPHA_SE specifies the configuration because it
2788268Ssteve.reinhardt@amd.com# follow 'build' in the build path.
2792632Sstever@eecs.umich.edu
2808268Ssteve.reinhardt@amd.com# The funky assignment to "[:]" is needed to replace the list contents
2818268Ssteve.reinhardt@amd.com# in place rather than reassign the symbol to a new list, which
2828268Ssteve.reinhardt@amd.com# doesn't work (obviously!).
2838268Ssteve.reinhardt@amd.comBUILD_TARGETS[:] = makePathListAbsolute(BUILD_TARGETS)
2843718Sstever@eecs.umich.edu
2852634Sstever@eecs.umich.edu# Generate a list of the unique build roots and configs that the
2862634Sstever@eecs.umich.edu# collected targets reference.
2875863Snate@binkert.orgvariant_paths = []
2882638Sstever@eecs.umich.edubuild_root = None
2898268Ssteve.reinhardt@amd.comfor t in BUILD_TARGETS:
2902632Sstever@eecs.umich.edu    path_dirs = t.split('/')
2912632Sstever@eecs.umich.edu    try:
2922632Sstever@eecs.umich.edu        build_top = rfind(path_dirs, 'build', -2)
2932632Sstever@eecs.umich.edu    except:
2942632Sstever@eecs.umich.edu        print "Error: no non-leaf 'build' dir found on target path", t
2951858SN/A        Exit(1)
2963716Sstever@eecs.umich.edu    this_build_root = joinpath('/',*path_dirs[:build_top+1])
2972638Sstever@eecs.umich.edu    if not build_root:
2982638Sstever@eecs.umich.edu        build_root = this_build_root
2992638Sstever@eecs.umich.edu    else:
3002638Sstever@eecs.umich.edu        if this_build_root != build_root:
3012638Sstever@eecs.umich.edu            print "Error: build targets not under same build root\n"\
3022638Sstever@eecs.umich.edu                  "  %s\n  %s" % (build_root, this_build_root)
3032638Sstever@eecs.umich.edu            Exit(1)
3045863Snate@binkert.org    variant_path = joinpath('/',*path_dirs[:build_top+2])
3055863Snate@binkert.org    if variant_path not in variant_paths:
3065863Snate@binkert.org        variant_paths.append(variant_path)
307955SN/A
3085341Sstever@gmail.com# Make sure build_root exists (might not if this is the first build there)
3095341Sstever@gmail.comif not isdir(build_root):
3105863Snate@binkert.org    mkdir(build_root)
3117756SAli.Saidi@ARM.commain['BUILDROOT'] = build_root
3125341Sstever@gmail.com
3136121Snate@binkert.orgExport('main')
3144494Ssaidi@eecs.umich.edu
3156121Snate@binkert.orgmain.SConsignFile(joinpath(build_root, "sconsign"))
3161105SN/A
3172667Sstever@eecs.umich.edu# Default duplicate option is to use hard links, but this messes up
3182667Sstever@eecs.umich.edu# when you use emacs to edit a file in the target dir, as emacs moves
3192667Sstever@eecs.umich.edu# file to file~ then copies to file, breaking the link.  Symbolic
3202667Sstever@eecs.umich.edu# (soft) links work better.
3216121Snate@binkert.orgmain.SetOption('duplicate', 'soft-copy')
3222667Sstever@eecs.umich.edu
3235341Sstever@gmail.com#
3245863Snate@binkert.org# Set up global sticky variables... these are common to an entire build
3255341Sstever@gmail.com# tree (not specific to a particular build like ALPHA_SE)
3265341Sstever@gmail.com#
3275341Sstever@gmail.com
3288120Sgblack@eecs.umich.eduglobal_vars_file = joinpath(build_root, 'variables.global')
3295341Sstever@gmail.com
3308120Sgblack@eecs.umich.eduglobal_vars = Variables(global_vars_file, args=ARGUMENTS)
3315341Sstever@gmail.com
3328120Sgblack@eecs.umich.eduglobal_vars.AddVariables(
3336121Snate@binkert.org    ('CC', 'C compiler', environ.get('CC', main['CC'])),
3346121Snate@binkert.org    ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])),
3355397Ssaidi@eecs.umich.edu    ('BATCH', 'Use batch pool for build and tests', False),
3365397Ssaidi@eecs.umich.edu    ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
3377727SAli.Saidi@ARM.com    ('M5_BUILD_CACHE', 'Cache built objects in this directory', False),
3388268Ssteve.reinhardt@amd.com    ('EXTRAS', 'Add extra directories to the compilation', '')
3396168Snate@binkert.org    )
3405341Sstever@gmail.com
3418120Sgblack@eecs.umich.edu# Update main environment with values from ARGUMENTS & global_vars_file
3428120Sgblack@eecs.umich.eduglobal_vars.Update(main)
3438120Sgblack@eecs.umich.eduhelp_texts["global_vars"] += global_vars.GenerateHelpText(main)
3446814Sgblack@eecs.umich.edu
3455863Snate@binkert.org# Save sticky variable settings back to current variables file
3468120Sgblack@eecs.umich.eduglobal_vars.Save(global_vars_file, main)
3475341Sstever@gmail.com
3485863Snate@binkert.org# Parse EXTRAS variable to build list of all directories where we're
3498268Ssteve.reinhardt@amd.com# look for sources etc.  This list is exported as extras_dir_list.
3506121Snate@binkert.orgbase_dir = main.srcdir.abspath
3516121Snate@binkert.orgif main['EXTRAS']:
3528268Ssteve.reinhardt@amd.com    extras_dir_list = makePathListAbsolute(main['EXTRAS'].split(':'))
3535742Snate@binkert.orgelse:
3545742Snate@binkert.org    extras_dir_list = []
3555341Sstever@gmail.com
3565742Snate@binkert.orgExport('base_dir')
3575742Snate@binkert.orgExport('extras_dir_list')
3585341Sstever@gmail.com
3596017Snate@binkert.org# the ext directory should be on the #includes path
3606121Snate@binkert.orgmain.Append(CPPPATH=[Dir('ext')])
3616017Snate@binkert.org
3627816Ssteve.reinhardt@amd.comdef strip_build_path(path, env):
3637756SAli.Saidi@ARM.com    path = str(path)
3647756SAli.Saidi@ARM.com    variant_base = env['BUILDROOT'] + os.path.sep
3657756SAli.Saidi@ARM.com    if path.startswith(variant_base):
3667756SAli.Saidi@ARM.com        path = path[len(variant_base):]
3677756SAli.Saidi@ARM.com    elif path.startswith('build/'):
3687756SAli.Saidi@ARM.com        path = path[6:]
3697756SAli.Saidi@ARM.com    return path
3707756SAli.Saidi@ARM.com
3717816Ssteve.reinhardt@amd.com# Generate a string of the form:
3727816Ssteve.reinhardt@amd.com#   common/path/prefix/src1, src2 -> tgt1, tgt2
3737816Ssteve.reinhardt@amd.com# to print while building.
3747816Ssteve.reinhardt@amd.comclass Transform(object):
3757816Ssteve.reinhardt@amd.com    # all specific color settings should be here and nowhere else
3767816Ssteve.reinhardt@amd.com    tool_color = termcap.Normal
3777816Ssteve.reinhardt@amd.com    pfx_color = termcap.Yellow
3787816Ssteve.reinhardt@amd.com    srcs_color = termcap.Yellow + termcap.Bold
3797816Ssteve.reinhardt@amd.com    arrow_color = termcap.Blue + termcap.Bold
3807816Ssteve.reinhardt@amd.com    tgts_color = termcap.Yellow + termcap.Bold
3817756SAli.Saidi@ARM.com
3827816Ssteve.reinhardt@amd.com    def __init__(self, tool, max_sources=99):
3837816Ssteve.reinhardt@amd.com        self.format = self.tool_color + (" [%8s] " % tool) \
3847816Ssteve.reinhardt@amd.com                      + self.pfx_color + "%s" \
3857816Ssteve.reinhardt@amd.com                      + self.srcs_color + "%s" \
3867816Ssteve.reinhardt@amd.com                      + self.arrow_color + " -> " \
3877816Ssteve.reinhardt@amd.com                      + self.tgts_color + "%s" \
3887816Ssteve.reinhardt@amd.com                      + termcap.Normal
3897816Ssteve.reinhardt@amd.com        self.max_sources = max_sources
3907816Ssteve.reinhardt@amd.com
3917816Ssteve.reinhardt@amd.com    def __call__(self, target, source, env, for_signature=None):
3927816Ssteve.reinhardt@amd.com        # truncate source list according to max_sources param
3937816Ssteve.reinhardt@amd.com        source = source[0:self.max_sources]
3947816Ssteve.reinhardt@amd.com        def strip(f):
3957816Ssteve.reinhardt@amd.com            return strip_build_path(str(f), env)
3967816Ssteve.reinhardt@amd.com        if len(source) > 0:
3977816Ssteve.reinhardt@amd.com            srcs = map(strip, source)
3987816Ssteve.reinhardt@amd.com        else:
3997816Ssteve.reinhardt@amd.com            srcs = ['']
4007816Ssteve.reinhardt@amd.com        tgts = map(strip, target)
4017816Ssteve.reinhardt@amd.com        # surprisingly, os.path.commonprefix is a dumb char-by-char string
4027816Ssteve.reinhardt@amd.com        # operation that has nothing to do with paths.
4037816Ssteve.reinhardt@amd.com        com_pfx = os.path.commonprefix(srcs + tgts)
4047816Ssteve.reinhardt@amd.com        com_pfx_len = len(com_pfx)
4057816Ssteve.reinhardt@amd.com        if com_pfx:
4067816Ssteve.reinhardt@amd.com            # do some cleanup and sanity checking on common prefix
4077816Ssteve.reinhardt@amd.com            if com_pfx[-1] == ".":
4087816Ssteve.reinhardt@amd.com                # prefix matches all but file extension: ok
4097816Ssteve.reinhardt@amd.com                # back up one to change 'foo.cc -> o' to 'foo.cc -> .o'
4107816Ssteve.reinhardt@amd.com                com_pfx = com_pfx[0:-1]
4117816Ssteve.reinhardt@amd.com            elif com_pfx[-1] == "/":
4127816Ssteve.reinhardt@amd.com                # common prefix is directory path: OK
4137816Ssteve.reinhardt@amd.com                pass
4147816Ssteve.reinhardt@amd.com            else:
4157816Ssteve.reinhardt@amd.com                src0_len = len(srcs[0])
4167816Ssteve.reinhardt@amd.com                tgt0_len = len(tgts[0])
4177816Ssteve.reinhardt@amd.com                if src0_len == com_pfx_len:
4187816Ssteve.reinhardt@amd.com                    # source is a substring of target, OK
4197816Ssteve.reinhardt@amd.com                    pass
4207816Ssteve.reinhardt@amd.com                elif tgt0_len == com_pfx_len:
4217816Ssteve.reinhardt@amd.com                    # target is a substring of source, need to back up to
4227816Ssteve.reinhardt@amd.com                    # avoid empty string on RHS of arrow
4237816Ssteve.reinhardt@amd.com                    sep_idx = com_pfx.rfind(".")
4247816Ssteve.reinhardt@amd.com                    if sep_idx != -1:
4257816Ssteve.reinhardt@amd.com                        com_pfx = com_pfx[0:sep_idx]
4267816Ssteve.reinhardt@amd.com                    else:
4277816Ssteve.reinhardt@amd.com                        com_pfx = ''
4287816Ssteve.reinhardt@amd.com                elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".":
4297816Ssteve.reinhardt@amd.com                    # still splitting at file extension: ok
4307816Ssteve.reinhardt@amd.com                    pass
4317816Ssteve.reinhardt@amd.com                else:
4327816Ssteve.reinhardt@amd.com                    # probably a fluke; ignore it
4337816Ssteve.reinhardt@amd.com                    com_pfx = ''
4347816Ssteve.reinhardt@amd.com        # recalculate length in case com_pfx was modified
4357816Ssteve.reinhardt@amd.com        com_pfx_len = len(com_pfx)
4367816Ssteve.reinhardt@amd.com        def fmt(files):
4377816Ssteve.reinhardt@amd.com            f = map(lambda s: s[com_pfx_len:], files)
4387816Ssteve.reinhardt@amd.com            return ', '.join(f)
4397816Ssteve.reinhardt@amd.com        return self.format % (com_pfx, fmt(srcs), fmt(tgts))
4407816Ssteve.reinhardt@amd.com
4417816Ssteve.reinhardt@amd.comExport('Transform')
4427816Ssteve.reinhardt@amd.com
4437756SAli.Saidi@ARM.com
4448120Sgblack@eecs.umich.eduif GetOption('verbose'):
4457756SAli.Saidi@ARM.com    def MakeAction(action, string, *args, **kwargs):
4467756SAli.Saidi@ARM.com        return Action(action, *args, **kwargs)
4477756SAli.Saidi@ARM.comelse:
4487756SAli.Saidi@ARM.com    MakeAction = Action
4497816Ssteve.reinhardt@amd.com    main['CCCOMSTR']        = Transform("CC")
4507816Ssteve.reinhardt@amd.com    main['CXXCOMSTR']       = Transform("CXX")
4517816Ssteve.reinhardt@amd.com    main['ASCOMSTR']        = Transform("AS")
4527816Ssteve.reinhardt@amd.com    main['SWIGCOMSTR']      = Transform("SWIG")
4537816Ssteve.reinhardt@amd.com    main['ARCOMSTR']        = Transform("AR", 0)
4547816Ssteve.reinhardt@amd.com    main['LINKCOMSTR']      = Transform("LINK", 0)
4557816Ssteve.reinhardt@amd.com    main['RANLIBCOMSTR']    = Transform("RANLIB", 0)
4567816Ssteve.reinhardt@amd.com    main['M4COMSTR']        = Transform("M4")
4577816Ssteve.reinhardt@amd.com    main['SHCCCOMSTR']      = Transform("SHCC")
4587816Ssteve.reinhardt@amd.com    main['SHCXXCOMSTR']     = Transform("SHCXX")
4597756SAli.Saidi@ARM.comExport('MakeAction')
4607756SAli.Saidi@ARM.com
4616654Snate@binkert.orgCXX_version = readCommand([main['CXX'],'--version'], exception=False)
4626654Snate@binkert.orgCXX_V = readCommand([main['CXX'],'-V'], exception=False)
4635871Snate@binkert.org
4646121Snate@binkert.orgmain['GCC'] = CXX_version and CXX_version.find('g++') >= 0
4656121Snate@binkert.orgmain['SUNCC'] = CXX_V and CXX_V.find('Sun C++') >= 0
4666121Snate@binkert.orgmain['ICC'] = CXX_V and CXX_V.find('Intel') >= 0
4676121Snate@binkert.orgif main['GCC'] + main['SUNCC'] + main['ICC'] > 1:
4683940Ssaidi@eecs.umich.edu    print 'Error: How can we have two at the same time?'
4693918Ssaidi@eecs.umich.edu    Exit(1)
4703918Ssaidi@eecs.umich.edu
4711858SN/A# Set up default C++ compiler flags
4726121Snate@binkert.orgif main['GCC']:
4737739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=['-pipe'])
4747739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=['-fno-strict-aliasing'])
4756143Snate@binkert.org    main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef'])
4767739Sgblack@eecs.umich.edu    main.Append(CXXFLAGS=['-Wno-deprecated'])
4777618SAli.Saidi@arm.com    # Read the GCC version to check for versions with bugs
4787618SAli.Saidi@arm.com    # Note CCVERSION doesn't work here because it is run with the CC
4797618SAli.Saidi@arm.com    # before we override it from the command line
4807618SAli.Saidi@arm.com    gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False)
4817618SAli.Saidi@arm.com    if not compareVersions(gcc_version, '4.4.1') or \
4827618SAli.Saidi@arm.com       not compareVersions(gcc_version, '4.4.2'):
4837618SAli.Saidi@arm.com        print 'Info: Tree vectorizer in GCC 4.4.1 & 4.4.2 is buggy, disabling.'
4847739Sgblack@eecs.umich.edu        main.Append(CCFLAGS=['-fno-tree-vectorize'])
4856121Snate@binkert.orgelif main['ICC']:
4863940Ssaidi@eecs.umich.edu    pass #Fix me... add warning flags once we clean up icc warnings
4876121Snate@binkert.orgelif main['SUNCC']:
4887739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=['-Qoption ccfe'])
4897739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=['-features=gcc'])
4907739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=['-features=extensions'])
4917739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=['-library=stlport4'])
4927739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=['-xar'])
4937739Sgblack@eecs.umich.edu    #main.Append(CCFLAGS=['-instances=semiexplicit'])
4943918Ssaidi@eecs.umich.eduelse:
4953918Ssaidi@eecs.umich.edu    print 'Error: Don\'t know what compiler options to use for your compiler.'
4963940Ssaidi@eecs.umich.edu    print '       Please fix SConstruct and src/SConscript and try again.'
4973918Ssaidi@eecs.umich.edu    Exit(1)
4983918Ssaidi@eecs.umich.edu
4996157Snate@binkert.org# Set up common yacc/bison flags (needed for Ruby)
5006157Snate@binkert.orgmain['YACCFLAGS'] = '-d'
5016157Snate@binkert.orgmain['YACCHXXFILESUFFIX'] = '.hh'
5026157Snate@binkert.org
5035397Ssaidi@eecs.umich.edu# Do this after we save setting back, or else we'll tack on an
5045397Ssaidi@eecs.umich.edu# extra 'qdo' every time we run scons.
5056121Snate@binkert.orgif main['BATCH']:
5066121Snate@binkert.org    main['CC']     = main['BATCH_CMD'] + ' ' + main['CC']
5076121Snate@binkert.org    main['CXX']    = main['BATCH_CMD'] + ' ' + main['CXX']
5086121Snate@binkert.org    main['AS']     = main['BATCH_CMD'] + ' ' + main['AS']
5096121Snate@binkert.org    main['AR']     = main['BATCH_CMD'] + ' ' + main['AR']
5106121Snate@binkert.org    main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB']
5115397Ssaidi@eecs.umich.edu
5121851SN/Aif sys.platform == 'cygwin':
5131851SN/A    # cygwin has some header file issues...
5147739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=["-Wno-uninitialized"])
515955SN/A
5163053Sstever@eecs.umich.edu# Check for SWIG
5176121Snate@binkert.orgif not main.has_key('SWIG'):
5183053Sstever@eecs.umich.edu    print 'Error: SWIG utility not found.'
5193053Sstever@eecs.umich.edu    print '       Please install (see http://www.swig.org) and retry.'
5203053Sstever@eecs.umich.edu    Exit(1)
5213053Sstever@eecs.umich.edu
5223053Sstever@eecs.umich.edu# Check for appropriate SWIG version
5236654Snate@binkert.orgswig_version = readCommand(('swig', '-version'), exception='').split()
5243053Sstever@eecs.umich.edu# First 3 words should be "SWIG Version x.y.z"
5254742Sstever@eecs.umich.eduif len(swig_version) < 3 or \
5264742Sstever@eecs.umich.edu        swig_version[0] != 'SWIG' or swig_version[1] != 'Version':
5273053Sstever@eecs.umich.edu    print 'Error determining SWIG version.'
5283053Sstever@eecs.umich.edu    Exit(1)
5293053Sstever@eecs.umich.edu
5303053Sstever@eecs.umich.edumin_swig_version = '1.3.28'
5316654Snate@binkert.orgif compareVersions(swig_version[2], min_swig_version) < 0:
5323053Sstever@eecs.umich.edu    print 'Error: SWIG version', min_swig_version, 'or newer required.'
5333053Sstever@eecs.umich.edu    print '       Installed version:', swig_version[2]
5343053Sstever@eecs.umich.edu    Exit(1)
5353053Sstever@eecs.umich.edu
5362667Sstever@eecs.umich.edu# Set up SWIG flags & scanner
5374554Sbinkertn@umich.eduswig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
5386121Snate@binkert.orgmain.Append(SWIGFLAGS=swig_flags)
5392667Sstever@eecs.umich.edu
5404554Sbinkertn@umich.edu# filter out all existing swig scanners, they mess up the dependency
5414554Sbinkertn@umich.edu# stuff for some reason
5424554Sbinkertn@umich.eduscanners = []
5436121Snate@binkert.orgfor scanner in main['SCANNERS']:
5444554Sbinkertn@umich.edu    skeys = scanner.skeys
5454554Sbinkertn@umich.edu    if skeys == '.i':
5464554Sbinkertn@umich.edu        continue
5474781Snate@binkert.org
5484554Sbinkertn@umich.edu    if isinstance(skeys, (list, tuple)) and '.i' in skeys:
5494554Sbinkertn@umich.edu        continue
5502667Sstever@eecs.umich.edu
5514554Sbinkertn@umich.edu    scanners.append(scanner)
5524554Sbinkertn@umich.edu
5534554Sbinkertn@umich.edu# add the new swig scanner that we like better
5544554Sbinkertn@umich.edufrom SCons.Scanner import ClassicCPP as CPPScanner
5552667Sstever@eecs.umich.eduswig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
5564554Sbinkertn@umich.eduscanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re))
5572667Sstever@eecs.umich.edu
5584554Sbinkertn@umich.edu# replace the scanners list that has what we want
5596121Snate@binkert.orgmain['SCANNERS'] = scanners
5602667Sstever@eecs.umich.edu
5615522Snate@binkert.org# Add a custom Check function to the Configure context so that we can
5625522Snate@binkert.org# figure out if the compiler adds leading underscores to global
5635522Snate@binkert.org# variables.  This is needed for the autogenerated asm files that we
5645522Snate@binkert.org# use for embedding the python code.
5655522Snate@binkert.orgdef CheckLeading(context):
5665522Snate@binkert.org    context.Message("Checking for leading underscore in global variables...")
5675522Snate@binkert.org    # 1) Define a global variable called x from asm so the C compiler
5685522Snate@binkert.org    #    won't change the symbol at all.
5695522Snate@binkert.org    # 2) Declare that variable.
5705522Snate@binkert.org    # 3) Use the variable
5715522Snate@binkert.org    #
5725522Snate@binkert.org    # If the compiler prepends an underscore, this will successfully
5735522Snate@binkert.org    # link because the external symbol 'x' will be called '_x' which
5745522Snate@binkert.org    # was defined by the asm statement.  If the compiler does not
5755522Snate@binkert.org    # prepend an underscore, this will not successfully link because
5765522Snate@binkert.org    # '_x' will have been defined by assembly, while the C portion of
5775522Snate@binkert.org    # the code will be trying to use 'x'
5785522Snate@binkert.org    ret = context.TryLink('''
5795522Snate@binkert.org        asm(".globl _x; _x: .byte 0");
5805522Snate@binkert.org        extern int x;
5815522Snate@binkert.org        int main() { return x; }
5825522Snate@binkert.org        ''', extension=".c")
5835522Snate@binkert.org    context.env.Append(LEADING_UNDERSCORE=ret)
5845522Snate@binkert.org    context.Result(ret)
5855522Snate@binkert.org    return ret
5865522Snate@binkert.org
5872638Sstever@eecs.umich.edu# Platform-specific configuration.  Note again that we assume that all
5882638Sstever@eecs.umich.edu# builds under a given build root run on the same host platform.
5896121Snate@binkert.orgconf = Configure(main,
5903716Sstever@eecs.umich.edu                 conf_dir = joinpath(build_root, '.scons_config'),
5915522Snate@binkert.org                 log_file = joinpath(build_root, 'scons_config.log'),
5925522Snate@binkert.org                 custom_tests = { 'CheckLeading' : CheckLeading })
5935522Snate@binkert.org
5945522Snate@binkert.org# Check for leading underscores.  Don't really need to worry either
5955522Snate@binkert.org# way so don't need to check the return code.
5965522Snate@binkert.orgconf.CheckLeading()
5971858SN/A
5985227Ssaidi@eecs.umich.edu# Check if we should compile a 64 bit binary on Mac OS X/Darwin
5995227Ssaidi@eecs.umich.edutry:
6005227Ssaidi@eecs.umich.edu    import platform
6015227Ssaidi@eecs.umich.edu    uname = platform.uname()
6026654Snate@binkert.org    if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0:
6036654Snate@binkert.org        if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
6047769SAli.Saidi@ARM.com            main.Append(CCFLAGS=['-arch', 'x86_64'])
6057769SAli.Saidi@ARM.com            main.Append(CFLAGS=['-arch', 'x86_64'])
6067769SAli.Saidi@ARM.com            main.Append(LINKFLAGS=['-arch', 'x86_64'])
6077769SAli.Saidi@ARM.com            main.Append(ASFLAGS=['-arch', 'x86_64'])
6085227Ssaidi@eecs.umich.eduexcept:
6095227Ssaidi@eecs.umich.edu    pass
6105227Ssaidi@eecs.umich.edu
6115204Sstever@gmail.com# Recent versions of scons substitute a "Null" object for Configure()
6125204Sstever@gmail.com# when configuration isn't necessary, e.g., if the "--help" option is
6135204Sstever@gmail.com# present.  Unfortuantely this Null object always returns false,
6145204Sstever@gmail.com# breaking all our configuration checks.  We replace it with our own
6155204Sstever@gmail.com# more optimistic null object that returns True instead.
6165204Sstever@gmail.comif not conf:
6175204Sstever@gmail.com    def NullCheck(*args, **kwargs):
6185204Sstever@gmail.com        return True
6195204Sstever@gmail.com
6205204Sstever@gmail.com    class NullConf:
6215204Sstever@gmail.com        def __init__(self, env):
6225204Sstever@gmail.com            self.env = env
6235204Sstever@gmail.com        def Finish(self):
6245204Sstever@gmail.com            return self.env
6255204Sstever@gmail.com        def __getattr__(self, mname):
6265204Sstever@gmail.com            return NullCheck
6275204Sstever@gmail.com
6286121Snate@binkert.org    conf = NullConf(main)
6295204Sstever@gmail.com
6303118Sstever@eecs.umich.edu# Find Python include and library directories for embedding the
6313118Sstever@eecs.umich.edu# interpreter.  For consistency, we will use the same Python
6323118Sstever@eecs.umich.edu# installation used to run scons (and thus this script).  If you want
6333118Sstever@eecs.umich.edu# to link in an alternate version, see above for instructions on how
6343118Sstever@eecs.umich.edu# to invoke scons with a different copy of the Python interpreter.
6355863Snate@binkert.orgfrom distutils import sysconfig
6363118Sstever@eecs.umich.edu
6375863Snate@binkert.orgpy_getvar = sysconfig.get_config_var
6383118Sstever@eecs.umich.edu
6397457Snate@binkert.orgpy_debug = getattr(sys, 'pydebug', False)
6407457Snate@binkert.orgpy_version = 'python' + py_getvar('VERSION') + (py_debug and "_d" or "")
6415863Snate@binkert.org
6425863Snate@binkert.orgpy_general_include = sysconfig.get_python_inc()
6435863Snate@binkert.orgpy_platform_include = sysconfig.get_python_inc(plat_specific=True)
6445863Snate@binkert.orgpy_includes = [ py_general_include ]
6455863Snate@binkert.orgif py_platform_include != py_general_include:
6465863Snate@binkert.org    py_includes.append(py_platform_include)
6475863Snate@binkert.org
6486003Snate@binkert.orgpy_lib_path = [ py_getvar('LIBDIR') ]
6495863Snate@binkert.org# add the prefix/lib/pythonX.Y/config dir, but only if there is no
6505863Snate@binkert.org# shared library in prefix/lib/.
6515863Snate@binkert.orgif not py_getvar('Py_ENABLE_SHARED'):
6526120Snate@binkert.org    py_lib_path.append(py_getvar('LIBPL'))
6535863Snate@binkert.org
6545863Snate@binkert.orgpy_libs = []
6555863Snate@binkert.orgfor lib in py_getvar('LIBS').split() + py_getvar('SYSLIBS').split():
6566120Snate@binkert.org    assert lib.startswith('-l')
6576120Snate@binkert.org    lib = lib[2:]   
6585863Snate@binkert.org    if lib not in py_libs:
6595863Snate@binkert.org        py_libs.append(lib)
6606120Snate@binkert.orgpy_libs.append(py_version)
6615863Snate@binkert.org
6626121Snate@binkert.orgmain.Append(CPPPATH=py_includes)
6636121Snate@binkert.orgmain.Append(LIBPATH=py_lib_path)
6645863Snate@binkert.org
6657727SAli.Saidi@ARM.com# Cache build files in the supplied directory.
6667727SAli.Saidi@ARM.comif main['M5_BUILD_CACHE']:
6677727SAli.Saidi@ARM.com    print 'Using build cache located at', main['M5_BUILD_CACHE']
6687727SAli.Saidi@ARM.com    CacheDir(main['M5_BUILD_CACHE'])
6697727SAli.Saidi@ARM.com
6707727SAli.Saidi@ARM.com
6715863Snate@binkert.org# verify that this stuff works
6723118Sstever@eecs.umich.eduif not conf.CheckHeader('Python.h', '<>'):
6735863Snate@binkert.org    print "Error: can't find Python.h header in", py_includes
6743118Sstever@eecs.umich.edu    Exit(1)
6753118Sstever@eecs.umich.edu
6765863Snate@binkert.orgfor lib in py_libs:
6775863Snate@binkert.org    if not conf.CheckLib(lib):
6785863Snate@binkert.org        print "Error: can't find library %s required by python" % lib
6795863Snate@binkert.org        Exit(1)
6803118Sstever@eecs.umich.edu
6813483Ssaidi@eecs.umich.edu# On Solaris you need to use libsocket for socket ops
6823494Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
6833494Ssaidi@eecs.umich.edu   if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
6843483Ssaidi@eecs.umich.edu       print "Can't find library with socket calls (e.g. accept())"
6853483Ssaidi@eecs.umich.edu       Exit(1)
6863483Ssaidi@eecs.umich.edu
6873053Sstever@eecs.umich.edu# Check for zlib.  If the check passes, libz will be automatically
6883053Sstever@eecs.umich.edu# added to the LIBS environment variable.
6893918Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
6903053Sstever@eecs.umich.edu    print 'Error: did not find needed zlib compression library '\
6913053Sstever@eecs.umich.edu          'and/or zlib.h header file.'
6923053Sstever@eecs.umich.edu    print '       Please install zlib and try again.'
6933053Sstever@eecs.umich.edu    Exit(1)
6943053Sstever@eecs.umich.edu
6957840Snate@binkert.org# Check for librt.
6967865Sgblack@eecs.umich.eduhave_posix_clock = \
6977865Sgblack@eecs.umich.edu    conf.CheckLibWithHeader(None, 'time.h', 'C',
6987865Sgblack@eecs.umich.edu                            'clock_nanosleep(0,0,NULL,NULL);') or \
6997865Sgblack@eecs.umich.edu    conf.CheckLibWithHeader('rt', 'time.h', 'C',
7007865Sgblack@eecs.umich.edu                            'clock_nanosleep(0,0,NULL,NULL);')
7017840Snate@binkert.org
7027840Snate@binkert.orgif not have_posix_clock:
7037840Snate@binkert.org    print "Can't find library for POSIX clocks."
7047840Snate@binkert.org
7051858SN/A# Check for <fenv.h> (C99 FP environment control)
7061858SN/Ahave_fenv = conf.CheckHeader('fenv.h', '<>')
7071858SN/Aif not have_fenv:
7081858SN/A    print "Warning: Header file <fenv.h> not found."
7091858SN/A    print "         This host has no IEEE FP rounding mode control."
7101858SN/A
7115863Snate@binkert.org######################################################################
7125863Snate@binkert.org#
7131859SN/A# Check for mysql.
7145863Snate@binkert.org#
7151858SN/Amysql_config = WhereIs('mysql_config')
7165863Snate@binkert.orghave_mysql = bool(mysql_config)
7171858SN/A
7181859SN/A# Check MySQL version.
7191859SN/Aif have_mysql:
7206654Snate@binkert.org    mysql_version = readCommand(mysql_config + ' --version')
7213053Sstever@eecs.umich.edu    min_mysql_version = '4.1'
7226654Snate@binkert.org    if compareVersions(mysql_version, min_mysql_version) < 0:
7233053Sstever@eecs.umich.edu        print 'Warning: MySQL', min_mysql_version, 'or newer required.'
7243053Sstever@eecs.umich.edu        print '         Version', mysql_version, 'detected.'
7251859SN/A        have_mysql = False
7261859SN/A
7271859SN/A# Set up mysql_config commands.
7281859SN/Aif have_mysql:
7291859SN/A    mysql_config_include = mysql_config + ' --include'
7301859SN/A    if os.system(mysql_config_include + ' > /dev/null') != 0:
7311859SN/A        # older mysql_config versions don't support --include, use
7321859SN/A        # --cflags instead
7331862SN/A        mysql_config_include = mysql_config + ' --cflags | sed s/\\\'//g'
7341859SN/A    # This seems to work in all versions
7351859SN/A    mysql_config_libs = mysql_config + ' --libs'
7361859SN/A
7375863Snate@binkert.org######################################################################
7385863Snate@binkert.org#
7395863Snate@binkert.org# Finish the configuration
7405863Snate@binkert.org#
7416121Snate@binkert.orgmain = conf.Finish()
7421858SN/A
7435863Snate@binkert.org######################################################################
7445863Snate@binkert.org#
7455863Snate@binkert.org# Collect all non-global variables
7465863Snate@binkert.org#
7475863Snate@binkert.org
7482139SN/A# Define the universe of supported ISAs
7494202Sbinkertn@umich.eduall_isa_list = [ ]
7504202Sbinkertn@umich.eduExport('all_isa_list')
7512139SN/A
7526994Snate@binkert.orgclass CpuModel(object):
7536994Snate@binkert.org    '''The CpuModel class encapsulates everything the ISA parser needs to
7546994Snate@binkert.org    know about a particular CPU model.'''
7556994Snate@binkert.org
7566994Snate@binkert.org    # Dict of available CPU model objects.  Accessible as CpuModel.dict.
7576994Snate@binkert.org    dict = {}
7586994Snate@binkert.org    list = []
7596994Snate@binkert.org    defaults = []
7606994Snate@binkert.org
7616994Snate@binkert.org    # Constructor.  Automatically adds models to CpuModel.dict.
7626994Snate@binkert.org    def __init__(self, name, filename, includes, strings, default=False):
7636994Snate@binkert.org        self.name = name           # name of model
7646994Snate@binkert.org        self.filename = filename   # filename for output exec code
7656994Snate@binkert.org        self.includes = includes   # include files needed in exec file
7666994Snate@binkert.org        # The 'strings' dict holds all the per-CPU symbols we can
7676994Snate@binkert.org        # substitute into templates etc.
7686994Snate@binkert.org        self.strings = strings
7696994Snate@binkert.org
7706994Snate@binkert.org        # This cpu is enabled by default
7716994Snate@binkert.org        self.default = default
7726994Snate@binkert.org
7736994Snate@binkert.org        # Add self to dict
7746994Snate@binkert.org        if name in CpuModel.dict:
7756994Snate@binkert.org            raise AttributeError, "CpuModel '%s' already registered" % name
7766994Snate@binkert.org        CpuModel.dict[name] = self
7776994Snate@binkert.org        CpuModel.list.append(name)
7786994Snate@binkert.org
7796994Snate@binkert.orgExport('CpuModel')
7802155SN/A
7815863Snate@binkert.org# Sticky variables get saved in the variables file so they persist from
7821869SN/A# one invocation to the next (unless overridden, in which case the new
7831869SN/A# value becomes sticky).
7845863Snate@binkert.orgsticky_vars = Variables(args=ARGUMENTS)
7855863Snate@binkert.orgExport('sticky_vars')
7864202Sbinkertn@umich.edu
7876108Snate@binkert.org# Sticky variables that should be exported
7886108Snate@binkert.orgexport_vars = []
7896108Snate@binkert.orgExport('export_vars')
7906108Snate@binkert.org
7914202Sbinkertn@umich.edu# Walk the tree and execute all SConsopts scripts that wil add to the
7925863Snate@binkert.org# above variables
7935742Snate@binkert.orgfor bdir in [ base_dir ] + extras_dir_list:
7948268Ssteve.reinhardt@amd.com    if not isdir(bdir):
7958268Ssteve.reinhardt@amd.com        print "Error: directory '%s' does not exist" % bdir
7968268Ssteve.reinhardt@amd.com        Exit(1)
7975742Snate@binkert.org    for root, dirs, files in os.walk(bdir):
7985341Sstever@gmail.com        if 'SConsopts' in files:
7995342Sstever@gmail.com            print "Reading", joinpath(root, 'SConsopts')
8005342Sstever@gmail.com            SConscript(joinpath(root, 'SConsopts'))
8014202Sbinkertn@umich.edu
8024202Sbinkertn@umich.eduall_isa_list.sort()
8034202Sbinkertn@umich.edu
8045863Snate@binkert.orgsticky_vars.AddVariables(
8055863Snate@binkert.org    EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list),
8065863Snate@binkert.org    BoolVariable('FULL_SYSTEM', 'Full-system support', False),
8076994Snate@binkert.org    ListVariable('CPU_MODELS', 'CPU models',
8086994Snate@binkert.org                 sorted(n for n,m in CpuModel.dict.iteritems() if m.default),
8096994Snate@binkert.org                 sorted(CpuModel.list)),
8105863Snate@binkert.org    BoolVariable('NO_FAST_ALLOC', 'Disable fast object allocator', False),
8118152Ssteve.reinhardt@amd.com    BoolVariable('FORCE_FAST_ALLOC',
8128152Ssteve.reinhardt@amd.com                 'Enable fast object allocator, even for m5.debug', False),
8135863Snate@binkert.org    BoolVariable('FAST_ALLOC_STATS', 'Enable fast object allocator statistics',
8145863Snate@binkert.org                 False),
8155863Snate@binkert.org    BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
8165863Snate@binkert.org                 False),
8175863Snate@binkert.org    BoolVariable('SS_COMPATIBLE_FP',
8185863Snate@binkert.org                 'Make floating-point results compatible with SimpleScalar',
8195863Snate@binkert.org                 False),
8205863Snate@binkert.org    BoolVariable('USE_SSE2',
8215863Snate@binkert.org                 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
8225863Snate@binkert.org                 False),
8235863Snate@binkert.org    BoolVariable('USE_MYSQL', 'Use MySQL for stats output', have_mysql),
8247840Snate@binkert.org    BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock),
8255863Snate@binkert.org    BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
8265863Snate@binkert.org    BoolVariable('USE_CHECKER', 'Use checker for detailed CPU models', False),
8275952Ssaidi@eecs.umich.edu    BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False),
8287450Sstever@gmail.com    BoolVariable('RUBY', 'Build with Ruby', False),
8291869SN/A    )
8301858SN/A
8315863Snate@binkert.org# These variables get exported to #defines in config/*.hh (see src/SConscript).
8326108Snate@binkert.orgexport_vars += ['FULL_SYSTEM', 'USE_FENV', 'USE_MYSQL',
8338152Ssteve.reinhardt@amd.com                'NO_FAST_ALLOC', 'FORCE_FAST_ALLOC', 'FAST_ALLOC_STATS',
8347840Snate@binkert.org                'SS_COMPATIBLE_FP', 'USE_CHECKER', 'TARGET_ISA', 'CP_ANNOTATE',
8357840Snate@binkert.org                'USE_POSIX_CLOCK' ]
8361858SN/A
837955SN/A###################################################
838955SN/A#
8391869SN/A# Define a SCons builder for configuration flag headers.
8401869SN/A#
8411869SN/A###################################################
8421869SN/A
8431869SN/A# This function generates a config header file that #defines the
8445863Snate@binkert.org# variable symbol to the current variable setting (0 or 1).  The source
8455863Snate@binkert.org# operands are the name of the variable and a Value node containing the
8465863Snate@binkert.org# value of the variable.
8471869SN/Adef build_config_file(target, source, env):
8485863Snate@binkert.org    (variable, value) = [s.get_contents() for s in source]
8491869SN/A    f = file(str(target[0]), 'w')
8505863Snate@binkert.org    print >> f, '#define', variable, value
8511869SN/A    f.close()
8521869SN/A    return None
8531869SN/A
8541869SN/A# Generate the message to be printed when building the config file.
8551869SN/Adef build_config_file_string(target, source, env):
8565863Snate@binkert.org    (variable, value) = [s.get_contents() for s in source]
8575863Snate@binkert.org    return "Defining %s as %s in %s." % (variable, value, target[0])
8581869SN/A
8591869SN/A# Combine the two functions into a scons Action object.
8601869SN/Aconfig_action = Action(build_config_file, build_config_file_string)
8611869SN/A
8621869SN/A# The emitter munges the source & target node lists to reflect what
8631869SN/A# we're really doing.
8641869SN/Adef config_emitter(target, source, env):
8655863Snate@binkert.org    # extract variable name from Builder arg
8665863Snate@binkert.org    variable = str(target[0])
8671869SN/A    # True target is config header file
8685863Snate@binkert.org    target = joinpath('config', variable.lower() + '.hh')
8695863Snate@binkert.org    val = env[variable]
8703356Sbinkertn@umich.edu    if isinstance(val, bool):
8713356Sbinkertn@umich.edu        # Force value to 0/1
8723356Sbinkertn@umich.edu        val = int(val)
8733356Sbinkertn@umich.edu    elif isinstance(val, str):
8743356Sbinkertn@umich.edu        val = '"' + val + '"'
8754781Snate@binkert.org
8765863Snate@binkert.org    # Sources are variable name & value (packaged in SCons Value nodes)
8775863Snate@binkert.org    return ([target], [Value(variable), Value(val)])
8781869SN/A
8791869SN/Aconfig_builder = Builder(emitter = config_emitter, action = config_action)
8801869SN/A
8816121Snate@binkert.orgmain.Append(BUILDERS = { 'ConfigFile' : config_builder })
8821869SN/A
8832638Sstever@eecs.umich.edu# libelf build is shared across all configs in the build root.
8846121Snate@binkert.orgmain.SConscript('ext/libelf/SConscript',
8856121Snate@binkert.org                variant_dir = joinpath(build_root, 'libelf'))
8862638Sstever@eecs.umich.edu
8875749Scws3k@cs.virginia.edu# gzstream build is shared across all configs in the build root.
8886121Snate@binkert.orgmain.SConscript('ext/gzstream/SConscript',
8896121Snate@binkert.org                variant_dir = joinpath(build_root, 'gzstream'))
8905749Scws3k@cs.virginia.edu
8911869SN/A###################################################
8921869SN/A#
8933546Sgblack@eecs.umich.edu# This function is used to set up a directory with switching headers
8943546Sgblack@eecs.umich.edu#
8953546Sgblack@eecs.umich.edu###################################################
8963546Sgblack@eecs.umich.edu
8976121Snate@binkert.orgmain['ALL_ISA_LIST'] = all_isa_list
8985863Snate@binkert.orgdef make_switching_dir(dname, switch_headers, env):
8993546Sgblack@eecs.umich.edu    # Generate the header.  target[0] is the full path of the output
9003546Sgblack@eecs.umich.edu    # header to generate.  'source' is a dummy variable, since we get the
9013546Sgblack@eecs.umich.edu    # list of ISAs from env['ALL_ISA_LIST'].
9023546Sgblack@eecs.umich.edu    def gen_switch_hdr(target, source, env):
9034781Snate@binkert.org        fname = str(target[0])
9044781Snate@binkert.org        f = open(fname, 'w')
9056658Snate@binkert.org        isa = env['TARGET_ISA'].lower()
9066658Snate@binkert.org        print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname))
9074781Snate@binkert.org        f.close()
9083546Sgblack@eecs.umich.edu
9093546Sgblack@eecs.umich.edu    # Build SCons Action object. 'varlist' specifies env vars that this
9103546Sgblack@eecs.umich.edu    # action depends on; when env['ALL_ISA_LIST'] changes these actions
9113546Sgblack@eecs.umich.edu    # should get re-executed.
9127756SAli.Saidi@ARM.com    switch_hdr_action = MakeAction(gen_switch_hdr,
9137816Ssteve.reinhardt@amd.com                          Transform("GENERATE"), varlist=['ALL_ISA_LIST'])
9143546Sgblack@eecs.umich.edu
9153546Sgblack@eecs.umich.edu    # Instantiate actions for each header
9163546Sgblack@eecs.umich.edu    for hdr in switch_headers:
9173546Sgblack@eecs.umich.edu        env.Command(hdr, [], switch_hdr_action)
9184202Sbinkertn@umich.eduExport('make_switching_dir')
9193546Sgblack@eecs.umich.edu
9203546Sgblack@eecs.umich.edu###################################################
9213546Sgblack@eecs.umich.edu#
922955SN/A# Define build environments for selected configurations.
923955SN/A#
924955SN/A###################################################
925955SN/A
9265863Snate@binkert.orgfor variant_path in variant_paths:
9275863Snate@binkert.org    print "Building in", variant_path
9285343Sstever@gmail.com
9295343Sstever@gmail.com    # Make a copy of the build-root environment to use for this config.
9306121Snate@binkert.org    env = main.Clone()
9315863Snate@binkert.org    env['BUILDDIR'] = variant_path
9324773Snate@binkert.org
9335863Snate@binkert.org    # variant_dir is the tail component of build path, and is used to
9342632Sstever@eecs.umich.edu    # determine the build parameters (e.g., 'ALPHA_SE')
9355863Snate@binkert.org    (build_root, variant_dir) = splitpath(variant_path)
9362023SN/A
9375863Snate@binkert.org    # Set env variables according to the build directory config.
9385863Snate@binkert.org    sticky_vars.files = []
9395863Snate@binkert.org    # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
9405863Snate@binkert.org    # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
9415863Snate@binkert.org    # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
9425863Snate@binkert.org    current_vars_file = joinpath(build_root, 'variables', variant_dir)
9435863Snate@binkert.org    if isfile(current_vars_file):
9445863Snate@binkert.org        sticky_vars.files.append(current_vars_file)
9455863Snate@binkert.org        print "Using saved variables file %s" % current_vars_file
9462632Sstever@eecs.umich.edu    else:
9475863Snate@binkert.org        # Build dir-specific variables file doesn't exist.
9482023SN/A
9492632Sstever@eecs.umich.edu        # Make sure the directory is there so we can create it later
9505863Snate@binkert.org        opt_dir = dirname(current_vars_file)
9515342Sstever@gmail.com        if not isdir(opt_dir):
9525863Snate@binkert.org            mkdir(opt_dir)
9532632Sstever@eecs.umich.edu
9545863Snate@binkert.org        # Get default build variables from source tree.  Variables are
9555863Snate@binkert.org        # normally determined by name of $VARIANT_DIR, but can be
9568267Ssteve.reinhardt@amd.com        # overridden by '--default=' arg on command line.
9578120Sgblack@eecs.umich.edu        default = GetOption('default')
9588267Ssteve.reinhardt@amd.com        opts_dir = joinpath(main.root.abspath, 'build_opts')
9598267Ssteve.reinhardt@amd.com        if default:
9608267Ssteve.reinhardt@amd.com            default_vars_files = [joinpath(build_root, 'variables', default),
9618267Ssteve.reinhardt@amd.com                                  joinpath(opts_dir, default)]
9628267Ssteve.reinhardt@amd.com        else:
9638267Ssteve.reinhardt@amd.com            default_vars_files = [joinpath(opts_dir, variant_dir)]
9648267Ssteve.reinhardt@amd.com        existing_files = filter(isfile, default_vars_files)
9658267Ssteve.reinhardt@amd.com        if existing_files:
9668267Ssteve.reinhardt@amd.com            default_vars_file = existing_files[0]
9675863Snate@binkert.org            sticky_vars.files.append(default_vars_file)
9685863Snate@binkert.org            print "Variables file %s not found,\n  using defaults in %s" \
9695863Snate@binkert.org                  % (current_vars_file, default_vars_file)
9702632Sstever@eecs.umich.edu        else:
9718267Ssteve.reinhardt@amd.com            print "Error: cannot find variables file %s or " \
9728267Ssteve.reinhardt@amd.com                  "default file(s) %s" \
9738267Ssteve.reinhardt@amd.com                  % (current_vars_file, ' or '.join(default_vars_files))
9742632Sstever@eecs.umich.edu            Exit(1)
9751888SN/A
9765863Snate@binkert.org    # Apply current variable settings to env
9775863Snate@binkert.org    sticky_vars.Update(env)
9781858SN/A
9798120Sgblack@eecs.umich.edu    help_texts["local_vars"] += \
9808120Sgblack@eecs.umich.edu        "Build variables for %s:\n" % variant_dir \
9817756SAli.Saidi@ARM.com                 + sticky_vars.GenerateHelpText(env)
9822598SN/A
9835863Snate@binkert.org    # Process variable settings.
9841858SN/A
9851858SN/A    if not have_fenv and env['USE_FENV']:
9861858SN/A        print "Warning: <fenv.h> not available; " \
9875863Snate@binkert.org              "forcing USE_FENV to False in", variant_dir + "."
9881858SN/A        env['USE_FENV'] = False
9891858SN/A
9901858SN/A    if not env['USE_FENV']:
9915863Snate@binkert.org        print "Warning: No IEEE FP rounding mode control in", variant_dir + "."
9921871SN/A        print "         FP results may deviate slightly from other platforms."
9931858SN/A
9941858SN/A    if env['EFENCE']:
9951858SN/A        env.Append(LIBS=['efence'])
9961858SN/A
9971858SN/A    if env['USE_MYSQL']:
9981858SN/A        if not have_mysql:
9991858SN/A            print "Warning: MySQL not available; " \
10005863Snate@binkert.org                  "forcing USE_MYSQL to False in", variant_dir + "."
10011858SN/A            env['USE_MYSQL'] = False
10021858SN/A        else:
10035863Snate@binkert.org            print "Compiling in", variant_dir, "with MySQL support."
10041859SN/A            env.ParseConfig(mysql_config_libs)
10051859SN/A            env.ParseConfig(mysql_config_include)
10061869SN/A
10075863Snate@binkert.org    # Save sticky variable settings back to current variables file
10085863Snate@binkert.org    sticky_vars.Save(current_vars_file, env)
10091869SN/A
10101965SN/A    if env['USE_SSE2']:
10117739Sgblack@eecs.umich.edu        env.Append(CCFLAGS=['-msse2'])
10121965SN/A
10132761Sstever@eecs.umich.edu    # The src/SConscript file sets up the build rules in 'env' according
10145863Snate@binkert.org    # to the configured variables.  It returns a list of environments,
10151869SN/A    # one for each variant build (debug, opt, etc.)
10165863Snate@binkert.org    envList = SConscript('src/SConscript', variant_dir = variant_path,
10172667Sstever@eecs.umich.edu                         exports = 'env')
10181869SN/A
10191869SN/A    # Set up the regression tests for each build.
10202929Sktlim@umich.edu    for e in envList:
10212929Sktlim@umich.edu        SConscript('tests/SConscript',
10225863Snate@binkert.org                   variant_dir = joinpath(variant_path, 'tests', e.Label),
10232929Sktlim@umich.edu                   exports = { 'env' : e }, duplicate = False)
1024955SN/A
10258120Sgblack@eecs.umich.edu# base help text
10268120Sgblack@eecs.umich.eduHelp('''
10278120Sgblack@eecs.umich.eduUsage: scons [scons options] [build variables] [target(s)]
10288120Sgblack@eecs.umich.edu
10298120Sgblack@eecs.umich.eduExtra scons options:
10308120Sgblack@eecs.umich.edu%(options)s
10318120Sgblack@eecs.umich.edu
10328120Sgblack@eecs.umich.eduGlobal build variables:
10338120Sgblack@eecs.umich.edu%(global_vars)s
10348120Sgblack@eecs.umich.edu
10358120Sgblack@eecs.umich.edu%(local_vars)s
10368120Sgblack@eecs.umich.edu''' % help_texts)
1037