SConstruct revision 10264:894679c8cd63
1955SN/A# -*- mode:python -*- 2955SN/A 39812Sandreas.hansson@arm.com# Copyright (c) 2013 ARM Limited 49812Sandreas.hansson@arm.com# All rights reserved. 59812Sandreas.hansson@arm.com# 69812Sandreas.hansson@arm.com# The license below extends only to copyright in the software and shall 79812Sandreas.hansson@arm.com# not be construed as granting a license to any other intellectual 89812Sandreas.hansson@arm.com# property including but not limited to intellectual property relating 99812Sandreas.hansson@arm.com# to a hardware implementation of the functionality of the software 109812Sandreas.hansson@arm.com# licensed hereunder. You may use the software subject to the license 119812Sandreas.hansson@arm.com# terms below provided that you ensure that this notice is replicated 129812Sandreas.hansson@arm.com# unmodified and in its entirety in all distributions of the software, 139812Sandreas.hansson@arm.com# modified or unmodified, in source code or in binary form. 149812Sandreas.hansson@arm.com# 157816Ssteve.reinhardt@amd.com# Copyright (c) 2011 Advanced Micro Devices, Inc. 165871Snate@binkert.org# Copyright (c) 2009 The Hewlett-Packard Development Company 171762SN/A# Copyright (c) 2004-2005 The Regents of The University of Michigan 18955SN/A# All rights reserved. 19955SN/A# 20955SN/A# Redistribution and use in source and binary forms, with or without 21955SN/A# modification, are permitted provided that the following conditions are 22955SN/A# met: redistributions of source code must retain the above copyright 23955SN/A# notice, this list of conditions and the following disclaimer; 24955SN/A# redistributions in binary form must reproduce the above copyright 25955SN/A# notice, this list of conditions and the following disclaimer in the 26955SN/A# documentation and/or other materials provided with the distribution; 27955SN/A# neither the name of the copyright holders nor the names of its 28955SN/A# contributors may be used to endorse or promote products derived from 29955SN/A# this software without specific prior written permission. 30955SN/A# 31955SN/A# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 32955SN/A# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 33955SN/A# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 34955SN/A# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 35955SN/A# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 36955SN/A# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 37955SN/A# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 38955SN/A# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 39955SN/A# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 40955SN/A# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 41955SN/A# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 422665Ssaidi@eecs.umich.edu# 432665Ssaidi@eecs.umich.edu# Authors: Steve Reinhardt 445863Snate@binkert.org# Nathan Binkert 45955SN/A 46955SN/A################################################### 47955SN/A# 48955SN/A# SCons top-level build description (SConstruct) file. 49955SN/A# 508878Ssteve.reinhardt@amd.com# While in this directory ('gem5'), just type 'scons' to build the default 512632Sstever@eecs.umich.edu# configuration (see below), or type 'scons build/<CONFIG>/<binary>' 528878Ssteve.reinhardt@amd.com# to build some other configuration (e.g., 'build/ALPHA/gem5.opt' for 532632Sstever@eecs.umich.edu# the optimized full-system version). 54955SN/A# 558878Ssteve.reinhardt@amd.com# You can build gem5 in a different directory as long as there is a 562632Sstever@eecs.umich.edu# 'build/<CONFIG>' somewhere along the target path. The build system 572761Sstever@eecs.umich.edu# expects that all configs under the same build directory are being 582632Sstever@eecs.umich.edu# built for the same host system. 592632Sstever@eecs.umich.edu# 602632Sstever@eecs.umich.edu# Examples: 612761Sstever@eecs.umich.edu# 622761Sstever@eecs.umich.edu# The following two commands are equivalent. The '-u' option tells 632761Sstever@eecs.umich.edu# scons to search up the directory tree for this SConstruct file. 648878Ssteve.reinhardt@amd.com# % cd <path-to-src>/gem5 ; scons build/ALPHA/gem5.debug 658878Ssteve.reinhardt@amd.com# % cd <path-to-src>/gem5/build/ALPHA; scons -u gem5.debug 662761Sstever@eecs.umich.edu# 672761Sstever@eecs.umich.edu# The following two commands are equivalent and demonstrate building 682761Sstever@eecs.umich.edu# in a directory outside of the source tree. The '-C' option tells 692761Sstever@eecs.umich.edu# scons to chdir to the specified directory to find this SConstruct 702761Sstever@eecs.umich.edu# file. 718878Ssteve.reinhardt@amd.com# % cd <path-to-src>/gem5 ; scons /local/foo/build/ALPHA/gem5.debug 728878Ssteve.reinhardt@amd.com# % cd /local/foo/build/ALPHA; scons -C <path-to-src>/gem5 gem5.debug 732632Sstever@eecs.umich.edu# 742632Sstever@eecs.umich.edu# You can use 'scons -H' to print scons options. If you're in this 758878Ssteve.reinhardt@amd.com# 'gem5' directory (or use -u or -C to tell scons where to find this 768878Ssteve.reinhardt@amd.com# file), you can use 'scons -h' to print all the gem5-specific build 772632Sstever@eecs.umich.edu# options as well. 78955SN/A# 79955SN/A################################################### 80955SN/A 815863Snate@binkert.org# Check for recent-enough Python and SCons versions. 825863Snate@binkert.orgtry: 835863Snate@binkert.org # Really old versions of scons only take two options for the 845863Snate@binkert.org # function, so check once without the revision and once with the 855863Snate@binkert.org # revision, the first instance will fail for stuff other than 865863Snate@binkert.org # 0.98, and the second will fail for 0.98.0 875863Snate@binkert.org EnsureSConsVersion(0, 98) 885863Snate@binkert.org EnsureSConsVersion(0, 98, 1) 895863Snate@binkert.orgexcept SystemExit, e: 905863Snate@binkert.org print """ 915863Snate@binkert.orgFor more details, see: 928878Ssteve.reinhardt@amd.com http://gem5.org/Dependencies 935863Snate@binkert.org""" 945863Snate@binkert.org raise 955863Snate@binkert.org 969812Sandreas.hansson@arm.com# We ensure the python version early because because python-config 979812Sandreas.hansson@arm.com# requires python 2.5 985863Snate@binkert.orgtry: 999812Sandreas.hansson@arm.com EnsurePythonVersion(2, 5) 1005863Snate@binkert.orgexcept SystemExit, e: 1015863Snate@binkert.org print """ 1025863Snate@binkert.orgYou can use a non-default installation of the Python interpreter by 1039812Sandreas.hansson@arm.comrearranging your PATH so that scons finds the non-default 'python' and 1049812Sandreas.hansson@arm.com'python-config' first. 1055863Snate@binkert.org 1065863Snate@binkert.orgFor more details, see: 1078878Ssteve.reinhardt@amd.com http://gem5.org/wiki/index.php/Using_a_non-default_Python_installation 1085863Snate@binkert.org""" 1095863Snate@binkert.org raise 1105863Snate@binkert.org 1116654Snate@binkert.org# Global Python includes 112955SN/Aimport itertools 1135396Ssaidi@eecs.umich.eduimport os 1145863Snate@binkert.orgimport re 1155863Snate@binkert.orgimport subprocess 1164202Sbinkertn@umich.eduimport sys 1175863Snate@binkert.org 1185863Snate@binkert.orgfrom os import mkdir, environ 1195863Snate@binkert.orgfrom os.path import abspath, basename, dirname, expanduser, normpath 1205863Snate@binkert.orgfrom os.path import exists, isdir, isfile 121955SN/Afrom os.path import join as joinpath, split as splitpath 1226654Snate@binkert.org 1235273Sstever@gmail.com# SCons includes 1245871Snate@binkert.orgimport SCons 1255273Sstever@gmail.comimport SCons.Node 1266655Snate@binkert.org 1278878Ssteve.reinhardt@amd.comextra_python_paths = [ 1286655Snate@binkert.org Dir('src/python').srcnode().abspath, # gem5 includes 1296655Snate@binkert.org Dir('ext/ply').srcnode().abspath, # ply is used by several files 1309219Spower.jg@gmail.com ] 1316655Snate@binkert.org 1325871Snate@binkert.orgsys.path[1:1] = extra_python_paths 1336654Snate@binkert.org 1348947Sandreas.hansson@arm.comfrom m5.util import compareVersions, readCommand 1355396Ssaidi@eecs.umich.edufrom m5.util.terminal import get_termcap 1368120Sgblack@eecs.umich.edu 1378120Sgblack@eecs.umich.eduhelp_texts = { 1388120Sgblack@eecs.umich.edu "options" : "", 1398120Sgblack@eecs.umich.edu "global_vars" : "", 1408120Sgblack@eecs.umich.edu "local_vars" : "" 1418120Sgblack@eecs.umich.edu} 1428120Sgblack@eecs.umich.edu 1438120Sgblack@eecs.umich.eduExport("help_texts") 1448879Ssteve.reinhardt@amd.com 1458879Ssteve.reinhardt@amd.com 1468879Ssteve.reinhardt@amd.com# There's a bug in scons in that (1) by default, the help texts from 1478879Ssteve.reinhardt@amd.com# AddOption() are supposed to be displayed when you type 'scons -h' 1488879Ssteve.reinhardt@amd.com# and (2) you can override the help displayed by 'scons -h' using the 1498879Ssteve.reinhardt@amd.com# Help() function, but these two features are incompatible: once 1508879Ssteve.reinhardt@amd.com# you've overridden the help text using Help(), there's no way to get 1518879Ssteve.reinhardt@amd.com# at the help texts from AddOptions. See: 1528879Ssteve.reinhardt@amd.com# http://scons.tigris.org/issues/show_bug.cgi?id=2356 1538879Ssteve.reinhardt@amd.com# http://scons.tigris.org/issues/show_bug.cgi?id=2611 1548879Ssteve.reinhardt@amd.com# This hack lets us extract the help text from AddOptions and 1558879Ssteve.reinhardt@amd.com# re-inject it via Help(). Ideally someday this bug will be fixed and 1568879Ssteve.reinhardt@amd.com# we can just use AddOption directly. 1578120Sgblack@eecs.umich.edudef AddLocalOption(*args, **kwargs): 1588120Sgblack@eecs.umich.edu col_width = 30 1598120Sgblack@eecs.umich.edu 1608120Sgblack@eecs.umich.edu help = " " + ", ".join(args) 1618120Sgblack@eecs.umich.edu if "help" in kwargs: 1628120Sgblack@eecs.umich.edu length = len(help) 1638120Sgblack@eecs.umich.edu if length >= col_width: 1648120Sgblack@eecs.umich.edu help += "\n" + " " * col_width 1658120Sgblack@eecs.umich.edu else: 1668120Sgblack@eecs.umich.edu help += " " * (col_width - length) 1678120Sgblack@eecs.umich.edu help += kwargs["help"] 1688120Sgblack@eecs.umich.edu help_texts["options"] += help + "\n" 1698120Sgblack@eecs.umich.edu 1708120Sgblack@eecs.umich.edu AddOption(*args, **kwargs) 1718879Ssteve.reinhardt@amd.com 1728879Ssteve.reinhardt@amd.comAddLocalOption('--colors', dest='use_colors', action='store_true', 1738879Ssteve.reinhardt@amd.com help="Add color to abbreviated scons output") 1748879Ssteve.reinhardt@amd.comAddLocalOption('--no-colors', dest='use_colors', action='store_false', 1758879Ssteve.reinhardt@amd.com help="Don't add color to abbreviated scons output") 1768879Ssteve.reinhardt@amd.comAddLocalOption('--default', dest='default', type='string', action='store', 1778879Ssteve.reinhardt@amd.com help='Override which build_opts file to use for defaults') 1788879Ssteve.reinhardt@amd.comAddLocalOption('--ignore-style', dest='ignore_style', action='store_true', 1799227Sandreas.hansson@arm.com help='Disable style checking hooks') 1809227Sandreas.hansson@arm.comAddLocalOption('--no-lto', dest='no_lto', action='store_true', 1818879Ssteve.reinhardt@amd.com help='Disable Link-Time Optimization for fast') 1828879Ssteve.reinhardt@amd.comAddLocalOption('--update-ref', dest='update_ref', action='store_true', 1838879Ssteve.reinhardt@amd.com help='Update test reference outputs') 1848879Ssteve.reinhardt@amd.comAddLocalOption('--verbose', dest='verbose', action='store_true', 1858120Sgblack@eecs.umich.edu help='Print full tool command lines') 1868947Sandreas.hansson@arm.com 1877816Ssteve.reinhardt@amd.comtermcap = get_termcap(GetOption('use_colors')) 1885871Snate@binkert.org 1895871Snate@binkert.org######################################################################## 1906121Snate@binkert.org# 1915871Snate@binkert.org# Set up the main build environment. 1925871Snate@binkert.org# 1939119Sandreas.hansson@arm.com######################################################################## 1949396Sandreas.hansson@arm.com 1959396Sandreas.hansson@arm.com# export TERM so that clang reports errors in color 196955SN/Ause_vars = set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH', 1979416SAndreas.Sandberg@ARM.com 'LIBRARY_PATH', 'PATH', 'PKG_CONFIG_PATH', 'PROTOC', 1989416SAndreas.Sandberg@ARM.com 'PYTHONPATH', 'RANLIB', 'SWIG', 'TERM' ]) 1999416SAndreas.Sandberg@ARM.com 2009416SAndreas.Sandberg@ARM.comuse_prefixes = [ 2019416SAndreas.Sandberg@ARM.com "M5", # M5 configuration (e.g., path to kernels) 2029416SAndreas.Sandberg@ARM.com "DISTCC_", # distcc (distributed compiler wrapper) configuration 2039416SAndreas.Sandberg@ARM.com "CCACHE_", # ccache (caching compiler wrapper) configuration 2045871Snate@binkert.org "CCC_", # clang static analyzer configuration 2055871Snate@binkert.org ] 2069416SAndreas.Sandberg@ARM.com 2079416SAndreas.Sandberg@ARM.comuse_env = {} 2085871Snate@binkert.orgfor key,val in os.environ.iteritems(): 209955SN/A if key in use_vars or \ 2106121Snate@binkert.org any([key.startswith(prefix) for prefix in use_prefixes]): 2118881Smarc.orr@gmail.com use_env[key] = val 2126121Snate@binkert.org 2136121Snate@binkert.orgmain = Environment(ENV=use_env) 2141533SN/Amain.Decider('MD5-timestamp') 2159239Sandreas.hansson@arm.commain.root = Dir(".") # The current directory (where this file lives). 2169239Sandreas.hansson@arm.commain.srcdir = Dir("src") # The source directory 2179239Sandreas.hansson@arm.com 2189239Sandreas.hansson@arm.commain_dict_keys = main.Dictionary().keys() 2199239Sandreas.hansson@arm.com 2209239Sandreas.hansson@arm.com# Check that we have a C/C++ compiler 2219239Sandreas.hansson@arm.comif not ('CC' in main_dict_keys and 'CXX' in main_dict_keys): 2229239Sandreas.hansson@arm.com print "No C++ compiler installed (package g++ on Ubuntu and RedHat)" 2239239Sandreas.hansson@arm.com Exit(1) 2249239Sandreas.hansson@arm.com 2259239Sandreas.hansson@arm.com# Check that swig is present 2269239Sandreas.hansson@arm.comif not 'SWIG' in main_dict_keys: 2276655Snate@binkert.org print "swig is not installed (package swig on Ubuntu and RedHat)" 2286655Snate@binkert.org Exit(1) 2296655Snate@binkert.org 2306655Snate@binkert.org# add useful python code PYTHONPATH so it can be used by subprocesses 2315871Snate@binkert.org# as well 2325871Snate@binkert.orgmain.AppendENVPath('PYTHONPATH', extra_python_paths) 2335863Snate@binkert.org 2345871Snate@binkert.org######################################################################## 2358878Ssteve.reinhardt@amd.com# 2365871Snate@binkert.org# Mercurial Stuff. 2375871Snate@binkert.org# 2385871Snate@binkert.org# If the gem5 directory is a mercurial repository, we should do some 2395863Snate@binkert.org# extra things. 2406121Snate@binkert.org# 2415863Snate@binkert.org######################################################################## 2425871Snate@binkert.org 2438336Ssteve.reinhardt@amd.comhgdir = main.root.Dir(".hg") 2448336Ssteve.reinhardt@amd.com 2458336Ssteve.reinhardt@amd.commercurial_style_message = """ 2468336Ssteve.reinhardt@amd.comYou're missing the gem5 style hook, which automatically checks your code 2474678Snate@binkert.orgagainst the gem5 style rules on hg commit and qrefresh commands. This 2488336Ssteve.reinhardt@amd.comscript will now install the hook in your .hg/hgrc file. 2498336Ssteve.reinhardt@amd.comPress enter to continue, or ctrl-c to abort: """ 2508336Ssteve.reinhardt@amd.com 2514678Snate@binkert.orgmercurial_style_hook = """ 2524678Snate@binkert.org# The following lines were automatically added by gem5/SConstruct 2534678Snate@binkert.org# to provide the gem5 style-checking hooks 2544678Snate@binkert.org[extensions] 2557827Snate@binkert.orgstyle = %s/util/style.py 2567827Snate@binkert.org 2578336Ssteve.reinhardt@amd.com[hooks] 2584678Snate@binkert.orgpretxncommit.style = python:style.check_style 2598336Ssteve.reinhardt@amd.compre-qrefresh.style = python:style.check_style 2608336Ssteve.reinhardt@amd.com# End of SConstruct additions 2618336Ssteve.reinhardt@amd.com 2628336Ssteve.reinhardt@amd.com""" % (main.root.abspath) 2638336Ssteve.reinhardt@amd.com 2648336Ssteve.reinhardt@amd.commercurial_lib_not_found = """ 2655871Snate@binkert.orgMercurial libraries cannot be found, ignoring style hook. If 2665871Snate@binkert.orgyou are a gem5 developer, please fix this and run the style 2678336Ssteve.reinhardt@amd.comhook. It is important. 2688336Ssteve.reinhardt@amd.com""" 2698336Ssteve.reinhardt@amd.com 2708336Ssteve.reinhardt@amd.com# Check for style hook and prompt for installation if it's not there. 2718336Ssteve.reinhardt@amd.com# Skip this if --ignore-style was specified, there's no .hg dir to 2725871Snate@binkert.org# install a hook in, or there's no interactive terminal to prompt. 2738336Ssteve.reinhardt@amd.comif not GetOption('ignore_style') and hgdir.exists() and sys.stdin.isatty(): 2748336Ssteve.reinhardt@amd.com style_hook = True 2758336Ssteve.reinhardt@amd.com try: 2768336Ssteve.reinhardt@amd.com from mercurial import ui 2778336Ssteve.reinhardt@amd.com ui = ui.ui() 2784678Snate@binkert.org ui.readconfig(hgdir.File('hgrc').abspath) 2795871Snate@binkert.org style_hook = ui.config('hooks', 'pretxncommit.style', None) and \ 2804678Snate@binkert.org ui.config('hooks', 'pre-qrefresh.style', None) 2818336Ssteve.reinhardt@amd.com except ImportError: 2828336Ssteve.reinhardt@amd.com print mercurial_lib_not_found 2838336Ssteve.reinhardt@amd.com 2848336Ssteve.reinhardt@amd.com if not style_hook: 2858336Ssteve.reinhardt@amd.com print mercurial_style_message, 2868336Ssteve.reinhardt@amd.com # continue unless user does ctrl-c/ctrl-d etc. 2878336Ssteve.reinhardt@amd.com try: 2888336Ssteve.reinhardt@amd.com raw_input() 2898336Ssteve.reinhardt@amd.com except: 2908336Ssteve.reinhardt@amd.com print "Input exception, exiting scons.\n" 2918336Ssteve.reinhardt@amd.com sys.exit(1) 2928336Ssteve.reinhardt@amd.com hgrc_path = '%s/.hg/hgrc' % main.root.abspath 2938336Ssteve.reinhardt@amd.com print "Adding style hook to", hgrc_path, "\n" 2948336Ssteve.reinhardt@amd.com try: 2958336Ssteve.reinhardt@amd.com hgrc = open(hgrc_path, 'a') 2968336Ssteve.reinhardt@amd.com hgrc.write(mercurial_style_hook) 2978336Ssteve.reinhardt@amd.com hgrc.close() 2985871Snate@binkert.org except: 2996121Snate@binkert.org print "Error updating", hgrc_path 300955SN/A sys.exit(1) 301955SN/A 3022632Sstever@eecs.umich.edu 3032632Sstever@eecs.umich.edu################################################### 304955SN/A# 305955SN/A# Figure out which configurations to set up based on the path(s) of 306955SN/A# the target(s). 307955SN/A# 3088878Ssteve.reinhardt@amd.com################################################### 309955SN/A 3102632Sstever@eecs.umich.edu# Find default configuration & binary. 3112632Sstever@eecs.umich.eduDefault(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug')) 3122632Sstever@eecs.umich.edu 3132632Sstever@eecs.umich.edu# helper function: find last occurrence of element in list 3142632Sstever@eecs.umich.edudef rfind(l, elt, offs = -1): 3152632Sstever@eecs.umich.edu for i in range(len(l)+offs, 0, -1): 3162632Sstever@eecs.umich.edu if l[i] == elt: 3178268Ssteve.reinhardt@amd.com return i 3188268Ssteve.reinhardt@amd.com raise ValueError, "element not found" 3198268Ssteve.reinhardt@amd.com 3208268Ssteve.reinhardt@amd.com# Take a list of paths (or SCons Nodes) and return a list with all 3218268Ssteve.reinhardt@amd.com# paths made absolute and ~-expanded. Paths will be interpreted 3228268Ssteve.reinhardt@amd.com# relative to the launch directory unless a different root is provided 3238268Ssteve.reinhardt@amd.comdef makePathListAbsolute(path_list, root=GetLaunchDir()): 3242632Sstever@eecs.umich.edu return [abspath(joinpath(root, expanduser(str(p)))) 3252632Sstever@eecs.umich.edu for p in path_list] 3262632Sstever@eecs.umich.edu 3272632Sstever@eecs.umich.edu# Each target must have 'build' in the interior of the path; the 3288268Ssteve.reinhardt@amd.com# directory below this will determine the build parameters. For 3292632Sstever@eecs.umich.edu# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we 3308268Ssteve.reinhardt@amd.com# recognize that ALPHA_SE specifies the configuration because it 3318268Ssteve.reinhardt@amd.com# follow 'build' in the build path. 3328268Ssteve.reinhardt@amd.com 3338268Ssteve.reinhardt@amd.com# The funky assignment to "[:]" is needed to replace the list contents 3343718Sstever@eecs.umich.edu# in place rather than reassign the symbol to a new list, which 3352634Sstever@eecs.umich.edu# doesn't work (obviously!). 3362634Sstever@eecs.umich.eduBUILD_TARGETS[:] = makePathListAbsolute(BUILD_TARGETS) 3375863Snate@binkert.org 3382638Sstever@eecs.umich.edu# Generate a list of the unique build roots and configs that the 3398268Ssteve.reinhardt@amd.com# collected targets reference. 3402632Sstever@eecs.umich.eduvariant_paths = [] 3412632Sstever@eecs.umich.edubuild_root = None 3422632Sstever@eecs.umich.edufor t in BUILD_TARGETS: 3432632Sstever@eecs.umich.edu path_dirs = t.split('/') 3442632Sstever@eecs.umich.edu try: 3451858SN/A build_top = rfind(path_dirs, 'build', -2) 3463716Sstever@eecs.umich.edu except: 3472638Sstever@eecs.umich.edu print "Error: no non-leaf 'build' dir found on target path", t 3482638Sstever@eecs.umich.edu Exit(1) 3492638Sstever@eecs.umich.edu this_build_root = joinpath('/',*path_dirs[:build_top+1]) 3502638Sstever@eecs.umich.edu if not build_root: 3512638Sstever@eecs.umich.edu build_root = this_build_root 3522638Sstever@eecs.umich.edu else: 3532638Sstever@eecs.umich.edu if this_build_root != build_root: 3545863Snate@binkert.org print "Error: build targets not under same build root\n"\ 3555863Snate@binkert.org " %s\n %s" % (build_root, this_build_root) 3565863Snate@binkert.org Exit(1) 357955SN/A variant_path = joinpath('/',*path_dirs[:build_top+2]) 3585341Sstever@gmail.com if variant_path not in variant_paths: 3595341Sstever@gmail.com variant_paths.append(variant_path) 3605863Snate@binkert.org 3617756SAli.Saidi@ARM.com# Make sure build_root exists (might not if this is the first build there) 3625341Sstever@gmail.comif not isdir(build_root): 3636121Snate@binkert.org mkdir(build_root) 3644494Ssaidi@eecs.umich.edumain['BUILDROOT'] = build_root 3656121Snate@binkert.org 3661105SN/AExport('main') 3672667Sstever@eecs.umich.edu 3682667Sstever@eecs.umich.edumain.SConsignFile(joinpath(build_root, "sconsign")) 3692667Sstever@eecs.umich.edu 3702667Sstever@eecs.umich.edu# Default duplicate option is to use hard links, but this messes up 3716121Snate@binkert.org# when you use emacs to edit a file in the target dir, as emacs moves 3722667Sstever@eecs.umich.edu# file to file~ then copies to file, breaking the link. Symbolic 3735341Sstever@gmail.com# (soft) links work better. 3745863Snate@binkert.orgmain.SetOption('duplicate', 'soft-copy') 3755341Sstever@gmail.com 3765341Sstever@gmail.com# 3775341Sstever@gmail.com# Set up global sticky variables... these are common to an entire build 3788120Sgblack@eecs.umich.edu# tree (not specific to a particular build like ALPHA_SE) 3795341Sstever@gmail.com# 3808120Sgblack@eecs.umich.edu 3815341Sstever@gmail.comglobal_vars_file = joinpath(build_root, 'variables.global') 3828120Sgblack@eecs.umich.edu 3836121Snate@binkert.orgglobal_vars = Variables(global_vars_file, args=ARGUMENTS) 3846121Snate@binkert.org 3858980Ssteve.reinhardt@amd.comglobal_vars.AddVariables( 3869396Sandreas.hansson@arm.com ('CC', 'C compiler', environ.get('CC', main['CC'])), 3875397Ssaidi@eecs.umich.edu ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])), 3885397Ssaidi@eecs.umich.edu ('SWIG', 'SWIG tool', environ.get('SWIG', main['SWIG'])), 3897727SAli.Saidi@ARM.com ('PROTOC', 'protoc tool', environ.get('PROTOC', 'protoc')), 3908268Ssteve.reinhardt@amd.com ('BATCH', 'Use batch pool for build and tests', False), 3916168Snate@binkert.org ('BATCH_CMD', 'Batch pool submission command name', 'qdo'), 3925341Sstever@gmail.com ('M5_BUILD_CACHE', 'Cache built objects in this directory', False), 3938120Sgblack@eecs.umich.edu ('EXTRAS', 'Add extra directories to the compilation', '') 3948120Sgblack@eecs.umich.edu ) 3958120Sgblack@eecs.umich.edu 3966814Sgblack@eecs.umich.edu# Update main environment with values from ARGUMENTS & global_vars_file 3975863Snate@binkert.orgglobal_vars.Update(main) 3988120Sgblack@eecs.umich.eduhelp_texts["global_vars"] += global_vars.GenerateHelpText(main) 3995341Sstever@gmail.com 4005863Snate@binkert.org# Save sticky variable settings back to current variables file 4018268Ssteve.reinhardt@amd.comglobal_vars.Save(global_vars_file, main) 4026121Snate@binkert.org 4036121Snate@binkert.org# Parse EXTRAS variable to build list of all directories where we're 4048268Ssteve.reinhardt@amd.com# look for sources etc. This list is exported as extras_dir_list. 4055742Snate@binkert.orgbase_dir = main.srcdir.abspath 4065742Snate@binkert.orgif main['EXTRAS']: 4075341Sstever@gmail.com extras_dir_list = makePathListAbsolute(main['EXTRAS'].split(':')) 4085742Snate@binkert.orgelse: 4095742Snate@binkert.org extras_dir_list = [] 4105341Sstever@gmail.com 4116017Snate@binkert.orgExport('base_dir') 4126121Snate@binkert.orgExport('extras_dir_list') 4136017Snate@binkert.org 4147816Ssteve.reinhardt@amd.com# the ext directory should be on the #includes path 4157756SAli.Saidi@ARM.commain.Append(CPPPATH=[Dir('ext')]) 4167756SAli.Saidi@ARM.com 4177756SAli.Saidi@ARM.comdef strip_build_path(path, env): 4187756SAli.Saidi@ARM.com path = str(path) 4197756SAli.Saidi@ARM.com variant_base = env['BUILDROOT'] + os.path.sep 4207756SAli.Saidi@ARM.com if path.startswith(variant_base): 4217756SAli.Saidi@ARM.com path = path[len(variant_base):] 4227756SAli.Saidi@ARM.com elif path.startswith('build/'): 4237816Ssteve.reinhardt@amd.com path = path[6:] 4247816Ssteve.reinhardt@amd.com return path 4257816Ssteve.reinhardt@amd.com 4267816Ssteve.reinhardt@amd.com# Generate a string of the form: 4277816Ssteve.reinhardt@amd.com# common/path/prefix/src1, src2 -> tgt1, tgt2 4287816Ssteve.reinhardt@amd.com# to print while building. 4297816Ssteve.reinhardt@amd.comclass Transform(object): 4307816Ssteve.reinhardt@amd.com # all specific color settings should be here and nowhere else 4317816Ssteve.reinhardt@amd.com tool_color = termcap.Normal 4327816Ssteve.reinhardt@amd.com pfx_color = termcap.Yellow 4337756SAli.Saidi@ARM.com srcs_color = termcap.Yellow + termcap.Bold 4347816Ssteve.reinhardt@amd.com arrow_color = termcap.Blue + termcap.Bold 4357816Ssteve.reinhardt@amd.com tgts_color = termcap.Yellow + termcap.Bold 4367816Ssteve.reinhardt@amd.com 4377816Ssteve.reinhardt@amd.com def __init__(self, tool, max_sources=99): 4387816Ssteve.reinhardt@amd.com self.format = self.tool_color + (" [%8s] " % tool) \ 4397816Ssteve.reinhardt@amd.com + self.pfx_color + "%s" \ 4407816Ssteve.reinhardt@amd.com + self.srcs_color + "%s" \ 4417816Ssteve.reinhardt@amd.com + self.arrow_color + " -> " \ 4427816Ssteve.reinhardt@amd.com + self.tgts_color + "%s" \ 4437816Ssteve.reinhardt@amd.com + termcap.Normal 4447816Ssteve.reinhardt@amd.com self.max_sources = max_sources 4457816Ssteve.reinhardt@amd.com 4467816Ssteve.reinhardt@amd.com def __call__(self, target, source, env, for_signature=None): 4477816Ssteve.reinhardt@amd.com # truncate source list according to max_sources param 4487816Ssteve.reinhardt@amd.com source = source[0:self.max_sources] 4497816Ssteve.reinhardt@amd.com def strip(f): 4507816Ssteve.reinhardt@amd.com return strip_build_path(str(f), env) 4517816Ssteve.reinhardt@amd.com if len(source) > 0: 4527816Ssteve.reinhardt@amd.com srcs = map(strip, source) 4537816Ssteve.reinhardt@amd.com else: 4547816Ssteve.reinhardt@amd.com srcs = [''] 4557816Ssteve.reinhardt@amd.com tgts = map(strip, target) 4567816Ssteve.reinhardt@amd.com # surprisingly, os.path.commonprefix is a dumb char-by-char string 4577816Ssteve.reinhardt@amd.com # operation that has nothing to do with paths. 4587816Ssteve.reinhardt@amd.com com_pfx = os.path.commonprefix(srcs + tgts) 4597816Ssteve.reinhardt@amd.com com_pfx_len = len(com_pfx) 4607816Ssteve.reinhardt@amd.com if com_pfx: 4617816Ssteve.reinhardt@amd.com # do some cleanup and sanity checking on common prefix 4627816Ssteve.reinhardt@amd.com if com_pfx[-1] == ".": 4637816Ssteve.reinhardt@amd.com # prefix matches all but file extension: ok 4647816Ssteve.reinhardt@amd.com # back up one to change 'foo.cc -> o' to 'foo.cc -> .o' 4657816Ssteve.reinhardt@amd.com com_pfx = com_pfx[0:-1] 4667816Ssteve.reinhardt@amd.com elif com_pfx[-1] == "/": 4677816Ssteve.reinhardt@amd.com # common prefix is directory path: OK 4687816Ssteve.reinhardt@amd.com pass 4697816Ssteve.reinhardt@amd.com else: 4707816Ssteve.reinhardt@amd.com src0_len = len(srcs[0]) 4717816Ssteve.reinhardt@amd.com tgt0_len = len(tgts[0]) 4727816Ssteve.reinhardt@amd.com if src0_len == com_pfx_len: 4737816Ssteve.reinhardt@amd.com # source is a substring of target, OK 4747816Ssteve.reinhardt@amd.com pass 4757816Ssteve.reinhardt@amd.com elif tgt0_len == com_pfx_len: 4767816Ssteve.reinhardt@amd.com # target is a substring of source, need to back up to 4777816Ssteve.reinhardt@amd.com # avoid empty string on RHS of arrow 4787816Ssteve.reinhardt@amd.com sep_idx = com_pfx.rfind(".") 4797816Ssteve.reinhardt@amd.com if sep_idx != -1: 4807816Ssteve.reinhardt@amd.com com_pfx = com_pfx[0:sep_idx] 4817816Ssteve.reinhardt@amd.com else: 4827816Ssteve.reinhardt@amd.com com_pfx = '' 4837816Ssteve.reinhardt@amd.com elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".": 4847816Ssteve.reinhardt@amd.com # still splitting at file extension: ok 4857816Ssteve.reinhardt@amd.com pass 4867816Ssteve.reinhardt@amd.com else: 4877816Ssteve.reinhardt@amd.com # probably a fluke; ignore it 4887816Ssteve.reinhardt@amd.com com_pfx = '' 4897816Ssteve.reinhardt@amd.com # recalculate length in case com_pfx was modified 4907816Ssteve.reinhardt@amd.com com_pfx_len = len(com_pfx) 4917816Ssteve.reinhardt@amd.com def fmt(files): 4927816Ssteve.reinhardt@amd.com f = map(lambda s: s[com_pfx_len:], files) 4937816Ssteve.reinhardt@amd.com return ', '.join(f) 4947816Ssteve.reinhardt@amd.com return self.format % (com_pfx, fmt(srcs), fmt(tgts)) 4958947Sandreas.hansson@arm.com 4968947Sandreas.hansson@arm.comExport('Transform') 4977756SAli.Saidi@ARM.com 4988120Sgblack@eecs.umich.edu# enable the regression script to use the termcap 4997756SAli.Saidi@ARM.commain['TERMCAP'] = termcap 5007756SAli.Saidi@ARM.com 5017756SAli.Saidi@ARM.comif GetOption('verbose'): 5027756SAli.Saidi@ARM.com def MakeAction(action, string, *args, **kwargs): 5037816Ssteve.reinhardt@amd.com return Action(action, *args, **kwargs) 5047816Ssteve.reinhardt@amd.comelse: 5057816Ssteve.reinhardt@amd.com MakeAction = Action 5067816Ssteve.reinhardt@amd.com main['CCCOMSTR'] = Transform("CC") 5077816Ssteve.reinhardt@amd.com main['CXXCOMSTR'] = Transform("CXX") 5087816Ssteve.reinhardt@amd.com main['ASCOMSTR'] = Transform("AS") 5097816Ssteve.reinhardt@amd.com main['SWIGCOMSTR'] = Transform("SWIG") 5107816Ssteve.reinhardt@amd.com main['ARCOMSTR'] = Transform("AR", 0) 5117816Ssteve.reinhardt@amd.com main['LINKCOMSTR'] = Transform("LINK", 0) 5127816Ssteve.reinhardt@amd.com main['RANLIBCOMSTR'] = Transform("RANLIB", 0) 5137756SAli.Saidi@ARM.com main['M4COMSTR'] = Transform("M4") 5147756SAli.Saidi@ARM.com main['SHCCCOMSTR'] = Transform("SHCC") 5159227Sandreas.hansson@arm.com main['SHCXXCOMSTR'] = Transform("SHCXX") 5169227Sandreas.hansson@arm.comExport('MakeAction') 5179227Sandreas.hansson@arm.com 5189227Sandreas.hansson@arm.com# Initialize the Link-Time Optimization (LTO) flags 5199590Sandreas@sandberg.pp.semain['LTO_CCFLAGS'] = [] 5209590Sandreas@sandberg.pp.semain['LTO_LDFLAGS'] = [] 5219590Sandreas@sandberg.pp.se 5229590Sandreas@sandberg.pp.se# According to the readme, tcmalloc works best if the compiler doesn't 5239590Sandreas@sandberg.pp.se# assume that we're using the builtin malloc and friends. These flags 5249590Sandreas@sandberg.pp.se# are compiler-specific, so we need to set them after we detect which 5256654Snate@binkert.org# compiler we're using. 5266654Snate@binkert.orgmain['TCMALLOC_CCFLAGS'] = [] 5275871Snate@binkert.org 5286121Snate@binkert.orgCXX_version = readCommand([main['CXX'],'--version'], exception=False) 5298946Sandreas.hansson@arm.comCXX_V = readCommand([main['CXX'],'-V'], exception=False) 5309419Sandreas.hansson@arm.com 5313940Ssaidi@eecs.umich.edumain['GCC'] = CXX_version and CXX_version.find('g++') >= 0 5323918Ssaidi@eecs.umich.edumain['CLANG'] = CXX_version and CXX_version.find('clang') >= 0 5333918Ssaidi@eecs.umich.eduif main['GCC'] + main['CLANG'] > 1: 5341858SN/A print 'Error: How can we have two at the same time?' 5359556Sandreas.hansson@arm.com Exit(1) 5369556Sandreas.hansson@arm.com 5379556Sandreas.hansson@arm.com# Set up default C++ compiler flags 5389556Sandreas.hansson@arm.comif main['GCC'] or main['CLANG']: 5399556Sandreas.hansson@arm.com # As gcc and clang share many flags, do the common parts here 5409556Sandreas.hansson@arm.com main.Append(CCFLAGS=['-pipe']) 5419556Sandreas.hansson@arm.com main.Append(CCFLAGS=['-fno-strict-aliasing']) 5429556Sandreas.hansson@arm.com # Enable -Wall and then disable the few warnings that we 5439556Sandreas.hansson@arm.com # consistently violate 5449556Sandreas.hansson@arm.com main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef']) 5459556Sandreas.hansson@arm.com # We always compile using C++11, but only gcc >= 4.7 and clang 3.1 5469556Sandreas.hansson@arm.com # actually use that name, so we stick with c++0x 5479556Sandreas.hansson@arm.com main.Append(CXXFLAGS=['-std=c++0x']) 5489556Sandreas.hansson@arm.com # Add selected sanity checks from -Wextra 5499556Sandreas.hansson@arm.com main.Append(CXXFLAGS=['-Wmissing-field-initializers', 5509556Sandreas.hansson@arm.com '-Woverloaded-virtual']) 5519556Sandreas.hansson@arm.comelse: 5529556Sandreas.hansson@arm.com print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal, 5539556Sandreas.hansson@arm.com print "Don't know what compiler options to use for your compiler." 5549556Sandreas.hansson@arm.com print termcap.Yellow + ' compiler:' + termcap.Normal, main['CXX'] 5559556Sandreas.hansson@arm.com print termcap.Yellow + ' version:' + termcap.Normal, 5569556Sandreas.hansson@arm.com if not CXX_version: 5579556Sandreas.hansson@arm.com print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\ 5589556Sandreas.hansson@arm.com termcap.Normal 5599556Sandreas.hansson@arm.com else: 5609556Sandreas.hansson@arm.com print CXX_version.replace('\n', '<nl>') 5619556Sandreas.hansson@arm.com print " If you're trying to use a compiler other than GCC" 5629556Sandreas.hansson@arm.com print " or clang, there appears to be something wrong with your" 5639556Sandreas.hansson@arm.com print " environment." 5649556Sandreas.hansson@arm.com print " " 5659556Sandreas.hansson@arm.com print " If you are trying to use a compiler other than those listed" 5669556Sandreas.hansson@arm.com print " above you will need to ease fix SConstruct and " 5676121Snate@binkert.org print " src/SConscript to support that compiler." 5689420Sandreas.hansson@arm.com Exit(1) 5699420Sandreas.hansson@arm.com 5709420Sandreas.hansson@arm.comif main['GCC']: 5719420Sandreas.hansson@arm.com # Check for a supported version of gcc. >= 4.6 is chosen for its 5729420Sandreas.hansson@arm.com # level of c++11 support. See 5739420Sandreas.hansson@arm.com # http://gcc.gnu.org/projects/cxx0x.html for details. 4.6 is also 5749420Sandreas.hansson@arm.com # the first version with proper LTO support. 5759420Sandreas.hansson@arm.com gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False) 5769420Sandreas.hansson@arm.com if compareVersions(gcc_version, "4.6") < 0: 5779420Sandreas.hansson@arm.com print 'Error: gcc version 4.6 or newer required.' 5789420Sandreas.hansson@arm.com print ' Installed version:', gcc_version 5797618SAli.Saidi@arm.com Exit(1) 5807618SAli.Saidi@arm.com 5817618SAli.Saidi@arm.com main['GCC_VERSION'] = gcc_version 5827739Sgblack@eecs.umich.edu 5839227Sandreas.hansson@arm.com # gcc from version 4.8 and above generates "rep; ret" instructions 5849227Sandreas.hansson@arm.com # to avoid performance penalties on certain AMD chips. Older 5859227Sandreas.hansson@arm.com # assemblers detect this as an error, "Error: expecting string 5869227Sandreas.hansson@arm.com # instruction after `rep'" 5879227Sandreas.hansson@arm.com if compareVersions(gcc_version, "4.8") > 0: 5889227Sandreas.hansson@arm.com as_version = readCommand([main['AS'], '-v', '/dev/null'], 5899227Sandreas.hansson@arm.com exception=False).split() 5909227Sandreas.hansson@arm.com 5919227Sandreas.hansson@arm.com if not as_version or compareVersions(as_version[-1], "2.23") < 0: 5929227Sandreas.hansson@arm.com print termcap.Yellow + termcap.Bold + \ 5939227Sandreas.hansson@arm.com 'Warning: This combination of gcc and binutils have' + \ 5949227Sandreas.hansson@arm.com ' known incompatibilities.\n' + \ 5959227Sandreas.hansson@arm.com ' If you encounter build problems, please update ' + \ 5969227Sandreas.hansson@arm.com 'binutils to 2.23.' + \ 5979227Sandreas.hansson@arm.com termcap.Normal 5989227Sandreas.hansson@arm.com 5999227Sandreas.hansson@arm.com # Add the appropriate Link-Time Optimization (LTO) flags 6009227Sandreas.hansson@arm.com # unless LTO is explicitly turned off. Note that these flags 6019590Sandreas@sandberg.pp.se # are only used by the fast target. 6029590Sandreas@sandberg.pp.se if not GetOption('no_lto'): 6039590Sandreas@sandberg.pp.se # Pass the LTO flag when compiling to produce GIMPLE 6048737Skoansin.tan@gmail.com # output, we merely create the flags here and only append 6059420Sandreas.hansson@arm.com # them later/ 6069420Sandreas.hansson@arm.com main['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')] 6079420Sandreas.hansson@arm.com 6088737Skoansin.tan@gmail.com # Use the same amount of jobs for LTO as we are running 6098737Skoansin.tan@gmail.com # scons with, we hardcode the use of the linker plugin 6108737Skoansin.tan@gmail.com # which requires either gold or GNU ld >= 2.21 6118737Skoansin.tan@gmail.com main['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs'), 6128737Skoansin.tan@gmail.com '-fuse-linker-plugin'] 6138737Skoansin.tan@gmail.com 6148737Skoansin.tan@gmail.com main.Append(TCMALLOC_CCFLAGS=['-fno-builtin-malloc', '-fno-builtin-calloc', 6158737Skoansin.tan@gmail.com '-fno-builtin-realloc', '-fno-builtin-free']) 6168737Skoansin.tan@gmail.com 6178737Skoansin.tan@gmail.comelif main['CLANG']: 6188737Skoansin.tan@gmail.com # Check for a supported version of clang, >= 3.0 is needed to 6198737Skoansin.tan@gmail.com # support similar features as gcc 4.6. See 6209556Sandreas.hansson@arm.com # http://clang.llvm.org/cxx_status.html for details 6219556Sandreas.hansson@arm.com clang_version_re = re.compile(".* version (\d+\.\d+)") 6229556Sandreas.hansson@arm.com clang_version_match = clang_version_re.search(CXX_version) 6239556Sandreas.hansson@arm.com if (clang_version_match): 6249556Sandreas.hansson@arm.com clang_version = clang_version_match.groups()[0] 6259556Sandreas.hansson@arm.com if compareVersions(clang_version, "3.0") < 0: 6269556Sandreas.hansson@arm.com print 'Error: clang version 3.0 or newer required.' 6279556Sandreas.hansson@arm.com print ' Installed version:', clang_version 6289556Sandreas.hansson@arm.com Exit(1) 6299556Sandreas.hansson@arm.com else: 6309590Sandreas@sandberg.pp.se print 'Error: Unable to determine clang version.' 6319590Sandreas@sandberg.pp.se Exit(1) 6329420Sandreas.hansson@arm.com 6339846Sandreas.hansson@arm.com # clang has a few additional warnings that we disable, 6349846Sandreas.hansson@arm.com # tautological comparisons are allowed due to unsigned integers 6359846Sandreas.hansson@arm.com # being compared to constants that happen to be 0, and extraneous 6369846Sandreas.hansson@arm.com # parantheses are allowed due to Ruby's printing of the AST, 6378946Sandreas.hansson@arm.com # finally self assignments are allowed as the generated CPU code 6383918Ssaidi@eecs.umich.edu # is relying on this 6399068SAli.Saidi@ARM.com main.Append(CCFLAGS=['-Wno-tautological-compare', 6409068SAli.Saidi@ARM.com '-Wno-parentheses', 6419068SAli.Saidi@ARM.com '-Wno-self-assign']) 6429068SAli.Saidi@ARM.com 6439068SAli.Saidi@ARM.com main.Append(TCMALLOC_CCFLAGS=['-fno-builtin']) 6449068SAli.Saidi@ARM.com 6459068SAli.Saidi@ARM.com # On Mac OS X/Darwin we need to also use libc++ (part of XCode) as 6469068SAli.Saidi@ARM.com # opposed to libstdc++, as the later is dated. 6479068SAli.Saidi@ARM.com if sys.platform == "darwin": 6489419Sandreas.hansson@arm.com main.Append(CXXFLAGS=['-stdlib=libc++']) 6499068SAli.Saidi@ARM.com main.Append(LIBS=['c++']) 6509068SAli.Saidi@ARM.com 6519068SAli.Saidi@ARM.comelse: 6529068SAli.Saidi@ARM.com print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal, 6539068SAli.Saidi@ARM.com print "Don't know what compiler options to use for your compiler." 6549068SAli.Saidi@ARM.com print termcap.Yellow + ' compiler:' + termcap.Normal, main['CXX'] 6553918Ssaidi@eecs.umich.edu print termcap.Yellow + ' version:' + termcap.Normal, 6563918Ssaidi@eecs.umich.edu if not CXX_version: 6576157Snate@binkert.org print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\ 6586157Snate@binkert.org termcap.Normal 6596157Snate@binkert.org else: 6606157Snate@binkert.org print CXX_version.replace('\n', '<nl>') 6615397Ssaidi@eecs.umich.edu print " If you're trying to use a compiler other than GCC" 6625397Ssaidi@eecs.umich.edu print " or clang, there appears to be something wrong with your" 6636121Snate@binkert.org print " environment." 6646121Snate@binkert.org print " " 6656121Snate@binkert.org print " If you are trying to use a compiler other than those listed" 6666121Snate@binkert.org print " above you will need to ease fix SConstruct and " 6676121Snate@binkert.org print " src/SConscript to support that compiler." 6686121Snate@binkert.org Exit(1) 6695397Ssaidi@eecs.umich.edu 6701851SN/A# Set up common yacc/bison flags (needed for Ruby) 6711851SN/Amain['YACCFLAGS'] = '-d' 6727739Sgblack@eecs.umich.edumain['YACCHXXFILESUFFIX'] = '.hh' 673955SN/A 6749396Sandreas.hansson@arm.com# Do this after we save setting back, or else we'll tack on an 6759396Sandreas.hansson@arm.com# extra 'qdo' every time we run scons. 6769396Sandreas.hansson@arm.comif main['BATCH']: 6779396Sandreas.hansson@arm.com main['CC'] = main['BATCH_CMD'] + ' ' + main['CC'] 6789396Sandreas.hansson@arm.com main['CXX'] = main['BATCH_CMD'] + ' ' + main['CXX'] 6799396Sandreas.hansson@arm.com main['AS'] = main['BATCH_CMD'] + ' ' + main['AS'] 6809396Sandreas.hansson@arm.com main['AR'] = main['BATCH_CMD'] + ' ' + main['AR'] 6819396Sandreas.hansson@arm.com main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB'] 6829396Sandreas.hansson@arm.com 6839396Sandreas.hansson@arm.comif sys.platform == 'cygwin': 6849396Sandreas.hansson@arm.com # cygwin has some header file issues... 6859396Sandreas.hansson@arm.com main.Append(CCFLAGS=["-Wno-uninitialized"]) 6869396Sandreas.hansson@arm.com 6879396Sandreas.hansson@arm.com# Check for the protobuf compiler 6889396Sandreas.hansson@arm.comprotoc_version = readCommand([main['PROTOC'], '--version'], 6899396Sandreas.hansson@arm.com exception='').split() 6909477Sandreas.hansson@arm.com 6919477Sandreas.hansson@arm.com# First two words should be "libprotoc x.y.z" 6929477Sandreas.hansson@arm.comif len(protoc_version) < 2 or protoc_version[0] != 'libprotoc': 6939477Sandreas.hansson@arm.com print termcap.Yellow + termcap.Bold + \ 6949477Sandreas.hansson@arm.com 'Warning: Protocol buffer compiler (protoc) not found.\n' + \ 6959477Sandreas.hansson@arm.com ' Please install protobuf-compiler for tracing support.' + \ 6969477Sandreas.hansson@arm.com termcap.Normal 6979477Sandreas.hansson@arm.com main['PROTOC'] = False 6989477Sandreas.hansson@arm.comelse: 6999477Sandreas.hansson@arm.com # Based on the availability of the compress stream wrappers, 7009477Sandreas.hansson@arm.com # require 2.1.0 7019477Sandreas.hansson@arm.com min_protoc_version = '2.1.0' 7029477Sandreas.hansson@arm.com if compareVersions(protoc_version[1], min_protoc_version) < 0: 7039477Sandreas.hansson@arm.com print termcap.Yellow + termcap.Bold + \ 7049477Sandreas.hansson@arm.com 'Warning: protoc version', min_protoc_version, \ 7059477Sandreas.hansson@arm.com 'or newer required.\n' + \ 7069477Sandreas.hansson@arm.com ' Installed version:', protoc_version[1], \ 7079477Sandreas.hansson@arm.com termcap.Normal 7089477Sandreas.hansson@arm.com main['PROTOC'] = False 7099477Sandreas.hansson@arm.com else: 7109477Sandreas.hansson@arm.com # Attempt to determine the appropriate include path and 7119477Sandreas.hansson@arm.com # library path using pkg-config, that means we also need to 7129396Sandreas.hansson@arm.com # check for pkg-config. Note that it is possible to use 7133053Sstever@eecs.umich.edu # protobuf without the involvement of pkg-config. Later on we 7146121Snate@binkert.org # check go a library config check and at that point the test 7153053Sstever@eecs.umich.edu # will fail if libprotobuf cannot be found. 7163053Sstever@eecs.umich.edu if readCommand(['pkg-config', '--version'], exception=''): 7173053Sstever@eecs.umich.edu try: 7183053Sstever@eecs.umich.edu # Attempt to establish what linking flags to add for protobuf 7193053Sstever@eecs.umich.edu # using pkg-config 7209072Sandreas.hansson@arm.com main.ParseConfig('pkg-config --cflags --libs-only-L protobuf') 7213053Sstever@eecs.umich.edu except: 7224742Sstever@eecs.umich.edu print termcap.Yellow + termcap.Bold + \ 7234742Sstever@eecs.umich.edu 'Warning: pkg-config could not get protobuf flags.' + \ 7243053Sstever@eecs.umich.edu termcap.Normal 7253053Sstever@eecs.umich.edu 7263053Sstever@eecs.umich.edu# Check for SWIG 7278960Ssteve.reinhardt@amd.comif not main.has_key('SWIG'): 7286654Snate@binkert.org print 'Error: SWIG utility not found.' 7293053Sstever@eecs.umich.edu print ' Please install (see http://www.swig.org) and retry.' 7303053Sstever@eecs.umich.edu Exit(1) 7313053Sstever@eecs.umich.edu 7323053Sstever@eecs.umich.edu# Check for appropriate SWIG version 7339877Sandreas.hansson@arm.comswig_version = readCommand([main['SWIG'], '-version'], exception='').split() 7349877Sandreas.hansson@arm.com# First 3 words should be "SWIG Version x.y.z" 7359877Sandreas.hansson@arm.comif len(swig_version) < 3 or \ 7369877Sandreas.hansson@arm.com swig_version[0] != 'SWIG' or swig_version[1] != 'Version': 7379877Sandreas.hansson@arm.com print 'Error determining SWIG version.' 7389585Sandreas@sandberg.pp.se Exit(1) 7399877Sandreas.hansson@arm.com 7409585Sandreas@sandberg.pp.semin_swig_version = '2.0.4' 7419877Sandreas.hansson@arm.comif compareVersions(swig_version[2], min_swig_version) < 0: 7429877Sandreas.hansson@arm.com print 'Error: SWIG version', min_swig_version, 'or newer required.' 7439585Sandreas@sandberg.pp.se print ' Installed version:', swig_version[2] 7442667Sstever@eecs.umich.edu Exit(1) 7454554Sbinkertn@umich.edu 7466121Snate@binkert.org# Set up SWIG flags & scanner 7472667Sstever@eecs.umich.eduswig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS') 7484554Sbinkertn@umich.edumain.Append(SWIGFLAGS=swig_flags) 7494554Sbinkertn@umich.edu 7504554Sbinkertn@umich.edu# filter out all existing swig scanners, they mess up the dependency 7516121Snate@binkert.org# stuff for some reason 7524554Sbinkertn@umich.eduscanners = [] 7534554Sbinkertn@umich.edufor scanner in main['SCANNERS']: 7544554Sbinkertn@umich.edu skeys = scanner.skeys 7554781Snate@binkert.org if skeys == '.i': 7564554Sbinkertn@umich.edu continue 7574554Sbinkertn@umich.edu 7582667Sstever@eecs.umich.edu if isinstance(skeys, (list, tuple)) and '.i' in skeys: 7594554Sbinkertn@umich.edu continue 7604554Sbinkertn@umich.edu 7614554Sbinkertn@umich.edu scanners.append(scanner) 7624554Sbinkertn@umich.edu 7632667Sstever@eecs.umich.edu# add the new swig scanner that we like better 7644554Sbinkertn@umich.edufrom SCons.Scanner import ClassicCPP as CPPScanner 7652667Sstever@eecs.umich.eduswig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")' 7664554Sbinkertn@umich.eduscanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re)) 7676121Snate@binkert.org 7682667Sstever@eecs.umich.edu# replace the scanners list that has what we want 7695522Snate@binkert.orgmain['SCANNERS'] = scanners 7705522Snate@binkert.org 7715522Snate@binkert.org# Add a custom Check function to the Configure context so that we can 7725522Snate@binkert.org# figure out if the compiler adds leading underscores to global 7735522Snate@binkert.org# variables. This is needed for the autogenerated asm files that we 7745522Snate@binkert.org# use for embedding the python code. 7755522Snate@binkert.orgdef CheckLeading(context): 7765522Snate@binkert.org context.Message("Checking for leading underscore in global variables...") 7775522Snate@binkert.org # 1) Define a global variable called x from asm so the C compiler 7785522Snate@binkert.org # won't change the symbol at all. 7795522Snate@binkert.org # 2) Declare that variable. 7805522Snate@binkert.org # 3) Use the variable 7815522Snate@binkert.org # 7825522Snate@binkert.org # If the compiler prepends an underscore, this will successfully 7835522Snate@binkert.org # link because the external symbol 'x' will be called '_x' which 7845522Snate@binkert.org # was defined by the asm statement. If the compiler does not 7855522Snate@binkert.org # prepend an underscore, this will not successfully link because 7865522Snate@binkert.org # '_x' will have been defined by assembly, while the C portion of 7875522Snate@binkert.org # the code will be trying to use 'x' 7885522Snate@binkert.org ret = context.TryLink(''' 7895522Snate@binkert.org asm(".globl _x; _x: .byte 0"); 7905522Snate@binkert.org extern int x; 7915522Snate@binkert.org int main() { return x; } 7925522Snate@binkert.org ''', extension=".c") 7935522Snate@binkert.org context.env.Append(LEADING_UNDERSCORE=ret) 7945522Snate@binkert.org context.Result(ret) 7952638Sstever@eecs.umich.edu return ret 7962638Sstever@eecs.umich.edu 7976121Snate@binkert.org# Add a custom Check function to test for structure members. 7983716Sstever@eecs.umich.edudef CheckMember(context, include, decl, member, include_quotes="<>"): 7995522Snate@binkert.org context.Message("Checking for member %s in %s..." % 8009420Sandreas.hansson@arm.com (member, decl)) 8015522Snate@binkert.org text = """ 8025522Snate@binkert.org#include %(header)s 8035522Snate@binkert.orgint main(){ 8045522Snate@binkert.org %(decl)s test; 8051858SN/A (void)test.%(member)s; 8065227Ssaidi@eecs.umich.edu return 0; 8075227Ssaidi@eecs.umich.edu}; 8085227Ssaidi@eecs.umich.edu""" % { "header" : include_quotes[0] + include + include_quotes[1], 8095227Ssaidi@eecs.umich.edu "decl" : decl, 8106654Snate@binkert.org "member" : member, 8116654Snate@binkert.org } 8127769SAli.Saidi@ARM.com 8137769SAli.Saidi@ARM.com ret = context.TryCompile(text, extension=".cc") 8147769SAli.Saidi@ARM.com context.Result(ret) 8157769SAli.Saidi@ARM.com return ret 8165227Ssaidi@eecs.umich.edu 8175227Ssaidi@eecs.umich.edu# Platform-specific configuration. Note again that we assume that all 8185227Ssaidi@eecs.umich.edu# builds under a given build root run on the same host platform. 8195204Sstever@gmail.comconf = Configure(main, 8205204Sstever@gmail.com conf_dir = joinpath(build_root, '.scons_config'), 8215204Sstever@gmail.com log_file = joinpath(build_root, 'scons_config.log'), 8225204Sstever@gmail.com custom_tests = { 8235204Sstever@gmail.com 'CheckLeading' : CheckLeading, 8245204Sstever@gmail.com 'CheckMember' : CheckMember, 8255204Sstever@gmail.com }) 8265204Sstever@gmail.com 8275204Sstever@gmail.com# Check for leading underscores. Don't really need to worry either 8285204Sstever@gmail.com# way so don't need to check the return code. 8295204Sstever@gmail.comconf.CheckLeading() 8305204Sstever@gmail.com 8315204Sstever@gmail.com# Check if we should compile a 64 bit binary on Mac OS X/Darwin 8325204Sstever@gmail.comtry: 8335204Sstever@gmail.com import platform 8345204Sstever@gmail.com uname = platform.uname() 8355204Sstever@gmail.com if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0: 8366121Snate@binkert.org if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]): 8375204Sstever@gmail.com main.Append(CCFLAGS=['-arch', 'x86_64']) 8387727SAli.Saidi@ARM.com main.Append(CFLAGS=['-arch', 'x86_64']) 8397727SAli.Saidi@ARM.com main.Append(LINKFLAGS=['-arch', 'x86_64']) 8407727SAli.Saidi@ARM.com main.Append(ASFLAGS=['-arch', 'x86_64']) 8417727SAli.Saidi@ARM.comexcept: 8427727SAli.Saidi@ARM.com pass 8439812Sandreas.hansson@arm.com 8449812Sandreas.hansson@arm.com# Recent versions of scons substitute a "Null" object for Configure() 8459812Sandreas.hansson@arm.com# when configuration isn't necessary, e.g., if the "--help" option is 8469812Sandreas.hansson@arm.com# present. Unfortuantely this Null object always returns false, 8479812Sandreas.hansson@arm.com# breaking all our configuration checks. We replace it with our own 8489812Sandreas.hansson@arm.com# more optimistic null object that returns True instead. 8499812Sandreas.hansson@arm.comif not conf: 8509812Sandreas.hansson@arm.com def NullCheck(*args, **kwargs): 8519812Sandreas.hansson@arm.com return True 8529812Sandreas.hansson@arm.com 8539812Sandreas.hansson@arm.com class NullConf: 8549812Sandreas.hansson@arm.com def __init__(self, env): 8559812Sandreas.hansson@arm.com self.env = env 8569812Sandreas.hansson@arm.com def Finish(self): 8579812Sandreas.hansson@arm.com return self.env 8589812Sandreas.hansson@arm.com def __getattr__(self, mname): 8599812Sandreas.hansson@arm.com return NullCheck 8609812Sandreas.hansson@arm.com 8619812Sandreas.hansson@arm.com conf = NullConf(main) 8629812Sandreas.hansson@arm.com 8639812Sandreas.hansson@arm.com# Cache build files in the supplied directory. 8649812Sandreas.hansson@arm.comif main['M5_BUILD_CACHE']: 8659812Sandreas.hansson@arm.com print 'Using build cache located at', main['M5_BUILD_CACHE'] 8669812Sandreas.hansson@arm.com CacheDir(main['M5_BUILD_CACHE']) 8677727SAli.Saidi@ARM.com 8685863Snate@binkert.org# Find Python include and library directories for embedding the 8693118Sstever@eecs.umich.edu# interpreter. We rely on python-config to resolve the appropriate 8705863Snate@binkert.org# includes and linker flags. ParseConfig does not seem to understand 8719239Sandreas.hansson@arm.com# the more exotic linker flags such as -Xlinker and -export-dynamic so 8723118Sstever@eecs.umich.edu# we add them explicitly below. If you want to link in an alternate 8733118Sstever@eecs.umich.edu# version of python, see above for instructions on how to invoke 8745863Snate@binkert.org# scons with the appropriate PATH set. 8755863Snate@binkert.org# 8765863Snate@binkert.org# First we check if python2-config exists, else we use python-config 8775863Snate@binkert.orgpython_config = readCommand(['which', 'python2-config'], exception='').strip() 8783118Sstever@eecs.umich.eduif not os.path.exists(python_config): 8793483Ssaidi@eecs.umich.edu python_config = readCommand(['which', 'python-config'], 8803494Ssaidi@eecs.umich.edu exception='').strip() 8813494Ssaidi@eecs.umich.edupy_includes = readCommand([python_config, '--includes'], 8823483Ssaidi@eecs.umich.edu exception='').split() 8833483Ssaidi@eecs.umich.edu# Strip the -I from the include folders before adding them to the 8843483Ssaidi@eecs.umich.edu# CPPPATH 8853053Sstever@eecs.umich.edumain.Append(CPPPATH=map(lambda inc: inc[2:], py_includes)) 8863053Sstever@eecs.umich.edu 8873918Ssaidi@eecs.umich.edu# Read the linker flags and split them into libraries and other link 8883053Sstever@eecs.umich.edu# flags. The libraries are added later through the call the CheckLib. 8893053Sstever@eecs.umich.edupy_ld_flags = readCommand([python_config, '--ldflags'], exception='').split() 8903053Sstever@eecs.umich.edupy_libs = [] 8913053Sstever@eecs.umich.edufor lib in py_ld_flags: 8923053Sstever@eecs.umich.edu if not lib.startswith('-l'): 8939396Sandreas.hansson@arm.com main.Append(LINKFLAGS=[lib]) 8949396Sandreas.hansson@arm.com else: 8959396Sandreas.hansson@arm.com lib = lib[2:] 8969396Sandreas.hansson@arm.com if lib not in py_libs: 8979396Sandreas.hansson@arm.com py_libs.append(lib) 8989396Sandreas.hansson@arm.com 8999396Sandreas.hansson@arm.com# verify that this stuff works 9009396Sandreas.hansson@arm.comif not conf.CheckHeader('Python.h', '<>'): 9019396Sandreas.hansson@arm.com print "Error: can't find Python.h header in", py_includes 9029477Sandreas.hansson@arm.com print "Install Python headers (package python-dev on Ubuntu and RedHat)" 9039396Sandreas.hansson@arm.com Exit(1) 9049477Sandreas.hansson@arm.com 9059477Sandreas.hansson@arm.comfor lib in py_libs: 9069477Sandreas.hansson@arm.com if not conf.CheckLib(lib): 9079477Sandreas.hansson@arm.com print "Error: can't find library %s required by python" % lib 9089396Sandreas.hansson@arm.com Exit(1) 9097840Snate@binkert.org 9107865Sgblack@eecs.umich.edu# On Solaris you need to use libsocket for socket ops 9117865Sgblack@eecs.umich.eduif not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'): 9127865Sgblack@eecs.umich.edu if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'): 9137865Sgblack@eecs.umich.edu print "Can't find library with socket calls (e.g. accept())" 9147865Sgblack@eecs.umich.edu Exit(1) 9157840Snate@binkert.org 9169900Sandreas@sandberg.pp.se# Check for zlib. If the check passes, libz will be automatically 9179900Sandreas@sandberg.pp.se# added to the LIBS environment variable. 9189900Sandreas@sandberg.pp.seif not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'): 9199900Sandreas@sandberg.pp.se print 'Error: did not find needed zlib compression library '\ 9209591Sandreas@sandberg.pp.se 'and/or zlib.h header file.' 9219591Sandreas@sandberg.pp.se print ' Please install zlib and try again.' 9229591Sandreas@sandberg.pp.se Exit(1) 9239590Sandreas@sandberg.pp.se 9249590Sandreas@sandberg.pp.se# If we have the protobuf compiler, also make sure we have the 9259045SAli.Saidi@ARM.com# development libraries. If the check passes, libprotobuf will be 9269045SAli.Saidi@ARM.com# automatically added to the LIBS environment variable. After 9279071Sandreas.hansson@arm.com# this, we can use the HAVE_PROTOBUF flag to determine if we have 9289071Sandreas.hansson@arm.com# got both protoc and libprotobuf available. 9299045SAli.Saidi@ARM.commain['HAVE_PROTOBUF'] = main['PROTOC'] and \ 9307840Snate@binkert.org conf.CheckLibWithHeader('protobuf', 'google/protobuf/message.h', 9317840Snate@binkert.org 'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;') 9327840Snate@binkert.org 9331858SN/A# If we have the compiler but not the library, print another warning. 9341858SN/Aif main['PROTOC'] and not main['HAVE_PROTOBUF']: 9351858SN/A print termcap.Yellow + termcap.Bold + \ 9361858SN/A 'Warning: did not find protocol buffer library and/or headers.\n' + \ 9371858SN/A ' Please install libprotobuf-dev for tracing support.' + \ 9381858SN/A termcap.Normal 9399903Sandreas.hansson@arm.com 9409903Sandreas.hansson@arm.com# Check for librt. 9419903Sandreas.hansson@arm.comhave_posix_clock = \ 9429903Sandreas.hansson@arm.com conf.CheckLibWithHeader(None, 'time.h', 'C', 9439903Sandreas.hansson@arm.com 'clock_nanosleep(0,0,NULL,NULL);') or \ 9449903Sandreas.hansson@arm.com conf.CheckLibWithHeader('rt', 'time.h', 'C', 9459651SAndreas.Sandberg@ARM.com 'clock_nanosleep(0,0,NULL,NULL);') 9469903Sandreas.hansson@arm.com 9479651SAndreas.Sandberg@ARM.comhave_posix_timers = \ 9489651SAndreas.Sandberg@ARM.com conf.CheckLibWithHeader([None, 'rt'], [ 'time.h', 'signal.h' ], 'C', 9499651SAndreas.Sandberg@ARM.com 'timer_create(CLOCK_MONOTONIC, NULL, NULL);') 9509651SAndreas.Sandberg@ARM.com 9519651SAndreas.Sandberg@ARM.comif conf.CheckLib('tcmalloc'): 9529657Sandreas.sandberg@arm.com main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS']) 9539883Sandreas@sandberg.pp.seelif conf.CheckLib('tcmalloc_minimal'): 9549651SAndreas.Sandberg@ARM.com main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS']) 9559651SAndreas.Sandberg@ARM.comelse: 9569651SAndreas.Sandberg@ARM.com print termcap.Yellow + termcap.Bold + \ 9579651SAndreas.Sandberg@ARM.com "You can get a 12% performance improvement by installing tcmalloc "\ 9589651SAndreas.Sandberg@ARM.com "(libgoogle-perftools-dev package on Ubuntu or RedHat)." + \ 9599651SAndreas.Sandberg@ARM.com termcap.Normal 9609651SAndreas.Sandberg@ARM.com 9619651SAndreas.Sandberg@ARM.comif not have_posix_clock: 9629651SAndreas.Sandberg@ARM.com print "Can't find library for POSIX clocks." 9639651SAndreas.Sandberg@ARM.com 9649651SAndreas.Sandberg@ARM.com# Check for <fenv.h> (C99 FP environment control) 9655863Snate@binkert.orghave_fenv = conf.CheckHeader('fenv.h', '<>') 9665863Snate@binkert.orgif not have_fenv: 9675863Snate@binkert.org print "Warning: Header file <fenv.h> not found." 9685863Snate@binkert.org print " This host has no IEEE FP rounding mode control." 9696121Snate@binkert.org 9701858SN/A# Check if we should enable KVM-based hardware virtualization. The API 9715863Snate@binkert.org# we rely on exists since version 2.6.36 of the kernel, but somehow 9725863Snate@binkert.org# the KVM_API_VERSION does not reflect the change. We test for one of 9735863Snate@binkert.org# the types as a fall back. 9745863Snate@binkert.orghave_kvm = conf.CheckHeader('linux/kvm.h', '<>') and \ 9755863Snate@binkert.org conf.CheckTypeSize('struct kvm_xsave', '#include <linux/kvm.h>') != 0 9762139SN/Aif not have_kvm: 9774202Sbinkertn@umich.edu print "Info: Compatible header file <linux/kvm.h> not found, " \ 9784202Sbinkertn@umich.edu "disabling KVM support." 9792139SN/A 9806994Snate@binkert.org# Check if the requested target ISA is compatible with the host 9816994Snate@binkert.orgdef is_isa_kvm_compatible(isa): 9826994Snate@binkert.org isa_comp_table = { 9836994Snate@binkert.org "arm" : ( "armv7l" ), 9846994Snate@binkert.org "x86" : ( "x86_64" ), 9856994Snate@binkert.org } 9866994Snate@binkert.org try: 9876994Snate@binkert.org import platform 9886994Snate@binkert.org host_isa = platform.machine() 9896994Snate@binkert.org except: 9906994Snate@binkert.org print "Warning: Failed to determine host ISA." 9916994Snate@binkert.org return False 9926994Snate@binkert.org 9936994Snate@binkert.org return host_isa in isa_comp_table.get(isa, []) 9946994Snate@binkert.org 9956994Snate@binkert.org 9966994Snate@binkert.org# Check if the exclude_host attribute is available. We want this to 9976994Snate@binkert.org# get accurate instruction counts in KVM. 9986994Snate@binkert.orgmain['HAVE_PERF_ATTR_EXCLUDE_HOST'] = conf.CheckMember( 9996994Snate@binkert.org 'linux/perf_event.h', 'struct perf_event_attr', 'exclude_host') 10006994Snate@binkert.org 10016994Snate@binkert.org 10026994Snate@binkert.org###################################################################### 10036994Snate@binkert.org# 10046994Snate@binkert.org# Finish the configuration 10056994Snate@binkert.org# 10066994Snate@binkert.orgmain = conf.Finish() 10076994Snate@binkert.org 10082155SN/A###################################################################### 10095863Snate@binkert.org# 10101869SN/A# Collect all non-global variables 10111869SN/A# 10125863Snate@binkert.org 10135863Snate@binkert.org# Define the universe of supported ISAs 10144202Sbinkertn@umich.eduall_isa_list = [ ] 10156108Snate@binkert.orgExport('all_isa_list') 10166108Snate@binkert.org 10176108Snate@binkert.orgclass CpuModel(object): 10186108Snate@binkert.org '''The CpuModel class encapsulates everything the ISA parser needs to 10199219Spower.jg@gmail.com know about a particular CPU model.''' 10209219Spower.jg@gmail.com 10219219Spower.jg@gmail.com # Dict of available CPU model objects. Accessible as CpuModel.dict. 10229219Spower.jg@gmail.com dict = {} 10239219Spower.jg@gmail.com list = [] 10249219Spower.jg@gmail.com defaults = [] 10259219Spower.jg@gmail.com 10269219Spower.jg@gmail.com # Constructor. Automatically adds models to CpuModel.dict. 10274202Sbinkertn@umich.edu def __init__(self, name, filename, includes, strings, default=False): 10285863Snate@binkert.org self.name = name # name of model 10298474Sgblack@eecs.umich.edu self.filename = filename # filename for output exec code 10308474Sgblack@eecs.umich.edu self.includes = includes # include files needed in exec file 10315742Snate@binkert.org # The 'strings' dict holds all the per-CPU symbols we can 10328268Ssteve.reinhardt@amd.com # substitute into templates etc. 10338268Ssteve.reinhardt@amd.com self.strings = strings 10348268Ssteve.reinhardt@amd.com 10355742Snate@binkert.org # This cpu is enabled by default 10365341Sstever@gmail.com self.default = default 10378474Sgblack@eecs.umich.edu 10388474Sgblack@eecs.umich.edu # Add self to dict 10395342Sstever@gmail.com if name in CpuModel.dict: 10404202Sbinkertn@umich.edu raise AttributeError, "CpuModel '%s' already registered" % name 10414202Sbinkertn@umich.edu CpuModel.dict[name] = self 10424202Sbinkertn@umich.edu CpuModel.list.append(name) 10435863Snate@binkert.org 10445863Snate@binkert.orgExport('CpuModel') 10456994Snate@binkert.org 10466994Snate@binkert.org# Sticky variables get saved in the variables file so they persist from 10476994Snate@binkert.org# one invocation to the next (unless overridden, in which case the new 10485863Snate@binkert.org# value becomes sticky). 10495863Snate@binkert.orgsticky_vars = Variables(args=ARGUMENTS) 10505863Snate@binkert.orgExport('sticky_vars') 10515863Snate@binkert.org 10525863Snate@binkert.org# Sticky variables that should be exported 10535863Snate@binkert.orgexport_vars = [] 10545863Snate@binkert.orgExport('export_vars') 10555863Snate@binkert.org 10567840Snate@binkert.org# For Ruby 10575863Snate@binkert.orgall_protocols = [] 10585952Ssaidi@eecs.umich.eduExport('all_protocols') 10599651SAndreas.Sandberg@ARM.comprotocol_dirs = [] 10609219Spower.jg@gmail.comExport('protocol_dirs') 10619219Spower.jg@gmail.comslicc_includes = [] 10621869SN/AExport('slicc_includes') 10631858SN/A 10645863Snate@binkert.org# Walk the tree and execute all SConsopts scripts that wil add to the 10659420Sandreas.hansson@arm.com# above variables 10669420Sandreas.hansson@arm.comif GetOption('verbose'): 10671858SN/A print "Reading SConsopts" 1068955SN/Afor bdir in [ base_dir ] + extras_dir_list: 1069955SN/A if not isdir(bdir): 10701869SN/A print "Error: directory '%s' does not exist" % bdir 10711869SN/A Exit(1) 10721869SN/A for root, dirs, files in os.walk(bdir): 10731869SN/A if 'SConsopts' in files: 10741869SN/A if GetOption('verbose'): 10755863Snate@binkert.org print "Reading", joinpath(root, 'SConsopts') 10765863Snate@binkert.org SConscript(joinpath(root, 'SConsopts')) 10775863Snate@binkert.org 10781869SN/Aall_isa_list.sort() 10795863Snate@binkert.org 10801869SN/Asticky_vars.AddVariables( 10815863Snate@binkert.org EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list), 10821869SN/A ListVariable('CPU_MODELS', 'CPU models', 10831869SN/A sorted(n for n,m in CpuModel.dict.iteritems() if m.default), 10841869SN/A sorted(CpuModel.list)), 10851869SN/A BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger', 10868483Sgblack@eecs.umich.edu False), 10871869SN/A BoolVariable('SS_COMPATIBLE_FP', 10881869SN/A 'Make floating-point results compatible with SimpleScalar', 10891869SN/A False), 10901869SN/A BoolVariable('USE_SSE2', 10915863Snate@binkert.org 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts', 10925863Snate@binkert.org False), 10931869SN/A BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock), 10945863Snate@binkert.org BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv), 10955863Snate@binkert.org BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False), 10963356Sbinkertn@umich.edu BoolVariable('USE_KVM', 'Enable hardware virtualized (KVM) CPU models', have_kvm), 10973356Sbinkertn@umich.edu EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None', 10983356Sbinkertn@umich.edu all_protocols), 10993356Sbinkertn@umich.edu ) 11003356Sbinkertn@umich.edu 11014781Snate@binkert.org# These variables get exported to #defines in config/*.hh (see src/SConscript). 11025863Snate@binkert.orgexport_vars += ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'CP_ANNOTATE', 11035863Snate@binkert.org 'USE_POSIX_CLOCK', 'PROTOCOL', 'HAVE_PROTOBUF', 11041869SN/A 'HAVE_PERF_ATTR_EXCLUDE_HOST'] 11051869SN/A 11061869SN/A################################################### 11076121Snate@binkert.org# 11081869SN/A# Define a SCons builder for configuration flag headers. 11092638Sstever@eecs.umich.edu# 11106121Snate@binkert.org################################################### 11116121Snate@binkert.org 11122638Sstever@eecs.umich.edu# This function generates a config header file that #defines the 11135749Scws3k@cs.virginia.edu# variable symbol to the current variable setting (0 or 1). The source 11146121Snate@binkert.org# operands are the name of the variable and a Value node containing the 11156121Snate@binkert.org# value of the variable. 11165749Scws3k@cs.virginia.edudef build_config_file(target, source, env): 11179537Satgutier@umich.edu (variable, value) = [s.get_contents() for s in source] 11189537Satgutier@umich.edu f = file(str(target[0]), 'w') 11199537Satgutier@umich.edu print >> f, '#define', variable, value 11209537Satgutier@umich.edu f.close() 11219888Sandreas@sandberg.pp.se return None 11229888Sandreas@sandberg.pp.se 11239888Sandreas@sandberg.pp.se# Combine the two functions into a scons Action object. 11249888Sandreas@sandberg.pp.seconfig_action = MakeAction(build_config_file, Transform("CONFIG H", 2)) 11251869SN/A 11261869SN/A# The emitter munges the source & target node lists to reflect what 11273546Sgblack@eecs.umich.edu# we're really doing. 11283546Sgblack@eecs.umich.edudef config_emitter(target, source, env): 11293546Sgblack@eecs.umich.edu # extract variable name from Builder arg 11303546Sgblack@eecs.umich.edu variable = str(target[0]) 11316121Snate@binkert.org # True target is config header file 11325863Snate@binkert.org target = joinpath('config', variable.lower() + '.hh') 11333546Sgblack@eecs.umich.edu val = env[variable] 11343546Sgblack@eecs.umich.edu if isinstance(val, bool): 11353546Sgblack@eecs.umich.edu # Force value to 0/1 11363546Sgblack@eecs.umich.edu val = int(val) 11374781Snate@binkert.org elif isinstance(val, str): 11384781Snate@binkert.org val = '"' + val + '"' 11396658Snate@binkert.org 11406658Snate@binkert.org # Sources are variable name & value (packaged in SCons Value nodes) 11414781Snate@binkert.org return ([target], [Value(variable), Value(val)]) 11423546Sgblack@eecs.umich.edu 11433546Sgblack@eecs.umich.educonfig_builder = Builder(emitter = config_emitter, action = config_action) 11443546Sgblack@eecs.umich.edu 11453546Sgblack@eecs.umich.edumain.Append(BUILDERS = { 'ConfigFile' : config_builder }) 11467756SAli.Saidi@ARM.com 11477816Ssteve.reinhardt@amd.com# libelf build is shared across all configs in the build root. 11483546Sgblack@eecs.umich.edumain.SConscript('ext/libelf/SConscript', 11493546Sgblack@eecs.umich.edu variant_dir = joinpath(build_root, 'libelf')) 11503546Sgblack@eecs.umich.edu 11513546Sgblack@eecs.umich.edu# gzstream build is shared across all configs in the build root. 11524202Sbinkertn@umich.edumain.SConscript('ext/gzstream/SConscript', 11533546Sgblack@eecs.umich.edu variant_dir = joinpath(build_root, 'gzstream')) 11543546Sgblack@eecs.umich.edu 11553546Sgblack@eecs.umich.edu# libfdt build is shared across all configs in the build root. 1156955SN/Amain.SConscript('ext/libfdt/SConscript', 1157955SN/A variant_dir = joinpath(build_root, 'libfdt')) 1158955SN/A 1159955SN/A# fputils build is shared across all configs in the build root. 11605863Snate@binkert.orgmain.SConscript('ext/fputils/SConscript', 11615863Snate@binkert.org variant_dir = joinpath(build_root, 'fputils')) 11625343Sstever@gmail.com 11635343Sstever@gmail.com# DRAMSim2 build is shared across all configs in the build root. 11646121Snate@binkert.orgmain.SConscript('ext/dramsim2/SConscript', 11655863Snate@binkert.org variant_dir = joinpath(build_root, 'dramsim2')) 11664773Snate@binkert.org 11675863Snate@binkert.org################################################### 11682632Sstever@eecs.umich.edu# 11695863Snate@binkert.org# This function is used to set up a directory with switching headers 11702023SN/A# 11715863Snate@binkert.org################################################### 11725863Snate@binkert.org 11735863Snate@binkert.orgmain['ALL_ISA_LIST'] = all_isa_list 11745863Snate@binkert.orgall_isa_deps = {} 11755863Snate@binkert.orgdef make_switching_dir(dname, switch_headers, env): 11765863Snate@binkert.org # Generate the header. target[0] is the full path of the output 11775863Snate@binkert.org # header to generate. 'source' is a dummy variable, since we get the 11785863Snate@binkert.org # list of ISAs from env['ALL_ISA_LIST']. 11795863Snate@binkert.org def gen_switch_hdr(target, source, env): 11802632Sstever@eecs.umich.edu fname = str(target[0]) 11815863Snate@binkert.org isa = env['TARGET_ISA'].lower() 11822023SN/A try: 11832632Sstever@eecs.umich.edu f = open(fname, 'w') 11845863Snate@binkert.org print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname)) 11855342Sstever@gmail.com f.close() 11865863Snate@binkert.org except IOError: 11872632Sstever@eecs.umich.edu print "Failed to create %s" % fname 11885863Snate@binkert.org raise 11895863Snate@binkert.org 11908267Ssteve.reinhardt@amd.com # Build SCons Action object. 'varlist' specifies env vars that this 11918120Sgblack@eecs.umich.edu # action depends on; when env['ALL_ISA_LIST'] changes these actions 11928267Ssteve.reinhardt@amd.com # should get re-executed. 11938267Ssteve.reinhardt@amd.com switch_hdr_action = MakeAction(gen_switch_hdr, 11948267Ssteve.reinhardt@amd.com Transform("GENERATE"), varlist=['ALL_ISA_LIST']) 11958267Ssteve.reinhardt@amd.com 11968267Ssteve.reinhardt@amd.com # Instantiate actions for each header 11978267Ssteve.reinhardt@amd.com for hdr in switch_headers: 11988267Ssteve.reinhardt@amd.com env.Command(hdr, [], switch_hdr_action) 11998267Ssteve.reinhardt@amd.com 12008267Ssteve.reinhardt@amd.com isa_target = Dir('.').up().name.lower().replace('_', '-') 12015863Snate@binkert.org env['PHONY_BASE'] = '#'+isa_target 12025863Snate@binkert.org all_isa_deps[isa_target] = None 12035863Snate@binkert.org 12042632Sstever@eecs.umich.eduExport('make_switching_dir') 12058267Ssteve.reinhardt@amd.com 12068267Ssteve.reinhardt@amd.com# all-isas -> all-deps -> all-environs -> all_targets 12078267Ssteve.reinhardt@amd.commain.Alias('#all-isas', []) 12082632Sstever@eecs.umich.edumain.Alias('#all-deps', '#all-isas') 12091888SN/A 12105863Snate@binkert.org# Dummy target to ensure all environments are created before telling 12115863Snate@binkert.org# SCons what to actually make (the command line arguments). We attach 12121858SN/A# them to the dependence graph after the environments are complete. 12138120Sgblack@eecs.umich.eduORIG_BUILD_TARGETS = list(BUILD_TARGETS) # force a copy; gets closure to work. 12148120Sgblack@eecs.umich.edudef environsComplete(target, source, env): 12157756SAli.Saidi@ARM.com for t in ORIG_BUILD_TARGETS: 12162598SN/A main.Depends('#all-targets', t) 12175863Snate@binkert.org 12181858SN/A# Each build/* switching_dir attaches its *-environs target to #all-environs. 12191858SN/Amain.Append(BUILDERS = {'CompleteEnvirons' : 12201858SN/A Builder(action=MakeAction(environsComplete, None))}) 12215863Snate@binkert.orgmain.CompleteEnvirons('#all-environs', []) 12221858SN/A 12231858SN/Adef doNothing(**ignored): pass 12241858SN/Amain.Append(BUILDERS = {'Dummy': Builder(action=MakeAction(doNothing, None))}) 12255863Snate@binkert.org 12261871SN/A# The final target to which all the original targets ultimately get attached. 12271858SN/Amain.Dummy('#all-targets', '#all-environs') 12281858SN/ABUILD_TARGETS[:] = ['#all-targets'] 12291858SN/A 12301858SN/A################################################### 12319651SAndreas.Sandberg@ARM.com# 12329651SAndreas.Sandberg@ARM.com# Define build environments for selected configurations. 12339651SAndreas.Sandberg@ARM.com# 12349651SAndreas.Sandberg@ARM.com################################################### 12359900Sandreas@sandberg.pp.se 12369900Sandreas@sandberg.pp.sefor variant_path in variant_paths: 12379900Sandreas@sandberg.pp.se if not GetOption('silent'): 12389900Sandreas@sandberg.pp.se print "Building in", variant_path 12399651SAndreas.Sandberg@ARM.com 12409651SAndreas.Sandberg@ARM.com # Make a copy of the build-root environment to use for this config. 12419651SAndreas.Sandberg@ARM.com env = main.Clone() 12429651SAndreas.Sandberg@ARM.com env['BUILDDIR'] = variant_path 12439651SAndreas.Sandberg@ARM.com 12445863Snate@binkert.org # variant_dir is the tail component of build path, and is used to 12455863Snate@binkert.org # determine the build parameters (e.g., 'ALPHA_SE') 12461869SN/A (build_root, variant_dir) = splitpath(variant_path) 12471965SN/A 12487739Sgblack@eecs.umich.edu # Set env variables according to the build directory config. 12491965SN/A sticky_vars.files = [] 12502761Sstever@eecs.umich.edu # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in 12515863Snate@binkert.org # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke 12521869SN/A # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings. 12535863Snate@binkert.org current_vars_file = joinpath(build_root, 'variables', variant_dir) 12542667Sstever@eecs.umich.edu if isfile(current_vars_file): 12551869SN/A sticky_vars.files.append(current_vars_file) 12561869SN/A if not GetOption('silent'): 12572929Sktlim@umich.edu print "Using saved variables file %s" % current_vars_file 12582929Sktlim@umich.edu else: 12595863Snate@binkert.org # Build dir-specific variables file doesn't exist. 12602929Sktlim@umich.edu 1261955SN/A # Make sure the directory is there so we can create it later 12628120Sgblack@eecs.umich.edu opt_dir = dirname(current_vars_file) 12638120Sgblack@eecs.umich.edu if not isdir(opt_dir): 12648120Sgblack@eecs.umich.edu mkdir(opt_dir) 12658120Sgblack@eecs.umich.edu 12668120Sgblack@eecs.umich.edu # Get default build variables from source tree. Variables are 12678120Sgblack@eecs.umich.edu # normally determined by name of $VARIANT_DIR, but can be 12688120Sgblack@eecs.umich.edu # overridden by '--default=' arg on command line. 12698120Sgblack@eecs.umich.edu default = GetOption('default') 12708120Sgblack@eecs.umich.edu opts_dir = joinpath(main.root.abspath, 'build_opts') 12718120Sgblack@eecs.umich.edu if default: 12728120Sgblack@eecs.umich.edu default_vars_files = [joinpath(build_root, 'variables', default), 12738120Sgblack@eecs.umich.edu joinpath(opts_dir, default)] 1274 else: 1275 default_vars_files = [joinpath(opts_dir, variant_dir)] 1276 existing_files = filter(isfile, default_vars_files) 1277 if existing_files: 1278 default_vars_file = existing_files[0] 1279 sticky_vars.files.append(default_vars_file) 1280 print "Variables file %s not found,\n using defaults in %s" \ 1281 % (current_vars_file, default_vars_file) 1282 else: 1283 print "Error: cannot find variables file %s or " \ 1284 "default file(s) %s" \ 1285 % (current_vars_file, ' or '.join(default_vars_files)) 1286 Exit(1) 1287 1288 # Apply current variable settings to env 1289 sticky_vars.Update(env) 1290 1291 help_texts["local_vars"] += \ 1292 "Build variables for %s:\n" % variant_dir \ 1293 + sticky_vars.GenerateHelpText(env) 1294 1295 # Process variable settings. 1296 1297 if not have_fenv and env['USE_FENV']: 1298 print "Warning: <fenv.h> not available; " \ 1299 "forcing USE_FENV to False in", variant_dir + "." 1300 env['USE_FENV'] = False 1301 1302 if not env['USE_FENV']: 1303 print "Warning: No IEEE FP rounding mode control in", variant_dir + "." 1304 print " FP results may deviate slightly from other platforms." 1305 1306 if env['EFENCE']: 1307 env.Append(LIBS=['efence']) 1308 1309 if env['USE_KVM']: 1310 if not have_kvm: 1311 print "Warning: Can not enable KVM, host seems to lack KVM support" 1312 env['USE_KVM'] = False 1313 elif not have_posix_timers: 1314 print "Warning: Can not enable KVM, host seems to lack support " \ 1315 "for POSIX timers" 1316 env['USE_KVM'] = False 1317 elif not is_isa_kvm_compatible(env['TARGET_ISA']): 1318 print "Info: KVM support disabled due to unsupported host and " \ 1319 "target ISA combination" 1320 env['USE_KVM'] = False 1321 1322 # Warn about missing optional functionality 1323 if env['USE_KVM']: 1324 if not main['HAVE_PERF_ATTR_EXCLUDE_HOST']: 1325 print "Warning: perf_event headers lack support for the " \ 1326 "exclude_host attribute. KVM instruction counts will " \ 1327 "be inaccurate." 1328 1329 # Save sticky variable settings back to current variables file 1330 sticky_vars.Save(current_vars_file, env) 1331 1332 if env['USE_SSE2']: 1333 env.Append(CCFLAGS=['-msse2']) 1334 1335 # The src/SConscript file sets up the build rules in 'env' according 1336 # to the configured variables. It returns a list of environments, 1337 # one for each variant build (debug, opt, etc.) 1338 SConscript('src/SConscript', variant_dir = variant_path, exports = 'env') 1339 1340def pairwise(iterable): 1341 "s -> (s0,s1), (s1,s2), (s2, s3), ..." 1342 a, b = itertools.tee(iterable) 1343 b.next() 1344 return itertools.izip(a, b) 1345 1346# Create false dependencies so SCons will parse ISAs, establish 1347# dependencies, and setup the build Environments serially. Either 1348# SCons (likely) and/or our SConscripts (possibly) cannot cope with -j 1349# greater than 1. It appears to be standard race condition stuff; it 1350# doesn't always fail, but usually, and the behaviors are different. 1351# Every time I tried to remove this, builds would fail in some 1352# creative new way. So, don't do that. You'll want to, though, because 1353# tests/SConscript takes a long time to make its Environments. 1354for t1, t2 in pairwise(sorted(all_isa_deps.iterkeys())): 1355 main.Depends('#%s-deps' % t2, '#%s-deps' % t1) 1356 main.Depends('#%s-environs' % t2, '#%s-environs' % t1) 1357 1358# base help text 1359Help(''' 1360Usage: scons [scons options] [build variables] [target(s)] 1361 1362Extra scons options: 1363%(options)s 1364 1365Global build variables: 1366%(global_vars)s 1367 1368%(local_vars)s 1369''' % help_texts) 1370