SConstruct revision 11988
1955SN/A# -*- mode:python -*- 2955SN/A 311408Sandreas.sandberg@arm.com# Copyright (c) 2013, 2015, 2016 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 11210196SCurtis.Dunham@arm.comimport itertools 113955SN/Aimport os 1145396Ssaidi@eecs.umich.eduimport re 11511401Sandreas.sandberg@arm.comimport shutil 1165863Snate@binkert.orgimport subprocess 1175863Snate@binkert.orgimport sys 1184202Sbinkertn@umich.edu 1195863Snate@binkert.orgfrom os import mkdir, environ 1205863Snate@binkert.orgfrom os.path import abspath, basename, dirname, expanduser, normpath 1215863Snate@binkert.orgfrom os.path import exists, isdir, isfile 1225863Snate@binkert.orgfrom os.path import join as joinpath, split as splitpath 123955SN/A 1246654Snate@binkert.org# SCons includes 1255273Sstever@gmail.comimport SCons 1265871Snate@binkert.orgimport SCons.Node 1275273Sstever@gmail.com 1286655Snate@binkert.orgextra_python_paths = [ 1298878Ssteve.reinhardt@amd.com Dir('src/python').srcnode().abspath, # gem5 includes 1306655Snate@binkert.org Dir('ext/ply').srcnode().abspath, # ply is used by several files 1316655Snate@binkert.org ] 1329219Spower.jg@gmail.com 1336655Snate@binkert.orgsys.path[1:1] = extra_python_paths 1345871Snate@binkert.org 1356654Snate@binkert.orgfrom m5.util import compareVersions, readCommand 1368947Sandreas.hansson@arm.comfrom m5.util.terminal import get_termcap 1375396Ssaidi@eecs.umich.edu 1388120Sgblack@eecs.umich.eduhelp_texts = { 1398120Sgblack@eecs.umich.edu "options" : "", 1408120Sgblack@eecs.umich.edu "global_vars" : "", 1418120Sgblack@eecs.umich.edu "local_vars" : "" 1428120Sgblack@eecs.umich.edu} 1438120Sgblack@eecs.umich.edu 1448120Sgblack@eecs.umich.eduExport("help_texts") 1458120Sgblack@eecs.umich.edu 1468879Ssteve.reinhardt@amd.com 1478879Ssteve.reinhardt@amd.com# There's a bug in scons in that (1) by default, the help texts from 1488879Ssteve.reinhardt@amd.com# AddOption() are supposed to be displayed when you type 'scons -h' 1498879Ssteve.reinhardt@amd.com# and (2) you can override the help displayed by 'scons -h' using the 1508879Ssteve.reinhardt@amd.com# Help() function, but these two features are incompatible: once 1518879Ssteve.reinhardt@amd.com# you've overridden the help text using Help(), there's no way to get 1528879Ssteve.reinhardt@amd.com# at the help texts from AddOptions. See: 1538879Ssteve.reinhardt@amd.com# http://scons.tigris.org/issues/show_bug.cgi?id=2356 1548879Ssteve.reinhardt@amd.com# http://scons.tigris.org/issues/show_bug.cgi?id=2611 1558879Ssteve.reinhardt@amd.com# This hack lets us extract the help text from AddOptions and 1568879Ssteve.reinhardt@amd.com# re-inject it via Help(). Ideally someday this bug will be fixed and 1578879Ssteve.reinhardt@amd.com# we can just use AddOption directly. 1588879Ssteve.reinhardt@amd.comdef AddLocalOption(*args, **kwargs): 1598120Sgblack@eecs.umich.edu col_width = 30 1608120Sgblack@eecs.umich.edu 1618120Sgblack@eecs.umich.edu help = " " + ", ".join(args) 1628120Sgblack@eecs.umich.edu if "help" in kwargs: 1638120Sgblack@eecs.umich.edu length = len(help) 1648120Sgblack@eecs.umich.edu if length >= col_width: 1658120Sgblack@eecs.umich.edu help += "\n" + " " * col_width 1668120Sgblack@eecs.umich.edu else: 1678120Sgblack@eecs.umich.edu help += " " * (col_width - length) 1688120Sgblack@eecs.umich.edu help += kwargs["help"] 1698120Sgblack@eecs.umich.edu help_texts["options"] += help + "\n" 1708120Sgblack@eecs.umich.edu 1718120Sgblack@eecs.umich.edu AddOption(*args, **kwargs) 1728120Sgblack@eecs.umich.edu 1738879Ssteve.reinhardt@amd.comAddLocalOption('--colors', dest='use_colors', action='store_true', 1748879Ssteve.reinhardt@amd.com help="Add color to abbreviated scons output") 1758879Ssteve.reinhardt@amd.comAddLocalOption('--no-colors', dest='use_colors', action='store_false', 1768879Ssteve.reinhardt@amd.com help="Don't add color to abbreviated scons output") 17710458Sandreas.hansson@arm.comAddLocalOption('--with-cxx-config', dest='with_cxx_config', 17810458Sandreas.hansson@arm.com action='store_true', 17910458Sandreas.hansson@arm.com help="Build with support for C++-based configuration") 1808879Ssteve.reinhardt@amd.comAddLocalOption('--default', dest='default', type='string', action='store', 1818879Ssteve.reinhardt@amd.com help='Override which build_opts file to use for defaults') 1828879Ssteve.reinhardt@amd.comAddLocalOption('--ignore-style', dest='ignore_style', action='store_true', 1838879Ssteve.reinhardt@amd.com help='Disable style checking hooks') 1849227Sandreas.hansson@arm.comAddLocalOption('--no-lto', dest='no_lto', action='store_true', 1859227Sandreas.hansson@arm.com help='Disable Link-Time Optimization for fast') 1868879Ssteve.reinhardt@amd.comAddLocalOption('--update-ref', dest='update_ref', action='store_true', 1878879Ssteve.reinhardt@amd.com help='Update test reference outputs') 1888879Ssteve.reinhardt@amd.comAddLocalOption('--verbose', dest='verbose', action='store_true', 1898879Ssteve.reinhardt@amd.com help='Print full tool command lines') 19010453SAndrew.Bardsley@arm.comAddLocalOption('--without-python', dest='without_python', 19110453SAndrew.Bardsley@arm.com action='store_true', 19210453SAndrew.Bardsley@arm.com help='Build without Python configuration support') 19310456SCurtis.Dunham@arm.comAddLocalOption('--without-tcmalloc', dest='without_tcmalloc', 19410456SCurtis.Dunham@arm.com action='store_true', 19510456SCurtis.Dunham@arm.com help='Disable linking against tcmalloc') 19610457Sandreas.hansson@arm.comAddLocalOption('--with-ubsan', dest='with_ubsan', action='store_true', 19710457Sandreas.hansson@arm.com help='Build with Undefined Behavior Sanitizer if available') 19811342Sandreas.hansson@arm.comAddLocalOption('--with-asan', dest='with_asan', action='store_true', 19911342Sandreas.hansson@arm.com help='Build with Address Sanitizer if available') 2008120Sgblack@eecs.umich.edu 2018947Sandreas.hansson@arm.comtermcap = get_termcap(GetOption('use_colors')) 2027816Ssteve.reinhardt@amd.com 2035871Snate@binkert.org######################################################################## 2045871Snate@binkert.org# 2056121Snate@binkert.org# Set up the main build environment. 2065871Snate@binkert.org# 2075871Snate@binkert.org######################################################################## 2089926Sstan.czerniawski@arm.com 2099926Sstan.czerniawski@arm.com# export TERM so that clang reports errors in color 2109119Sandreas.hansson@arm.comuse_vars = set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH', 21110068Sandreas.hansson@arm.com 'LIBRARY_PATH', 'PATH', 'PKG_CONFIG_PATH', 'PROTOC', 21210068Sandreas.hansson@arm.com 'PYTHONPATH', 'RANLIB', 'SWIG', 'TERM' ]) 213955SN/A 2149416SAndreas.Sandberg@ARM.comuse_prefixes = [ 21511342Sandreas.hansson@arm.com "ASAN_", # address sanitizer symbolizer path and settings 21611212Sjoseph.gross@amd.com "CCACHE_", # ccache (caching compiler wrapper) configuration 21711212Sjoseph.gross@amd.com "CCC_", # clang static analyzer configuration 21811212Sjoseph.gross@amd.com "DISTCC_", # distcc (distributed compiler wrapper) configuration 21911212Sjoseph.gross@amd.com "INCLUDE_SERVER_", # distcc pump server settings 22011212Sjoseph.gross@amd.com "M5", # M5 configuration (e.g., path to kernels) 2219416SAndreas.Sandberg@ARM.com ] 2229416SAndreas.Sandberg@ARM.com 2235871Snate@binkert.orguse_env = {} 22410584Sandreas.hansson@arm.comfor key,val in sorted(os.environ.iteritems()): 2259416SAndreas.Sandberg@ARM.com if key in use_vars or \ 2269416SAndreas.Sandberg@ARM.com any([key.startswith(prefix) for prefix in use_prefixes]): 2275871Snate@binkert.org use_env[key] = val 228955SN/A 22910671Sandreas.hansson@arm.com# Tell scons to avoid implicit command dependencies to avoid issues 23010671Sandreas.hansson@arm.com# with the param wrappes being compiled twice (see 23110671Sandreas.hansson@arm.com# http://scons.tigris.org/issues/show_bug.cgi?id=2811) 23210671Sandreas.hansson@arm.commain = Environment(ENV=use_env, IMPLICIT_COMMAND_DEPENDENCIES=0) 2338881Smarc.orr@gmail.commain.Decider('MD5-timestamp') 2346121Snate@binkert.orgmain.root = Dir(".") # The current directory (where this file lives). 2356121Snate@binkert.orgmain.srcdir = Dir("src") # The source directory 2361533SN/A 2379239Sandreas.hansson@arm.commain_dict_keys = main.Dictionary().keys() 2389239Sandreas.hansson@arm.com 2399239Sandreas.hansson@arm.com# Check that we have a C/C++ compiler 2409239Sandreas.hansson@arm.comif not ('CC' in main_dict_keys and 'CXX' in main_dict_keys): 2419239Sandreas.hansson@arm.com print "No C++ compiler installed (package g++ on Ubuntu and RedHat)" 2429239Sandreas.hansson@arm.com Exit(1) 2439239Sandreas.hansson@arm.com 2449239Sandreas.hansson@arm.com# Check that swig is present 2459239Sandreas.hansson@arm.comif not 'SWIG' in main_dict_keys: 2469239Sandreas.hansson@arm.com print "swig is not installed (package swig on Ubuntu and RedHat)" 2479239Sandreas.hansson@arm.com Exit(1) 2489239Sandreas.hansson@arm.com 2496655Snate@binkert.org# add useful python code PYTHONPATH so it can be used by subprocesses 2506655Snate@binkert.org# as well 2516655Snate@binkert.orgmain.AppendENVPath('PYTHONPATH', extra_python_paths) 2526655Snate@binkert.org 2535871Snate@binkert.org######################################################################## 2545871Snate@binkert.org# 2555863Snate@binkert.org# Mercurial Stuff. 2565871Snate@binkert.org# 2578878Ssteve.reinhardt@amd.com# If the gem5 directory is a mercurial repository, we should do some 2585871Snate@binkert.org# extra things. 2595871Snate@binkert.org# 2605871Snate@binkert.org######################################################################## 2615863Snate@binkert.org 2626121Snate@binkert.orghgdir = main.root.Dir(".hg") 2635863Snate@binkert.org 26411408Sandreas.sandberg@arm.com 26511408Sandreas.sandberg@arm.comstyle_message = """ 2668336Ssteve.reinhardt@amd.comYou're missing the gem5 style hook, which automatically checks your code 26711469SCurtis.Dunham@arm.comagainst the gem5 style rules on %s. 26811469SCurtis.Dunham@arm.comThis script will now install the hook in your %s. 2698336Ssteve.reinhardt@amd.comPress enter to continue, or ctrl-c to abort: """ 2704678Snate@binkert.org 27111887Sandreas.sandberg@arm.commercurial_style_message = """ 27211887Sandreas.sandberg@arm.comYou're missing the gem5 style hook, which automatically checks your code 27311887Sandreas.sandberg@arm.comagainst the gem5 style rules on hg commit and qrefresh commands. 27411887Sandreas.sandberg@arm.comThis script will now install the hook in your .hg/hgrc file. 27511887Sandreas.sandberg@arm.comPress enter to continue, or ctrl-c to abort: """ 27611887Sandreas.sandberg@arm.com 27711887Sandreas.sandberg@arm.comgit_style_message = """ 27811887Sandreas.sandberg@arm.comYou're missing the gem5 style or commit message hook. These hooks help 27911887Sandreas.sandberg@arm.comto ensure that your code follows gem5's style rules on git commit. 28011887Sandreas.sandberg@arm.comThis script will now install the hook in your .git/hooks/ directory. 28111887Sandreas.sandberg@arm.comPress enter to continue, or ctrl-c to abort: """ 28211408Sandreas.sandberg@arm.com 28311401Sandreas.sandberg@arm.commercurial_style_upgrade_message = """ 28411401Sandreas.sandberg@arm.comYour Mercurial style hooks are not up-to-date. This script will now 28511401Sandreas.sandberg@arm.comtry to automatically update them. A backup of your hgrc will be saved 28611401Sandreas.sandberg@arm.comin .hg/hgrc.old. 28711401Sandreas.sandberg@arm.comPress enter to continue, or ctrl-c to abort: """ 28811401Sandreas.sandberg@arm.com 2898336Ssteve.reinhardt@amd.commercurial_style_hook = """ 2908336Ssteve.reinhardt@amd.com# The following lines were automatically added by gem5/SConstruct 2918336Ssteve.reinhardt@amd.com# to provide the gem5 style-checking hooks 2924678Snate@binkert.org[extensions] 29311401Sandreas.sandberg@arm.comhgstyle = %s/util/hgstyle.py 2944678Snate@binkert.org 2954678Snate@binkert.org[hooks] 29611401Sandreas.sandberg@arm.compretxncommit.style = python:hgstyle.check_style 29711401Sandreas.sandberg@arm.compre-qrefresh.style = python:hgstyle.check_style 2988336Ssteve.reinhardt@amd.com# End of SConstruct additions 2994678Snate@binkert.org 3008336Ssteve.reinhardt@amd.com""" % (main.root.abspath) 3018336Ssteve.reinhardt@amd.com 3028336Ssteve.reinhardt@amd.commercurial_lib_not_found = """ 3038336Ssteve.reinhardt@amd.comMercurial libraries cannot be found, ignoring style hook. If 3048336Ssteve.reinhardt@amd.comyou are a gem5 developer, please fix this and run the style 3058336Ssteve.reinhardt@amd.comhook. It is important. 3065871Snate@binkert.org""" 3075871Snate@binkert.org 3088336Ssteve.reinhardt@amd.com# Check for style hook and prompt for installation if it's not there. 30911408Sandreas.sandberg@arm.com# Skip this if --ignore-style was specified, there's no interactive 31011408Sandreas.sandberg@arm.com# terminal to prompt, or no recognized revision control system can be 31111408Sandreas.sandberg@arm.com# found. 31211408Sandreas.sandberg@arm.comignore_style = GetOption('ignore_style') or not sys.stdin.isatty() 31311408Sandreas.sandberg@arm.com 31411408Sandreas.sandberg@arm.com# Try wire up Mercurial to the style hooks 31511408Sandreas.sandberg@arm.comif not ignore_style and hgdir.exists(): 3168336Ssteve.reinhardt@amd.com style_hook = True 31711401Sandreas.sandberg@arm.com style_hooks = tuple() 31811401Sandreas.sandberg@arm.com hgrc = hgdir.File('hgrc') 31911401Sandreas.sandberg@arm.com hgrc_old = hgdir.File('hgrc.old') 3205871Snate@binkert.org try: 3218336Ssteve.reinhardt@amd.com from mercurial import ui 3228336Ssteve.reinhardt@amd.com ui = ui.ui() 32311401Sandreas.sandberg@arm.com ui.readconfig(hgrc.abspath) 32411401Sandreas.sandberg@arm.com style_hooks = (ui.config('hooks', 'pretxncommit.style', None), 32511401Sandreas.sandberg@arm.com ui.config('hooks', 'pre-qrefresh.style', None)) 32611401Sandreas.sandberg@arm.com style_hook = all(style_hooks) 32711401Sandreas.sandberg@arm.com style_extension = ui.config('extensions', 'style', None) 3284678Snate@binkert.org except ImportError: 3295871Snate@binkert.org print mercurial_lib_not_found 3304678Snate@binkert.org 33111401Sandreas.sandberg@arm.com if "python:style.check_style" in style_hooks: 33211401Sandreas.sandberg@arm.com # Try to upgrade the style hooks 33311401Sandreas.sandberg@arm.com print mercurial_style_upgrade_message 33411401Sandreas.sandberg@arm.com # continue unless user does ctrl-c/ctrl-d etc. 33511401Sandreas.sandberg@arm.com try: 33611401Sandreas.sandberg@arm.com raw_input() 33711401Sandreas.sandberg@arm.com except: 33811401Sandreas.sandberg@arm.com print "Input exception, exiting scons.\n" 33911401Sandreas.sandberg@arm.com sys.exit(1) 34011401Sandreas.sandberg@arm.com shutil.copyfile(hgrc.abspath, hgrc_old.abspath) 34111401Sandreas.sandberg@arm.com re_style_hook = re.compile(r"^([^=#]+)\.style\s*=\s*([^#\s]+).*") 34211401Sandreas.sandberg@arm.com re_style_extension = re.compile("style\s*=\s*([^#\s]+).*") 34311450Sandreas.sandberg@arm.com old, new = open(hgrc_old.abspath, 'r'), open(hgrc.abspath, 'w') 34411450Sandreas.sandberg@arm.com for l in old: 34511450Sandreas.sandberg@arm.com m_hook = re_style_hook.match(l) 34611450Sandreas.sandberg@arm.com m_ext = re_style_extension.match(l) 34711450Sandreas.sandberg@arm.com if m_hook: 34811450Sandreas.sandberg@arm.com hook, check = m_hook.groups() 34911450Sandreas.sandberg@arm.com if check != "python:style.check_style": 35011450Sandreas.sandberg@arm.com print "Warning: %s.style is using a non-default " \ 35111450Sandreas.sandberg@arm.com "checker: %s" % (hook, check) 35211450Sandreas.sandberg@arm.com if hook not in ("pretxncommit", "pre-qrefresh"): 35311450Sandreas.sandberg@arm.com print "Warning: Updating unknown style hook: %s" % hook 35411401Sandreas.sandberg@arm.com 35511450Sandreas.sandberg@arm.com l = "%s.style = python:hgstyle.check_style\n" % hook 35611450Sandreas.sandberg@arm.com elif m_ext and m_ext.group(1) == style_extension: 35711450Sandreas.sandberg@arm.com l = "hgstyle = %s/util/hgstyle.py\n" % main.root.abspath 35811401Sandreas.sandberg@arm.com 35911450Sandreas.sandberg@arm.com new.write(l) 36011401Sandreas.sandberg@arm.com elif not style_hook: 3618336Ssteve.reinhardt@amd.com print mercurial_style_message, 3628336Ssteve.reinhardt@amd.com # continue unless user does ctrl-c/ctrl-d etc. 3638336Ssteve.reinhardt@amd.com try: 3648336Ssteve.reinhardt@amd.com raw_input() 3658336Ssteve.reinhardt@amd.com except: 3668336Ssteve.reinhardt@amd.com print "Input exception, exiting scons.\n" 3678336Ssteve.reinhardt@amd.com sys.exit(1) 3688336Ssteve.reinhardt@amd.com hgrc_path = '%s/.hg/hgrc' % main.root.abspath 3698336Ssteve.reinhardt@amd.com print "Adding style hook to", hgrc_path, "\n" 3708336Ssteve.reinhardt@amd.com try: 37111401Sandreas.sandberg@arm.com with open(hgrc_path, 'a') as f: 37211401Sandreas.sandberg@arm.com f.write(mercurial_style_hook) 3738336Ssteve.reinhardt@amd.com except: 3748336Ssteve.reinhardt@amd.com print "Error updating", hgrc_path 3758336Ssteve.reinhardt@amd.com sys.exit(1) 3765871Snate@binkert.org 37711476Sandreas.sandberg@arm.comdef install_git_style_hooks(): 37811476Sandreas.sandberg@arm.com try: 37911476Sandreas.sandberg@arm.com gitdir = Dir(readCommand( 38011476Sandreas.sandberg@arm.com ["git", "rev-parse", "--git-dir"]).strip("\n")) 38111476Sandreas.sandberg@arm.com except Exception, e: 38211476Sandreas.sandberg@arm.com print "Warning: Failed to find git repo directory: %s" % e 38311476Sandreas.sandberg@arm.com return 38411476Sandreas.sandberg@arm.com 38511476Sandreas.sandberg@arm.com git_hooks = gitdir.Dir("hooks") 38611887Sandreas.sandberg@arm.com def hook_exists(hook_name): 38711887Sandreas.sandberg@arm.com hook = git_hooks.File(hook_name) 38811887Sandreas.sandberg@arm.com return hook.exists() 38911408Sandreas.sandberg@arm.com 39011887Sandreas.sandberg@arm.com def hook_install(hook_name, script): 39111887Sandreas.sandberg@arm.com hook = git_hooks.File(hook_name) 39211887Sandreas.sandberg@arm.com if hook.exists(): 39311887Sandreas.sandberg@arm.com print "Warning: Can't install %s, hook already exists." % hook_name 39411887Sandreas.sandberg@arm.com return 39511887Sandreas.sandberg@arm.com 39611926Sgabeblack@google.com if hook.islink(): 39711926Sgabeblack@google.com print "Warning: Removing broken symlink for hook %s." % hook_name 39811926Sgabeblack@google.com os.unlink(hook.get_abspath()) 39911926Sgabeblack@google.com 40011887Sandreas.sandberg@arm.com if not git_hooks.exists(): 40111887Sandreas.sandberg@arm.com mkdir(git_hooks.get_abspath()) 40211944Sandreas.sandberg@arm.com git_hooks.clear() 40311887Sandreas.sandberg@arm.com 40411927Sgabeblack@google.com abs_symlink_hooks = git_hooks.islink() and \ 40511927Sgabeblack@google.com os.path.isabs(os.readlink(git_hooks.get_abspath())) 40611927Sgabeblack@google.com 40711927Sgabeblack@google.com # Use a relative symlink if the hooks live in the source directory, 40811927Sgabeblack@google.com # and the hooks directory is not a symlink to an absolute path. 40911927Sgabeblack@google.com if hook.is_under(main.root) and not abs_symlink_hooks: 41011887Sandreas.sandberg@arm.com script_path = os.path.relpath( 41111928Sgabeblack@google.com os.path.realpath(script.get_abspath()), 41211928Sgabeblack@google.com os.path.realpath(hook.Dir(".").get_abspath())) 41311887Sandreas.sandberg@arm.com else: 41411887Sandreas.sandberg@arm.com script_path = script.get_abspath() 41511887Sandreas.sandberg@arm.com 41611887Sandreas.sandberg@arm.com try: 41711887Sandreas.sandberg@arm.com os.symlink(script_path, hook.get_abspath()) 41811887Sandreas.sandberg@arm.com except: 41911887Sandreas.sandberg@arm.com print "Error updating git %s hook" % hook_name 42011887Sandreas.sandberg@arm.com raise 42111887Sandreas.sandberg@arm.com 42211887Sandreas.sandberg@arm.com if hook_exists("pre-commit") and hook_exists("commit-msg"): 42311476Sandreas.sandberg@arm.com return 42411476Sandreas.sandberg@arm.com 42511408Sandreas.sandberg@arm.com print git_style_message, 42611408Sandreas.sandberg@arm.com try: 42711408Sandreas.sandberg@arm.com raw_input() 42811408Sandreas.sandberg@arm.com except: 42911408Sandreas.sandberg@arm.com print "Input exception, exiting scons.\n" 43011408Sandreas.sandberg@arm.com sys.exit(1) 43111408Sandreas.sandberg@arm.com 43211887Sandreas.sandberg@arm.com git_style_script = File("util/git-pre-commit.py") 43311887Sandreas.sandberg@arm.com git_msg_script = File("ext/git-commit-msg") 43411476Sandreas.sandberg@arm.com 43511887Sandreas.sandberg@arm.com hook_install("pre-commit", git_style_script) 43611887Sandreas.sandberg@arm.com hook_install("commit-msg", git_msg_script) 43711476Sandreas.sandberg@arm.com 43811476Sandreas.sandberg@arm.com# Try to wire up git to the style hooks 43911476Sandreas.sandberg@arm.comif not ignore_style and main.root.Entry(".git").exists(): 44011476Sandreas.sandberg@arm.com install_git_style_hooks() 4416121Snate@binkert.org 442955SN/A################################################### 443955SN/A# 4442632Sstever@eecs.umich.edu# Figure out which configurations to set up based on the path(s) of 4452632Sstever@eecs.umich.edu# the target(s). 446955SN/A# 447955SN/A################################################### 448955SN/A 449955SN/A# Find default configuration & binary. 4508878Ssteve.reinhardt@amd.comDefault(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug')) 451955SN/A 4522632Sstever@eecs.umich.edu# helper function: find last occurrence of element in list 4532632Sstever@eecs.umich.edudef rfind(l, elt, offs = -1): 4542632Sstever@eecs.umich.edu for i in range(len(l)+offs, 0, -1): 4552632Sstever@eecs.umich.edu if l[i] == elt: 4562632Sstever@eecs.umich.edu return i 4572632Sstever@eecs.umich.edu raise ValueError, "element not found" 4582632Sstever@eecs.umich.edu 4598268Ssteve.reinhardt@amd.com# Take a list of paths (or SCons Nodes) and return a list with all 4608268Ssteve.reinhardt@amd.com# paths made absolute and ~-expanded. Paths will be interpreted 4618268Ssteve.reinhardt@amd.com# relative to the launch directory unless a different root is provided 4628268Ssteve.reinhardt@amd.comdef makePathListAbsolute(path_list, root=GetLaunchDir()): 4638268Ssteve.reinhardt@amd.com return [abspath(joinpath(root, expanduser(str(p)))) 4648268Ssteve.reinhardt@amd.com for p in path_list] 4658268Ssteve.reinhardt@amd.com 4662632Sstever@eecs.umich.edu# Each target must have 'build' in the interior of the path; the 4672632Sstever@eecs.umich.edu# directory below this will determine the build parameters. For 4682632Sstever@eecs.umich.edu# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we 4692632Sstever@eecs.umich.edu# recognize that ALPHA_SE specifies the configuration because it 4708268Ssteve.reinhardt@amd.com# follow 'build' in the build path. 4712632Sstever@eecs.umich.edu 4728268Ssteve.reinhardt@amd.com# The funky assignment to "[:]" is needed to replace the list contents 4738268Ssteve.reinhardt@amd.com# in place rather than reassign the symbol to a new list, which 4748268Ssteve.reinhardt@amd.com# doesn't work (obviously!). 4758268Ssteve.reinhardt@amd.comBUILD_TARGETS[:] = makePathListAbsolute(BUILD_TARGETS) 4763718Sstever@eecs.umich.edu 4772634Sstever@eecs.umich.edu# Generate a list of the unique build roots and configs that the 4782634Sstever@eecs.umich.edu# collected targets reference. 4795863Snate@binkert.orgvariant_paths = [] 4802638Sstever@eecs.umich.edubuild_root = None 4818268Ssteve.reinhardt@amd.comfor t in BUILD_TARGETS: 4822632Sstever@eecs.umich.edu path_dirs = t.split('/') 4832632Sstever@eecs.umich.edu try: 4842632Sstever@eecs.umich.edu build_top = rfind(path_dirs, 'build', -2) 4852632Sstever@eecs.umich.edu except: 4862632Sstever@eecs.umich.edu print "Error: no non-leaf 'build' dir found on target path", t 4871858SN/A Exit(1) 4883716Sstever@eecs.umich.edu this_build_root = joinpath('/',*path_dirs[:build_top+1]) 4892638Sstever@eecs.umich.edu if not build_root: 4902638Sstever@eecs.umich.edu build_root = this_build_root 4912638Sstever@eecs.umich.edu else: 4922638Sstever@eecs.umich.edu if this_build_root != build_root: 4932638Sstever@eecs.umich.edu print "Error: build targets not under same build root\n"\ 4942638Sstever@eecs.umich.edu " %s\n %s" % (build_root, this_build_root) 4952638Sstever@eecs.umich.edu Exit(1) 4965863Snate@binkert.org variant_path = joinpath('/',*path_dirs[:build_top+2]) 4975863Snate@binkert.org if variant_path not in variant_paths: 4985863Snate@binkert.org variant_paths.append(variant_path) 499955SN/A 5005341Sstever@gmail.com# Make sure build_root exists (might not if this is the first build there) 5015341Sstever@gmail.comif not isdir(build_root): 5025863Snate@binkert.org mkdir(build_root) 5037756SAli.Saidi@ARM.commain['BUILDROOT'] = build_root 5045341Sstever@gmail.com 5056121Snate@binkert.orgExport('main') 5064494Ssaidi@eecs.umich.edu 5076121Snate@binkert.orgmain.SConsignFile(joinpath(build_root, "sconsign")) 5081105SN/A 5092667Sstever@eecs.umich.edu# Default duplicate option is to use hard links, but this messes up 5102667Sstever@eecs.umich.edu# when you use emacs to edit a file in the target dir, as emacs moves 5112667Sstever@eecs.umich.edu# file to file~ then copies to file, breaking the link. Symbolic 5122667Sstever@eecs.umich.edu# (soft) links work better. 5136121Snate@binkert.orgmain.SetOption('duplicate', 'soft-copy') 5142667Sstever@eecs.umich.edu 5155341Sstever@gmail.com# 5165863Snate@binkert.org# Set up global sticky variables... these are common to an entire build 5175341Sstever@gmail.com# tree (not specific to a particular build like ALPHA_SE) 5185341Sstever@gmail.com# 5195341Sstever@gmail.com 5208120Sgblack@eecs.umich.eduglobal_vars_file = joinpath(build_root, 'variables.global') 5215341Sstever@gmail.com 5228120Sgblack@eecs.umich.eduglobal_vars = Variables(global_vars_file, args=ARGUMENTS) 5235341Sstever@gmail.com 5248120Sgblack@eecs.umich.eduglobal_vars.AddVariables( 5256121Snate@binkert.org ('CC', 'C compiler', environ.get('CC', main['CC'])), 5266121Snate@binkert.org ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])), 5278980Ssteve.reinhardt@amd.com ('SWIG', 'SWIG tool', environ.get('SWIG', main['SWIG'])), 5289396Sandreas.hansson@arm.com ('PROTOC', 'protoc tool', environ.get('PROTOC', 'protoc')), 5295397Ssaidi@eecs.umich.edu ('BATCH', 'Use batch pool for build and tests', False), 5305397Ssaidi@eecs.umich.edu ('BATCH_CMD', 'Batch pool submission command name', 'qdo'), 5317727SAli.Saidi@ARM.com ('M5_BUILD_CACHE', 'Cache built objects in this directory', False), 5328268Ssteve.reinhardt@amd.com ('EXTRAS', 'Add extra directories to the compilation', '') 5336168Snate@binkert.org ) 5345341Sstever@gmail.com 5358120Sgblack@eecs.umich.edu# Update main environment with values from ARGUMENTS & global_vars_file 5368120Sgblack@eecs.umich.eduglobal_vars.Update(main) 5378120Sgblack@eecs.umich.eduhelp_texts["global_vars"] += global_vars.GenerateHelpText(main) 5386814Sgblack@eecs.umich.edu 5395863Snate@binkert.org# Save sticky variable settings back to current variables file 5408120Sgblack@eecs.umich.eduglobal_vars.Save(global_vars_file, main) 5415341Sstever@gmail.com 5425863Snate@binkert.org# Parse EXTRAS variable to build list of all directories where we're 5438268Ssteve.reinhardt@amd.com# look for sources etc. This list is exported as extras_dir_list. 5446121Snate@binkert.orgbase_dir = main.srcdir.abspath 5456121Snate@binkert.orgif main['EXTRAS']: 5468268Ssteve.reinhardt@amd.com extras_dir_list = makePathListAbsolute(main['EXTRAS'].split(':')) 5475742Snate@binkert.orgelse: 5485742Snate@binkert.org extras_dir_list = [] 5495341Sstever@gmail.com 5505742Snate@binkert.orgExport('base_dir') 5515742Snate@binkert.orgExport('extras_dir_list') 5525341Sstever@gmail.com 5536017Snate@binkert.org# the ext directory should be on the #includes path 5546121Snate@binkert.orgmain.Append(CPPPATH=[Dir('ext')]) 5556017Snate@binkert.org 5567816Ssteve.reinhardt@amd.comdef strip_build_path(path, env): 5577756SAli.Saidi@ARM.com path = str(path) 5587756SAli.Saidi@ARM.com variant_base = env['BUILDROOT'] + os.path.sep 5597756SAli.Saidi@ARM.com if path.startswith(variant_base): 5607756SAli.Saidi@ARM.com path = path[len(variant_base):] 5617756SAli.Saidi@ARM.com elif path.startswith('build/'): 5627756SAli.Saidi@ARM.com path = path[6:] 5637756SAli.Saidi@ARM.com return path 5647756SAli.Saidi@ARM.com 5657816Ssteve.reinhardt@amd.com# Generate a string of the form: 5667816Ssteve.reinhardt@amd.com# common/path/prefix/src1, src2 -> tgt1, tgt2 5677816Ssteve.reinhardt@amd.com# to print while building. 5687816Ssteve.reinhardt@amd.comclass Transform(object): 5697816Ssteve.reinhardt@amd.com # all specific color settings should be here and nowhere else 5707816Ssteve.reinhardt@amd.com tool_color = termcap.Normal 5717816Ssteve.reinhardt@amd.com pfx_color = termcap.Yellow 5727816Ssteve.reinhardt@amd.com srcs_color = termcap.Yellow + termcap.Bold 5737816Ssteve.reinhardt@amd.com arrow_color = termcap.Blue + termcap.Bold 5747816Ssteve.reinhardt@amd.com tgts_color = termcap.Yellow + termcap.Bold 5757756SAli.Saidi@ARM.com 5767816Ssteve.reinhardt@amd.com def __init__(self, tool, max_sources=99): 5777816Ssteve.reinhardt@amd.com self.format = self.tool_color + (" [%8s] " % tool) \ 5787816Ssteve.reinhardt@amd.com + self.pfx_color + "%s" \ 5797816Ssteve.reinhardt@amd.com + self.srcs_color + "%s" \ 5807816Ssteve.reinhardt@amd.com + self.arrow_color + " -> " \ 5817816Ssteve.reinhardt@amd.com + self.tgts_color + "%s" \ 5827816Ssteve.reinhardt@amd.com + termcap.Normal 5837816Ssteve.reinhardt@amd.com self.max_sources = max_sources 5847816Ssteve.reinhardt@amd.com 5857816Ssteve.reinhardt@amd.com def __call__(self, target, source, env, for_signature=None): 5867816Ssteve.reinhardt@amd.com # truncate source list according to max_sources param 5877816Ssteve.reinhardt@amd.com source = source[0:self.max_sources] 5887816Ssteve.reinhardt@amd.com def strip(f): 5897816Ssteve.reinhardt@amd.com return strip_build_path(str(f), env) 5907816Ssteve.reinhardt@amd.com if len(source) > 0: 5917816Ssteve.reinhardt@amd.com srcs = map(strip, source) 5927816Ssteve.reinhardt@amd.com else: 5937816Ssteve.reinhardt@amd.com srcs = [''] 5947816Ssteve.reinhardt@amd.com tgts = map(strip, target) 5957816Ssteve.reinhardt@amd.com # surprisingly, os.path.commonprefix is a dumb char-by-char string 5967816Ssteve.reinhardt@amd.com # operation that has nothing to do with paths. 5977816Ssteve.reinhardt@amd.com com_pfx = os.path.commonprefix(srcs + tgts) 5987816Ssteve.reinhardt@amd.com com_pfx_len = len(com_pfx) 5997816Ssteve.reinhardt@amd.com if com_pfx: 6007816Ssteve.reinhardt@amd.com # do some cleanup and sanity checking on common prefix 6017816Ssteve.reinhardt@amd.com if com_pfx[-1] == ".": 6027816Ssteve.reinhardt@amd.com # prefix matches all but file extension: ok 6037816Ssteve.reinhardt@amd.com # back up one to change 'foo.cc -> o' to 'foo.cc -> .o' 6047816Ssteve.reinhardt@amd.com com_pfx = com_pfx[0:-1] 6057816Ssteve.reinhardt@amd.com elif com_pfx[-1] == "/": 6067816Ssteve.reinhardt@amd.com # common prefix is directory path: OK 6077816Ssteve.reinhardt@amd.com pass 6087816Ssteve.reinhardt@amd.com else: 6097816Ssteve.reinhardt@amd.com src0_len = len(srcs[0]) 6107816Ssteve.reinhardt@amd.com tgt0_len = len(tgts[0]) 6117816Ssteve.reinhardt@amd.com if src0_len == com_pfx_len: 6127816Ssteve.reinhardt@amd.com # source is a substring of target, OK 6137816Ssteve.reinhardt@amd.com pass 6147816Ssteve.reinhardt@amd.com elif tgt0_len == com_pfx_len: 6157816Ssteve.reinhardt@amd.com # target is a substring of source, need to back up to 6167816Ssteve.reinhardt@amd.com # avoid empty string on RHS of arrow 6177816Ssteve.reinhardt@amd.com sep_idx = com_pfx.rfind(".") 6187816Ssteve.reinhardt@amd.com if sep_idx != -1: 6197816Ssteve.reinhardt@amd.com com_pfx = com_pfx[0:sep_idx] 6207816Ssteve.reinhardt@amd.com else: 6217816Ssteve.reinhardt@amd.com com_pfx = '' 6227816Ssteve.reinhardt@amd.com elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".": 6237816Ssteve.reinhardt@amd.com # still splitting at file extension: ok 6247816Ssteve.reinhardt@amd.com pass 6257816Ssteve.reinhardt@amd.com else: 6267816Ssteve.reinhardt@amd.com # probably a fluke; ignore it 6277816Ssteve.reinhardt@amd.com com_pfx = '' 6287816Ssteve.reinhardt@amd.com # recalculate length in case com_pfx was modified 6297816Ssteve.reinhardt@amd.com com_pfx_len = len(com_pfx) 6307816Ssteve.reinhardt@amd.com def fmt(files): 6317816Ssteve.reinhardt@amd.com f = map(lambda s: s[com_pfx_len:], files) 6327816Ssteve.reinhardt@amd.com return ', '.join(f) 6337816Ssteve.reinhardt@amd.com return self.format % (com_pfx, fmt(srcs), fmt(tgts)) 6347816Ssteve.reinhardt@amd.com 6357816Ssteve.reinhardt@amd.comExport('Transform') 6367816Ssteve.reinhardt@amd.com 6378947Sandreas.hansson@arm.com# enable the regression script to use the termcap 6388947Sandreas.hansson@arm.commain['TERMCAP'] = termcap 6397756SAli.Saidi@ARM.com 6408120Sgblack@eecs.umich.eduif GetOption('verbose'): 6417756SAli.Saidi@ARM.com def MakeAction(action, string, *args, **kwargs): 6427756SAli.Saidi@ARM.com return Action(action, *args, **kwargs) 6437756SAli.Saidi@ARM.comelse: 6447756SAli.Saidi@ARM.com MakeAction = Action 6457816Ssteve.reinhardt@amd.com main['CCCOMSTR'] = Transform("CC") 6467816Ssteve.reinhardt@amd.com main['CXXCOMSTR'] = Transform("CXX") 6477816Ssteve.reinhardt@amd.com main['ASCOMSTR'] = Transform("AS") 6487816Ssteve.reinhardt@amd.com main['SWIGCOMSTR'] = Transform("SWIG") 6497816Ssteve.reinhardt@amd.com main['ARCOMSTR'] = Transform("AR", 0) 6507816Ssteve.reinhardt@amd.com main['LINKCOMSTR'] = Transform("LINK", 0) 65111979Sgabeblack@google.com main['SHLINKCOMSTR'] = Transform("SHLINK", 0) 6527816Ssteve.reinhardt@amd.com main['RANLIBCOMSTR'] = Transform("RANLIB", 0) 6537816Ssteve.reinhardt@amd.com main['M4COMSTR'] = Transform("M4") 6547816Ssteve.reinhardt@amd.com main['SHCCCOMSTR'] = Transform("SHCC") 6557816Ssteve.reinhardt@amd.com main['SHCXXCOMSTR'] = Transform("SHCXX") 6567756SAli.Saidi@ARM.comExport('MakeAction') 6577756SAli.Saidi@ARM.com 6589227Sandreas.hansson@arm.com# Initialize the Link-Time Optimization (LTO) flags 6599227Sandreas.hansson@arm.commain['LTO_CCFLAGS'] = [] 6609227Sandreas.hansson@arm.commain['LTO_LDFLAGS'] = [] 6619227Sandreas.hansson@arm.com 6629590Sandreas@sandberg.pp.se# According to the readme, tcmalloc works best if the compiler doesn't 6639590Sandreas@sandberg.pp.se# assume that we're using the builtin malloc and friends. These flags 6649590Sandreas@sandberg.pp.se# are compiler-specific, so we need to set them after we detect which 6659590Sandreas@sandberg.pp.se# compiler we're using. 6669590Sandreas@sandberg.pp.semain['TCMALLOC_CCFLAGS'] = [] 6679590Sandreas@sandberg.pp.se 6686654Snate@binkert.orgCXX_version = readCommand([main['CXX'],'--version'], exception=False) 6696654Snate@binkert.orgCXX_V = readCommand([main['CXX'],'-V'], exception=False) 6705871Snate@binkert.org 6716121Snate@binkert.orgmain['GCC'] = CXX_version and CXX_version.find('g++') >= 0 6728946Sandreas.hansson@arm.commain['CLANG'] = CXX_version and CXX_version.find('clang') >= 0 6739419Sandreas.hansson@arm.comif main['GCC'] + main['CLANG'] > 1: 6743940Ssaidi@eecs.umich.edu print 'Error: How can we have two at the same time?' 6753918Ssaidi@eecs.umich.edu Exit(1) 6763918Ssaidi@eecs.umich.edu 6771858SN/A# Set up default C++ compiler flags 6789556Sandreas.hansson@arm.comif main['GCC'] or main['CLANG']: 6799556Sandreas.hansson@arm.com # As gcc and clang share many flags, do the common parts here 6809556Sandreas.hansson@arm.com main.Append(CCFLAGS=['-pipe']) 6819556Sandreas.hansson@arm.com main.Append(CCFLAGS=['-fno-strict-aliasing']) 68211294Sandreas.hansson@arm.com # Enable -Wall and -Wextra and then disable the few warnings that 68311294Sandreas.hansson@arm.com # we consistently violate 68411294Sandreas.hansson@arm.com main.Append(CCFLAGS=['-Wall', '-Wundef', '-Wextra', 68511294Sandreas.hansson@arm.com '-Wno-sign-compare', '-Wno-unused-parameter']) 68610878Sandreas.hansson@arm.com # We always compile using C++11 68710878Sandreas.hansson@arm.com main.Append(CXXFLAGS=['-std=c++11']) 68811811Sbaz21@cam.ac.uk if sys.platform.startswith('freebsd'): 68911811Sbaz21@cam.ac.uk main.Append(CCFLAGS=['-I/usr/local/include']) 69011811Sbaz21@cam.ac.uk main.Append(CXXFLAGS=['-I/usr/local/include']) 69111982Sgabeblack@google.com 69211982Sgabeblack@google.com main['FILTER_PSHLINKFLAGS'] = lambda x: str(x).replace(' -shared', '') 69311982Sgabeblack@google.com main['PSHLINKFLAGS'] = main.subst('${FILTER_PSHLINKFLAGS(SHLINKFLAGS)}') 69411982Sgabeblack@google.com main['PLINKFLAGS'] = main.subst('${LINKFLAGS}') 69511982Sgabeblack@google.com shared_partial_flags = ['-Wl,--relocatable', '-nostdlib'] 69611982Sgabeblack@google.com main.Append(PSHLINKFLAGS=shared_partial_flags) 69711982Sgabeblack@google.com main.Append(PLINKFLAGS=shared_partial_flags) 6989556Sandreas.hansson@arm.comelse: 6999556Sandreas.hansson@arm.com print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal, 7009556Sandreas.hansson@arm.com print "Don't know what compiler options to use for your compiler." 7019556Sandreas.hansson@arm.com print termcap.Yellow + ' compiler:' + termcap.Normal, main['CXX'] 7029556Sandreas.hansson@arm.com print termcap.Yellow + ' version:' + termcap.Normal, 7039556Sandreas.hansson@arm.com if not CXX_version: 7049556Sandreas.hansson@arm.com print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\ 7059556Sandreas.hansson@arm.com termcap.Normal 7069556Sandreas.hansson@arm.com else: 7079556Sandreas.hansson@arm.com print CXX_version.replace('\n', '<nl>') 7089556Sandreas.hansson@arm.com print " If you're trying to use a compiler other than GCC" 7099556Sandreas.hansson@arm.com print " or clang, there appears to be something wrong with your" 7109556Sandreas.hansson@arm.com print " environment." 7119556Sandreas.hansson@arm.com print " " 7129556Sandreas.hansson@arm.com print " If you are trying to use a compiler other than those listed" 7139556Sandreas.hansson@arm.com print " above you will need to ease fix SConstruct and " 7149556Sandreas.hansson@arm.com print " src/SConscript to support that compiler." 7159556Sandreas.hansson@arm.com Exit(1) 7169556Sandreas.hansson@arm.com 7176121Snate@binkert.orgif main['GCC']: 71811500Sandreas.hansson@arm.com # Check for a supported version of gcc. >= 4.8 is chosen for its 71910238Sandreas.hansson@arm.com # level of c++11 support. See 72010878Sandreas.hansson@arm.com # http://gcc.gnu.org/projects/cxx0x.html for details. 7219420Sandreas.hansson@arm.com gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False) 72211500Sandreas.hansson@arm.com if compareVersions(gcc_version, "4.8") < 0: 72311500Sandreas.hansson@arm.com print 'Error: gcc version 4.8 or newer required.' 7249420Sandreas.hansson@arm.com print ' Installed version:', gcc_version 7259420Sandreas.hansson@arm.com Exit(1) 7269420Sandreas.hansson@arm.com 7279420Sandreas.hansson@arm.com main['GCC_VERSION'] = gcc_version 7289420Sandreas.hansson@arm.com 72910264Sandreas.hansson@arm.com # gcc from version 4.8 and above generates "rep; ret" instructions 73010264Sandreas.hansson@arm.com # to avoid performance penalties on certain AMD chips. Older 73110264Sandreas.hansson@arm.com # assemblers detect this as an error, "Error: expecting string 73210264Sandreas.hansson@arm.com # instruction after `rep'" 73311925Sgabeblack@google.com as_version_raw = readCommand([main['AS'], '-v', '/dev/null', 73411925Sgabeblack@google.com '-o', '/dev/null'], 73511500Sandreas.hansson@arm.com exception=False).split() 73610264Sandreas.hansson@arm.com 73711500Sandreas.hansson@arm.com # version strings may contain extra distro-specific 73811500Sandreas.hansson@arm.com # qualifiers, so play it safe and keep only what comes before 73911500Sandreas.hansson@arm.com # the first hyphen 74011500Sandreas.hansson@arm.com as_version = as_version_raw[-1].split('-')[0] if as_version_raw else None 74110866Sandreas.hansson@arm.com 74211500Sandreas.hansson@arm.com if not as_version or compareVersions(as_version, "2.23") < 0: 74311500Sandreas.hansson@arm.com print termcap.Yellow + termcap.Bold + \ 74411500Sandreas.hansson@arm.com 'Warning: This combination of gcc and binutils have' + \ 74511500Sandreas.hansson@arm.com ' known incompatibilities.\n' + \ 74611500Sandreas.hansson@arm.com ' If you encounter build problems, please update ' + \ 74711500Sandreas.hansson@arm.com 'binutils to 2.23.' + \ 74811500Sandreas.hansson@arm.com termcap.Normal 74910264Sandreas.hansson@arm.com 75010457Sandreas.hansson@arm.com # Make sure we warn if the user has requested to compile with the 75110457Sandreas.hansson@arm.com # Undefined Benahvior Sanitizer and this version of gcc does not 75210457Sandreas.hansson@arm.com # support it. 75310457Sandreas.hansson@arm.com if GetOption('with_ubsan') and \ 75410457Sandreas.hansson@arm.com compareVersions(gcc_version, '4.9') < 0: 75510457Sandreas.hansson@arm.com print termcap.Yellow + termcap.Bold + \ 75610457Sandreas.hansson@arm.com 'Warning: UBSan is only supported using gcc 4.9 and later.' + \ 75710457Sandreas.hansson@arm.com termcap.Normal 75810457Sandreas.hansson@arm.com 75910238Sandreas.hansson@arm.com # Add the appropriate Link-Time Optimization (LTO) flags 76010238Sandreas.hansson@arm.com # unless LTO is explicitly turned off. Note that these flags 76110238Sandreas.hansson@arm.com # are only used by the fast target. 76210238Sandreas.hansson@arm.com if not GetOption('no_lto'): 76310238Sandreas.hansson@arm.com # Pass the LTO flag when compiling to produce GIMPLE 76410238Sandreas.hansson@arm.com # output, we merely create the flags here and only append 76510416Sandreas.hansson@arm.com # them later 76610238Sandreas.hansson@arm.com main['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')] 7679227Sandreas.hansson@arm.com 76810238Sandreas.hansson@arm.com # Use the same amount of jobs for LTO as we are running 76910416Sandreas.hansson@arm.com # scons with 77010416Sandreas.hansson@arm.com main['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs')] 7719227Sandreas.hansson@arm.com 7729590Sandreas@sandberg.pp.se main.Append(TCMALLOC_CCFLAGS=['-fno-builtin-malloc', '-fno-builtin-calloc', 7739590Sandreas@sandberg.pp.se '-fno-builtin-realloc', '-fno-builtin-free']) 7749590Sandreas@sandberg.pp.se 77511497SMatteo.Andreozzi@arm.com # add option to check for undeclared overrides 77611497SMatteo.Andreozzi@arm.com if compareVersions(gcc_version, "5.0") > 0: 77711497SMatteo.Andreozzi@arm.com main.Append(CCFLAGS=['-Wno-error=suggest-override']) 77811497SMatteo.Andreozzi@arm.com 7798737Skoansin.tan@gmail.comelif main['CLANG']: 78010878Sandreas.hansson@arm.com # Check for a supported version of clang, >= 3.1 is needed to 78111500Sandreas.hansson@arm.com # support similar features as gcc 4.8. See 7829420Sandreas.hansson@arm.com # http://clang.llvm.org/cxx_status.html for details 7838737Skoansin.tan@gmail.com clang_version_re = re.compile(".* version (\d+\.\d+)") 78410106SMitch.Hayenga@arm.com clang_version_match = clang_version_re.search(CXX_version) 7858737Skoansin.tan@gmail.com if (clang_version_match): 7868737Skoansin.tan@gmail.com clang_version = clang_version_match.groups()[0] 78710878Sandreas.hansson@arm.com if compareVersions(clang_version, "3.1") < 0: 78810878Sandreas.hansson@arm.com print 'Error: clang version 3.1 or newer required.' 7898737Skoansin.tan@gmail.com print ' Installed version:', clang_version 7908737Skoansin.tan@gmail.com Exit(1) 7918737Skoansin.tan@gmail.com else: 7928737Skoansin.tan@gmail.com print 'Error: Unable to determine clang version.' 7938737Skoansin.tan@gmail.com Exit(1) 7948737Skoansin.tan@gmail.com 79511294Sandreas.hansson@arm.com # clang has a few additional warnings that we disable, extraneous 7969556Sandreas.hansson@arm.com # parantheses are allowed due to Ruby's printing of the AST, 7979556Sandreas.hansson@arm.com # finally self assignments are allowed as the generated CPU code 7989556Sandreas.hansson@arm.com # is relying on this 79911294Sandreas.hansson@arm.com main.Append(CCFLAGS=['-Wno-parentheses', 80010278SAndreas.Sandberg@ARM.com '-Wno-self-assign', 80110278SAndreas.Sandberg@ARM.com # Some versions of libstdc++ (4.8?) seem to 80210278SAndreas.Sandberg@ARM.com # use struct hash and class hash 80310278SAndreas.Sandberg@ARM.com # interchangeably. 80410278SAndreas.Sandberg@ARM.com '-Wno-mismatched-tags', 80510278SAndreas.Sandberg@ARM.com ]) 8069556Sandreas.hansson@arm.com 8079590Sandreas@sandberg.pp.se main.Append(TCMALLOC_CCFLAGS=['-fno-builtin']) 8089590Sandreas@sandberg.pp.se 8099420Sandreas.hansson@arm.com # On Mac OS X/Darwin we need to also use libc++ (part of XCode) as 8109846Sandreas.hansson@arm.com # opposed to libstdc++, as the later is dated. 8119846Sandreas.hansson@arm.com if sys.platform == "darwin": 8129846Sandreas.hansson@arm.com main.Append(CXXFLAGS=['-stdlib=libc++']) 8139846Sandreas.hansson@arm.com main.Append(LIBS=['c++']) 8148946Sandreas.hansson@arm.com 81511811Sbaz21@cam.ac.uk # On FreeBSD we need libthr. 81611811Sbaz21@cam.ac.uk if sys.platform.startswith('freebsd'): 81711811Sbaz21@cam.ac.uk main.Append(LIBS=['thr']) 81811811Sbaz21@cam.ac.uk 8193918Ssaidi@eecs.umich.eduelse: 8209068SAli.Saidi@ARM.com print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal, 8219068SAli.Saidi@ARM.com print "Don't know what compiler options to use for your compiler." 8229068SAli.Saidi@ARM.com print termcap.Yellow + ' compiler:' + termcap.Normal, main['CXX'] 8239068SAli.Saidi@ARM.com print termcap.Yellow + ' version:' + termcap.Normal, 8249068SAli.Saidi@ARM.com if not CXX_version: 8259068SAli.Saidi@ARM.com print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\ 8269068SAli.Saidi@ARM.com termcap.Normal 8279068SAli.Saidi@ARM.com else: 8289068SAli.Saidi@ARM.com print CXX_version.replace('\n', '<nl>') 8299419Sandreas.hansson@arm.com print " If you're trying to use a compiler other than GCC" 8309068SAli.Saidi@ARM.com print " or clang, there appears to be something wrong with your" 8319068SAli.Saidi@ARM.com print " environment." 8329068SAli.Saidi@ARM.com print " " 8339068SAli.Saidi@ARM.com print " If you are trying to use a compiler other than those listed" 8349068SAli.Saidi@ARM.com print " above you will need to ease fix SConstruct and " 8359068SAli.Saidi@ARM.com print " src/SConscript to support that compiler." 8363918Ssaidi@eecs.umich.edu Exit(1) 8373918Ssaidi@eecs.umich.edu 8386157Snate@binkert.org# Set up common yacc/bison flags (needed for Ruby) 8396157Snate@binkert.orgmain['YACCFLAGS'] = '-d' 8406157Snate@binkert.orgmain['YACCHXXFILESUFFIX'] = '.hh' 8416157Snate@binkert.org 8425397Ssaidi@eecs.umich.edu# Do this after we save setting back, or else we'll tack on an 8435397Ssaidi@eecs.umich.edu# extra 'qdo' every time we run scons. 8446121Snate@binkert.orgif main['BATCH']: 8456121Snate@binkert.org main['CC'] = main['BATCH_CMD'] + ' ' + main['CC'] 8466121Snate@binkert.org main['CXX'] = main['BATCH_CMD'] + ' ' + main['CXX'] 8476121Snate@binkert.org main['AS'] = main['BATCH_CMD'] + ' ' + main['AS'] 8486121Snate@binkert.org main['AR'] = main['BATCH_CMD'] + ' ' + main['AR'] 8496121Snate@binkert.org main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB'] 8505397Ssaidi@eecs.umich.edu 8511851SN/Aif sys.platform == 'cygwin': 8521851SN/A # cygwin has some header file issues... 8537739Sgblack@eecs.umich.edu main.Append(CCFLAGS=["-Wno-uninitialized"]) 854955SN/A 8559396Sandreas.hansson@arm.com# Check for the protobuf compiler 8569396Sandreas.hansson@arm.comprotoc_version = readCommand([main['PROTOC'], '--version'], 8579396Sandreas.hansson@arm.com exception='').split() 8589396Sandreas.hansson@arm.com 8599396Sandreas.hansson@arm.com# First two words should be "libprotoc x.y.z" 8609396Sandreas.hansson@arm.comif len(protoc_version) < 2 or protoc_version[0] != 'libprotoc': 8619396Sandreas.hansson@arm.com print termcap.Yellow + termcap.Bold + \ 8629396Sandreas.hansson@arm.com 'Warning: Protocol buffer compiler (protoc) not found.\n' + \ 8639396Sandreas.hansson@arm.com ' Please install protobuf-compiler for tracing support.' + \ 8649396Sandreas.hansson@arm.com termcap.Normal 8659396Sandreas.hansson@arm.com main['PROTOC'] = False 8669396Sandreas.hansson@arm.comelse: 8679396Sandreas.hansson@arm.com # Based on the availability of the compress stream wrappers, 8689396Sandreas.hansson@arm.com # require 2.1.0 8699396Sandreas.hansson@arm.com min_protoc_version = '2.1.0' 8709396Sandreas.hansson@arm.com if compareVersions(protoc_version[1], min_protoc_version) < 0: 8719477Sandreas.hansson@arm.com print termcap.Yellow + termcap.Bold + \ 8729477Sandreas.hansson@arm.com 'Warning: protoc version', min_protoc_version, \ 8739477Sandreas.hansson@arm.com 'or newer required.\n' + \ 8749477Sandreas.hansson@arm.com ' Installed version:', protoc_version[1], \ 8759477Sandreas.hansson@arm.com termcap.Normal 8769477Sandreas.hansson@arm.com main['PROTOC'] = False 8779477Sandreas.hansson@arm.com else: 8789477Sandreas.hansson@arm.com # Attempt to determine the appropriate include path and 8799477Sandreas.hansson@arm.com # library path using pkg-config, that means we also need to 8809477Sandreas.hansson@arm.com # check for pkg-config. Note that it is possible to use 8819477Sandreas.hansson@arm.com # protobuf without the involvement of pkg-config. Later on we 8829477Sandreas.hansson@arm.com # check go a library config check and at that point the test 8839477Sandreas.hansson@arm.com # will fail if libprotobuf cannot be found. 8849477Sandreas.hansson@arm.com if readCommand(['pkg-config', '--version'], exception=''): 8859477Sandreas.hansson@arm.com try: 8869477Sandreas.hansson@arm.com # Attempt to establish what linking flags to add for protobuf 8879477Sandreas.hansson@arm.com # using pkg-config 8889477Sandreas.hansson@arm.com main.ParseConfig('pkg-config --cflags --libs-only-L protobuf') 8899477Sandreas.hansson@arm.com except: 8909477Sandreas.hansson@arm.com print termcap.Yellow + termcap.Bold + \ 8919477Sandreas.hansson@arm.com 'Warning: pkg-config could not get protobuf flags.' + \ 8929477Sandreas.hansson@arm.com termcap.Normal 8939396Sandreas.hansson@arm.com 8943053Sstever@eecs.umich.edu# Check for SWIG 8956121Snate@binkert.orgif not main.has_key('SWIG'): 8963053Sstever@eecs.umich.edu print 'Error: SWIG utility not found.' 8973053Sstever@eecs.umich.edu print ' Please install (see http://www.swig.org) and retry.' 8983053Sstever@eecs.umich.edu Exit(1) 8993053Sstever@eecs.umich.edu 9003053Sstever@eecs.umich.edu# Check for appropriate SWIG version 9019072Sandreas.hansson@arm.comswig_version = readCommand([main['SWIG'], '-version'], exception='').split() 9023053Sstever@eecs.umich.edu# First 3 words should be "SWIG Version x.y.z" 9034742Sstever@eecs.umich.eduif len(swig_version) < 3 or \ 9044742Sstever@eecs.umich.edu swig_version[0] != 'SWIG' or swig_version[1] != 'Version': 9053053Sstever@eecs.umich.edu print 'Error determining SWIG version.' 9063053Sstever@eecs.umich.edu Exit(1) 9073053Sstever@eecs.umich.edu 90810181SCurtis.Dunham@arm.commin_swig_version = '2.0.4' 9096654Snate@binkert.orgif compareVersions(swig_version[2], min_swig_version) < 0: 9103053Sstever@eecs.umich.edu print 'Error: SWIG version', min_swig_version, 'or newer required.' 9113053Sstever@eecs.umich.edu print ' Installed version:', swig_version[2] 9123053Sstever@eecs.umich.edu Exit(1) 9133053Sstever@eecs.umich.edu 91410425Sandreas.hansson@arm.com# Check for known incompatibilities. The standard library shipped with 91510425Sandreas.hansson@arm.com# gcc >= 4.9 does not play well with swig versions prior to 3.0 91610425Sandreas.hansson@arm.comif main['GCC'] and compareVersions(gcc_version, '4.9') >= 0 and \ 91710425Sandreas.hansson@arm.com compareVersions(swig_version[2], '3.0') < 0: 91810425Sandreas.hansson@arm.com print termcap.Yellow + termcap.Bold + \ 91910425Sandreas.hansson@arm.com 'Warning: This combination of gcc and swig have' + \ 92010425Sandreas.hansson@arm.com ' known incompatibilities.\n' + \ 92110425Sandreas.hansson@arm.com ' If you encounter build problems, please update ' + \ 92210425Sandreas.hansson@arm.com 'swig to 3.0 or later.' + \ 92310425Sandreas.hansson@arm.com termcap.Normal 92410425Sandreas.hansson@arm.com 9252667Sstever@eecs.umich.edu# Set up SWIG flags & scanner 9264554Sbinkertn@umich.eduswig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS') 9276121Snate@binkert.orgmain.Append(SWIGFLAGS=swig_flags) 9282667Sstever@eecs.umich.edu 92910710Sandreas.hansson@arm.com# Check for 'timeout' from GNU coreutils. If present, regressions will 93010710Sandreas.hansson@arm.com# be run with a time limit. We require version 8.13 since we rely on 93110710Sandreas.hansson@arm.com# support for the '--foreground' option. 93211811Sbaz21@cam.ac.ukif sys.platform.startswith('freebsd'): 93311811Sbaz21@cam.ac.uk timeout_lines = readCommand(['gtimeout', '--version'], 93411811Sbaz21@cam.ac.uk exception='').splitlines() 93511811Sbaz21@cam.ac.ukelse: 93611811Sbaz21@cam.ac.uk timeout_lines = readCommand(['timeout', '--version'], 93711811Sbaz21@cam.ac.uk exception='').splitlines() 93810710Sandreas.hansson@arm.com# Get the first line and tokenize it 93910710Sandreas.hansson@arm.comtimeout_version = timeout_lines[0].split() if timeout_lines else [] 94010710Sandreas.hansson@arm.commain['TIMEOUT'] = timeout_version and \ 94110710Sandreas.hansson@arm.com compareVersions(timeout_version[-1], '8.13') >= 0 94210384SCurtis.Dunham@arm.com 9434554Sbinkertn@umich.edu# filter out all existing swig scanners, they mess up the dependency 9444554Sbinkertn@umich.edu# stuff for some reason 9454554Sbinkertn@umich.eduscanners = [] 9466121Snate@binkert.orgfor scanner in main['SCANNERS']: 9474554Sbinkertn@umich.edu skeys = scanner.skeys 9484554Sbinkertn@umich.edu if skeys == '.i': 9494554Sbinkertn@umich.edu continue 9504781Snate@binkert.org 9514554Sbinkertn@umich.edu if isinstance(skeys, (list, tuple)) and '.i' in skeys: 9524554Sbinkertn@umich.edu continue 9532667Sstever@eecs.umich.edu 9544554Sbinkertn@umich.edu scanners.append(scanner) 9554554Sbinkertn@umich.edu 9564554Sbinkertn@umich.edu# add the new swig scanner that we like better 9574554Sbinkertn@umich.edufrom SCons.Scanner import ClassicCPP as CPPScanner 9582667Sstever@eecs.umich.eduswig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")' 9594554Sbinkertn@umich.eduscanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re)) 9602667Sstever@eecs.umich.edu 9614554Sbinkertn@umich.edu# replace the scanners list that has what we want 9626121Snate@binkert.orgmain['SCANNERS'] = scanners 9632667Sstever@eecs.umich.edu 9649986Sandreas@sandberg.pp.se# Add a custom Check function to test for structure members. 9659986Sandreas@sandberg.pp.sedef CheckMember(context, include, decl, member, include_quotes="<>"): 9669986Sandreas@sandberg.pp.se context.Message("Checking for member %s in %s..." % 9679986Sandreas@sandberg.pp.se (member, decl)) 9689986Sandreas@sandberg.pp.se text = """ 9699986Sandreas@sandberg.pp.se#include %(header)s 9709986Sandreas@sandberg.pp.seint main(){ 9719986Sandreas@sandberg.pp.se %(decl)s test; 9729986Sandreas@sandberg.pp.se (void)test.%(member)s; 9739986Sandreas@sandberg.pp.se return 0; 9749986Sandreas@sandberg.pp.se}; 9759986Sandreas@sandberg.pp.se""" % { "header" : include_quotes[0] + include + include_quotes[1], 9769986Sandreas@sandberg.pp.se "decl" : decl, 9779986Sandreas@sandberg.pp.se "member" : member, 9789986Sandreas@sandberg.pp.se } 9799986Sandreas@sandberg.pp.se 9809986Sandreas@sandberg.pp.se ret = context.TryCompile(text, extension=".cc") 9819986Sandreas@sandberg.pp.se context.Result(ret) 9829986Sandreas@sandberg.pp.se return ret 9839986Sandreas@sandberg.pp.se 9842638Sstever@eecs.umich.edu# Platform-specific configuration. Note again that we assume that all 9852638Sstever@eecs.umich.edu# builds under a given build root run on the same host platform. 9866121Snate@binkert.orgconf = Configure(main, 9873716Sstever@eecs.umich.edu conf_dir = joinpath(build_root, '.scons_config'), 9885522Snate@binkert.org log_file = joinpath(build_root, 'scons_config.log'), 9899986Sandreas@sandberg.pp.se custom_tests = { 9909986Sandreas@sandberg.pp.se 'CheckMember' : CheckMember, 9919986Sandreas@sandberg.pp.se }) 9925522Snate@binkert.org 9935227Ssaidi@eecs.umich.edu# Check if we should compile a 64 bit binary on Mac OS X/Darwin 9945227Ssaidi@eecs.umich.edutry: 9955227Ssaidi@eecs.umich.edu import platform 9965227Ssaidi@eecs.umich.edu uname = platform.uname() 9976654Snate@binkert.org if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0: 9986654Snate@binkert.org if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]): 9997769SAli.Saidi@ARM.com main.Append(CCFLAGS=['-arch', 'x86_64']) 10007769SAli.Saidi@ARM.com main.Append(CFLAGS=['-arch', 'x86_64']) 10017769SAli.Saidi@ARM.com main.Append(LINKFLAGS=['-arch', 'x86_64']) 10027769SAli.Saidi@ARM.com main.Append(ASFLAGS=['-arch', 'x86_64']) 10035227Ssaidi@eecs.umich.eduexcept: 10045227Ssaidi@eecs.umich.edu pass 10055227Ssaidi@eecs.umich.edu 10065204Sstever@gmail.com# Recent versions of scons substitute a "Null" object for Configure() 10075204Sstever@gmail.com# when configuration isn't necessary, e.g., if the "--help" option is 10085204Sstever@gmail.com# present. Unfortuantely this Null object always returns false, 10095204Sstever@gmail.com# breaking all our configuration checks. We replace it with our own 10105204Sstever@gmail.com# more optimistic null object that returns True instead. 10115204Sstever@gmail.comif not conf: 10125204Sstever@gmail.com def NullCheck(*args, **kwargs): 10135204Sstever@gmail.com return True 10145204Sstever@gmail.com 10155204Sstever@gmail.com class NullConf: 10165204Sstever@gmail.com def __init__(self, env): 10175204Sstever@gmail.com self.env = env 10185204Sstever@gmail.com def Finish(self): 10195204Sstever@gmail.com return self.env 10205204Sstever@gmail.com def __getattr__(self, mname): 10215204Sstever@gmail.com return NullCheck 10225204Sstever@gmail.com 10236121Snate@binkert.org conf = NullConf(main) 10245204Sstever@gmail.com 10257727SAli.Saidi@ARM.com# Cache build files in the supplied directory. 10267727SAli.Saidi@ARM.comif main['M5_BUILD_CACHE']: 10277727SAli.Saidi@ARM.com print 'Using build cache located at', main['M5_BUILD_CACHE'] 10287727SAli.Saidi@ARM.com CacheDir(main['M5_BUILD_CACHE']) 10297727SAli.Saidi@ARM.com 103011988Sandreas.sandberg@arm.commain['USE_PYTHON'] = not GetOption('without_python') 103111988Sandreas.sandberg@arm.comif main['USE_PYTHON']: 103210453SAndrew.Bardsley@arm.com # Find Python include and library directories for embedding the 103310453SAndrew.Bardsley@arm.com # interpreter. We rely on python-config to resolve the appropriate 103410453SAndrew.Bardsley@arm.com # includes and linker flags. ParseConfig does not seem to understand 103510453SAndrew.Bardsley@arm.com # the more exotic linker flags such as -Xlinker and -export-dynamic so 103610453SAndrew.Bardsley@arm.com # we add them explicitly below. If you want to link in an alternate 103710453SAndrew.Bardsley@arm.com # version of python, see above for instructions on how to invoke 103810453SAndrew.Bardsley@arm.com # scons with the appropriate PATH set. 103910453SAndrew.Bardsley@arm.com # 104010453SAndrew.Bardsley@arm.com # First we check if python2-config exists, else we use python-config 104110453SAndrew.Bardsley@arm.com python_config = readCommand(['which', 'python2-config'], 104210160Sandreas.hansson@arm.com exception='').strip() 104310453SAndrew.Bardsley@arm.com if not os.path.exists(python_config): 104410453SAndrew.Bardsley@arm.com python_config = readCommand(['which', 'python-config'], 104510453SAndrew.Bardsley@arm.com exception='').strip() 104610453SAndrew.Bardsley@arm.com py_includes = readCommand([python_config, '--includes'], 104710453SAndrew.Bardsley@arm.com exception='').split() 104810453SAndrew.Bardsley@arm.com # Strip the -I from the include folders before adding them to the 104910453SAndrew.Bardsley@arm.com # CPPPATH 105010453SAndrew.Bardsley@arm.com main.Append(CPPPATH=map(lambda inc: inc[2:], py_includes)) 10519812Sandreas.hansson@arm.com 105210453SAndrew.Bardsley@arm.com # Read the linker flags and split them into libraries and other link 105310453SAndrew.Bardsley@arm.com # flags. The libraries are added later through the call the CheckLib. 105410453SAndrew.Bardsley@arm.com py_ld_flags = readCommand([python_config, '--ldflags'], 105510453SAndrew.Bardsley@arm.com exception='').split() 105610453SAndrew.Bardsley@arm.com py_libs = [] 105710453SAndrew.Bardsley@arm.com for lib in py_ld_flags: 105810453SAndrew.Bardsley@arm.com if not lib.startswith('-l'): 105910453SAndrew.Bardsley@arm.com main.Append(LINKFLAGS=[lib]) 106010453SAndrew.Bardsley@arm.com else: 106110453SAndrew.Bardsley@arm.com lib = lib[2:] 106210453SAndrew.Bardsley@arm.com if lib not in py_libs: 106310453SAndrew.Bardsley@arm.com py_libs.append(lib) 10647727SAli.Saidi@ARM.com 106510453SAndrew.Bardsley@arm.com # verify that this stuff works 106610453SAndrew.Bardsley@arm.com if not conf.CheckHeader('Python.h', '<>'): 106710453SAndrew.Bardsley@arm.com print "Error: can't find Python.h header in", py_includes 106810453SAndrew.Bardsley@arm.com print "Install Python headers (package python-dev on Ubuntu and RedHat)" 106910453SAndrew.Bardsley@arm.com Exit(1) 10703118Sstever@eecs.umich.edu 107110453SAndrew.Bardsley@arm.com for lib in py_libs: 107210453SAndrew.Bardsley@arm.com if not conf.CheckLib(lib): 107310453SAndrew.Bardsley@arm.com print "Error: can't find library %s required by python" % lib 107410453SAndrew.Bardsley@arm.com Exit(1) 10753118Sstever@eecs.umich.edu 10763483Ssaidi@eecs.umich.edu# On Solaris you need to use libsocket for socket ops 10773494Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'): 10783494Ssaidi@eecs.umich.edu if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'): 10793483Ssaidi@eecs.umich.edu print "Can't find library with socket calls (e.g. accept())" 10803483Ssaidi@eecs.umich.edu Exit(1) 10813483Ssaidi@eecs.umich.edu 10823053Sstever@eecs.umich.edu# Check for zlib. If the check passes, libz will be automatically 10833053Sstever@eecs.umich.edu# added to the LIBS environment variable. 10843918Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'): 10853053Sstever@eecs.umich.edu print 'Error: did not find needed zlib compression library '\ 10863053Sstever@eecs.umich.edu 'and/or zlib.h header file.' 10873053Sstever@eecs.umich.edu print ' Please install zlib and try again.' 10883053Sstever@eecs.umich.edu Exit(1) 10893053Sstever@eecs.umich.edu 10909396Sandreas.hansson@arm.com# If we have the protobuf compiler, also make sure we have the 10919396Sandreas.hansson@arm.com# development libraries. If the check passes, libprotobuf will be 10929396Sandreas.hansson@arm.com# automatically added to the LIBS environment variable. After 10939396Sandreas.hansson@arm.com# this, we can use the HAVE_PROTOBUF flag to determine if we have 10949396Sandreas.hansson@arm.com# got both protoc and libprotobuf available. 10959396Sandreas.hansson@arm.commain['HAVE_PROTOBUF'] = main['PROTOC'] and \ 10969396Sandreas.hansson@arm.com conf.CheckLibWithHeader('protobuf', 'google/protobuf/message.h', 10979396Sandreas.hansson@arm.com 'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;') 10989396Sandreas.hansson@arm.com 10999477Sandreas.hansson@arm.com# If we have the compiler but not the library, print another warning. 11009396Sandreas.hansson@arm.comif main['PROTOC'] and not main['HAVE_PROTOBUF']: 11019477Sandreas.hansson@arm.com print termcap.Yellow + termcap.Bold + \ 11029477Sandreas.hansson@arm.com 'Warning: did not find protocol buffer library and/or headers.\n' + \ 11039477Sandreas.hansson@arm.com ' Please install libprotobuf-dev for tracing support.' + \ 11049477Sandreas.hansson@arm.com termcap.Normal 11059396Sandreas.hansson@arm.com 11067840Snate@binkert.org# Check for librt. 11077865Sgblack@eecs.umich.eduhave_posix_clock = \ 11087865Sgblack@eecs.umich.edu conf.CheckLibWithHeader(None, 'time.h', 'C', 11097865Sgblack@eecs.umich.edu 'clock_nanosleep(0,0,NULL,NULL);') or \ 11107865Sgblack@eecs.umich.edu conf.CheckLibWithHeader('rt', 'time.h', 'C', 11117865Sgblack@eecs.umich.edu 'clock_nanosleep(0,0,NULL,NULL);') 11127840Snate@binkert.org 11139900Sandreas@sandberg.pp.sehave_posix_timers = \ 11149900Sandreas@sandberg.pp.se conf.CheckLibWithHeader([None, 'rt'], [ 'time.h', 'signal.h' ], 'C', 11159900Sandreas@sandberg.pp.se 'timer_create(CLOCK_MONOTONIC, NULL, NULL);') 11169900Sandreas@sandberg.pp.se 111710456SCurtis.Dunham@arm.comif not GetOption('without_tcmalloc'): 111810456SCurtis.Dunham@arm.com if conf.CheckLib('tcmalloc'): 111910456SCurtis.Dunham@arm.com main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS']) 112010456SCurtis.Dunham@arm.com elif conf.CheckLib('tcmalloc_minimal'): 112110456SCurtis.Dunham@arm.com main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS']) 112210456SCurtis.Dunham@arm.com else: 112310456SCurtis.Dunham@arm.com print termcap.Yellow + termcap.Bold + \ 112410456SCurtis.Dunham@arm.com "You can get a 12% performance improvement by "\ 112510456SCurtis.Dunham@arm.com "installing tcmalloc (libgoogle-perftools-dev package "\ 112610456SCurtis.Dunham@arm.com "on Ubuntu or RedHat)." + termcap.Normal 11279045SAli.Saidi@ARM.com 112811235Sandreas.sandberg@arm.com 112911235Sandreas.sandberg@arm.com# Detect back trace implementations. The last implementation in the 113011235Sandreas.sandberg@arm.com# list will be used by default. 113111235Sandreas.sandberg@arm.combacktrace_impls = [ "none" ] 113211235Sandreas.sandberg@arm.com 113311235Sandreas.sandberg@arm.comif conf.CheckLibWithHeader(None, 'execinfo.h', 'C', 113411235Sandreas.sandberg@arm.com 'backtrace_symbols_fd((void*)0, 0, 0);'): 113511235Sandreas.sandberg@arm.com backtrace_impls.append("glibc") 113611811Sbaz21@cam.ac.ukelif conf.CheckLibWithHeader('execinfo', 'execinfo.h', 'C', 113711811Sbaz21@cam.ac.uk 'backtrace_symbols_fd((void*)0, 0, 0);'): 113811811Sbaz21@cam.ac.uk # NetBSD and FreeBSD need libexecinfo. 113911811Sbaz21@cam.ac.uk backtrace_impls.append("glibc") 114011811Sbaz21@cam.ac.uk main.Append(LIBS=['execinfo']) 114111235Sandreas.sandberg@arm.com 114211235Sandreas.sandberg@arm.comif backtrace_impls[-1] == "none": 114311235Sandreas.sandberg@arm.com default_backtrace_impl = "none" 114411235Sandreas.sandberg@arm.com print termcap.Yellow + termcap.Bold + \ 114511235Sandreas.sandberg@arm.com "No suitable back trace implementation found." + \ 114611235Sandreas.sandberg@arm.com termcap.Normal 114711235Sandreas.sandberg@arm.com 11487840Snate@binkert.orgif not have_posix_clock: 11497840Snate@binkert.org print "Can't find library for POSIX clocks." 11507840Snate@binkert.org 11511858SN/A# Check for <fenv.h> (C99 FP environment control) 11521858SN/Ahave_fenv = conf.CheckHeader('fenv.h', '<>') 11531858SN/Aif not have_fenv: 11541858SN/A print "Warning: Header file <fenv.h> not found." 11551858SN/A print " This host has no IEEE FP rounding mode control." 11561858SN/A 11579903Sandreas.hansson@arm.com# Check if we should enable KVM-based hardware virtualization. The API 11589903Sandreas.hansson@arm.com# we rely on exists since version 2.6.36 of the kernel, but somehow 11599903Sandreas.hansson@arm.com# the KVM_API_VERSION does not reflect the change. We test for one of 11609903Sandreas.hansson@arm.com# the types as a fall back. 116110841Sandreas.sandberg@arm.comhave_kvm = conf.CheckHeader('linux/kvm.h', '<>') 11629651SAndreas.Sandberg@ARM.comif not have_kvm: 11639903Sandreas.hansson@arm.com print "Info: Compatible header file <linux/kvm.h> not found, " \ 11649651SAndreas.Sandberg@ARM.com "disabling KVM support." 11659651SAndreas.Sandberg@ARM.com 116610841Sandreas.sandberg@arm.com# x86 needs support for xsave. We test for the structure here since we 116710841Sandreas.sandberg@arm.com# won't be able to run new tests by the time we know which ISA we're 116810841Sandreas.sandberg@arm.com# targeting. 116910841Sandreas.sandberg@arm.comhave_kvm_xsave = conf.CheckTypeSize('struct kvm_xsave', 117010841Sandreas.sandberg@arm.com '#include <linux/kvm.h>') != 0 117110841Sandreas.sandberg@arm.com 11729651SAndreas.Sandberg@ARM.com# Check if the requested target ISA is compatible with the host 11739651SAndreas.Sandberg@ARM.comdef is_isa_kvm_compatible(isa): 11749651SAndreas.Sandberg@ARM.com try: 11759651SAndreas.Sandberg@ARM.com import platform 11769651SAndreas.Sandberg@ARM.com host_isa = platform.machine() 11779651SAndreas.Sandberg@ARM.com except: 11789651SAndreas.Sandberg@ARM.com print "Warning: Failed to determine host ISA." 11799651SAndreas.Sandberg@ARM.com return False 11809651SAndreas.Sandberg@ARM.com 118110841Sandreas.sandberg@arm.com if not have_posix_timers: 118210841Sandreas.sandberg@arm.com print "Warning: Can not enable KVM, host seems to lack support " \ 118310841Sandreas.sandberg@arm.com "for POSIX timers" 118410841Sandreas.sandberg@arm.com return False 118510841Sandreas.sandberg@arm.com 118610841Sandreas.sandberg@arm.com if isa == "arm": 118710860Sandreas.sandberg@arm.com return host_isa in ( "armv7l", "aarch64" ) 118810841Sandreas.sandberg@arm.com elif isa == "x86": 118910841Sandreas.sandberg@arm.com if host_isa != "x86_64": 119010841Sandreas.sandberg@arm.com return False 119110841Sandreas.sandberg@arm.com 119210841Sandreas.sandberg@arm.com if not have_kvm_xsave: 119310841Sandreas.sandberg@arm.com print "KVM on x86 requires xsave support in kernel headers." 119410841Sandreas.sandberg@arm.com return False 119510841Sandreas.sandberg@arm.com 119610841Sandreas.sandberg@arm.com return True 119710841Sandreas.sandberg@arm.com else: 119810841Sandreas.sandberg@arm.com return False 11999651SAndreas.Sandberg@ARM.com 12009651SAndreas.Sandberg@ARM.com 12019986Sandreas@sandberg.pp.se# Check if the exclude_host attribute is available. We want this to 12029986Sandreas@sandberg.pp.se# get accurate instruction counts in KVM. 12039986Sandreas@sandberg.pp.semain['HAVE_PERF_ATTR_EXCLUDE_HOST'] = conf.CheckMember( 12049986Sandreas@sandberg.pp.se 'linux/perf_event.h', 'struct perf_event_attr', 'exclude_host') 12059986Sandreas@sandberg.pp.se 12069986Sandreas@sandberg.pp.se 12075863Snate@binkert.org###################################################################### 12085863Snate@binkert.org# 12095863Snate@binkert.org# Finish the configuration 12105863Snate@binkert.org# 12116121Snate@binkert.orgmain = conf.Finish() 12121858SN/A 12135863Snate@binkert.org###################################################################### 12145863Snate@binkert.org# 12155863Snate@binkert.org# Collect all non-global variables 12165863Snate@binkert.org# 12175863Snate@binkert.org 12182139SN/A# Define the universe of supported ISAs 12194202Sbinkertn@umich.eduall_isa_list = [ ] 122011308Santhony.gutierrez@amd.comall_gpu_isa_list = [ ] 12214202Sbinkertn@umich.eduExport('all_isa_list') 122211308Santhony.gutierrez@amd.comExport('all_gpu_isa_list') 12232139SN/A 12246994Snate@binkert.orgclass CpuModel(object): 12256994Snate@binkert.org '''The CpuModel class encapsulates everything the ISA parser needs to 12266994Snate@binkert.org know about a particular CPU model.''' 12276994Snate@binkert.org 12286994Snate@binkert.org # Dict of available CPU model objects. Accessible as CpuModel.dict. 12296994Snate@binkert.org dict = {} 12306994Snate@binkert.org 12316994Snate@binkert.org # Constructor. Automatically adds models to CpuModel.dict. 123210319SAndreas.Sandberg@ARM.com def __init__(self, name, default=False): 12336994Snate@binkert.org self.name = name # name of model 12346994Snate@binkert.org 12356994Snate@binkert.org # This cpu is enabled by default 12366994Snate@binkert.org self.default = default 12376994Snate@binkert.org 12386994Snate@binkert.org # Add self to dict 12396994Snate@binkert.org if name in CpuModel.dict: 12406994Snate@binkert.org raise AttributeError, "CpuModel '%s' already registered" % name 12416994Snate@binkert.org CpuModel.dict[name] = self 12426994Snate@binkert.org 12436994Snate@binkert.orgExport('CpuModel') 12442155SN/A 12455863Snate@binkert.org# Sticky variables get saved in the variables file so they persist from 12461869SN/A# one invocation to the next (unless overridden, in which case the new 12471869SN/A# value becomes sticky). 12485863Snate@binkert.orgsticky_vars = Variables(args=ARGUMENTS) 12495863Snate@binkert.orgExport('sticky_vars') 12504202Sbinkertn@umich.edu 12516108Snate@binkert.org# Sticky variables that should be exported 12526108Snate@binkert.orgexport_vars = [] 12536108Snate@binkert.orgExport('export_vars') 12546108Snate@binkert.org 12559219Spower.jg@gmail.com# For Ruby 12569219Spower.jg@gmail.comall_protocols = [] 12579219Spower.jg@gmail.comExport('all_protocols') 12589219Spower.jg@gmail.comprotocol_dirs = [] 12599219Spower.jg@gmail.comExport('protocol_dirs') 12609219Spower.jg@gmail.comslicc_includes = [] 12619219Spower.jg@gmail.comExport('slicc_includes') 12629219Spower.jg@gmail.com 12634202Sbinkertn@umich.edu# Walk the tree and execute all SConsopts scripts that wil add to the 12645863Snate@binkert.org# above variables 126510135SCurtis.Dunham@arm.comif GetOption('verbose'): 12668474Sgblack@eecs.umich.edu print "Reading SConsopts" 12675742Snate@binkert.orgfor bdir in [ base_dir ] + extras_dir_list: 12688268Ssteve.reinhardt@amd.com if not isdir(bdir): 12698268Ssteve.reinhardt@amd.com print "Error: directory '%s' does not exist" % bdir 12708268Ssteve.reinhardt@amd.com Exit(1) 12715742Snate@binkert.org for root, dirs, files in os.walk(bdir): 12725341Sstever@gmail.com if 'SConsopts' in files: 12738474Sgblack@eecs.umich.edu if GetOption('verbose'): 12748474Sgblack@eecs.umich.edu print "Reading", joinpath(root, 'SConsopts') 12755342Sstever@gmail.com SConscript(joinpath(root, 'SConsopts')) 12764202Sbinkertn@umich.edu 12774202Sbinkertn@umich.eduall_isa_list.sort() 127811308Santhony.gutierrez@amd.comall_gpu_isa_list.sort() 12794202Sbinkertn@umich.edu 12805863Snate@binkert.orgsticky_vars.AddVariables( 12815863Snate@binkert.org EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list), 128211308Santhony.gutierrez@amd.com EnumVariable('TARGET_GPU_ISA', 'Target GPU ISA', 'hsail', all_gpu_isa_list), 12836994Snate@binkert.org ListVariable('CPU_MODELS', 'CPU models', 12846994Snate@binkert.org sorted(n for n,m in CpuModel.dict.iteritems() if m.default), 128510319SAndreas.Sandberg@ARM.com sorted(CpuModel.dict.keys())), 12865863Snate@binkert.org BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger', 12875863Snate@binkert.org False), 12885863Snate@binkert.org BoolVariable('SS_COMPATIBLE_FP', 12895863Snate@binkert.org 'Make floating-point results compatible with SimpleScalar', 12905863Snate@binkert.org False), 12915863Snate@binkert.org BoolVariable('USE_SSE2', 12925863Snate@binkert.org 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts', 12935863Snate@binkert.org False), 12947840Snate@binkert.org BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock), 12955863Snate@binkert.org BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv), 12965952Ssaidi@eecs.umich.edu BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False), 12979651SAndreas.Sandberg@ARM.com BoolVariable('USE_KVM', 'Enable hardware virtualized (KVM) CPU models', have_kvm), 129811308Santhony.gutierrez@amd.com BoolVariable('BUILD_GPU', 'Build the compute-GPU model', False), 12999219Spower.jg@gmail.com EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None', 13009219Spower.jg@gmail.com all_protocols), 130111235Sandreas.sandberg@arm.com EnumVariable('BACKTRACE_IMPL', 'Post-mortem dump implementation', 130211235Sandreas.sandberg@arm.com backtrace_impls[-1], backtrace_impls) 13031869SN/A ) 13041858SN/A 13055863Snate@binkert.org# These variables get exported to #defines in config/*.hh (see src/SConscript). 130611308Santhony.gutierrez@amd.comexport_vars += ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'TARGET_GPU_ISA', 130711308Santhony.gutierrez@amd.com 'CP_ANNOTATE', 'USE_POSIX_CLOCK', 'USE_KVM', 'PROTOCOL', 130811308Santhony.gutierrez@amd.com 'HAVE_PROTOBUF', 'HAVE_PERF_ATTR_EXCLUDE_HOST'] 13091858SN/A 1310955SN/A################################################### 1311955SN/A# 13121869SN/A# Define a SCons builder for configuration flag headers. 13131869SN/A# 13141869SN/A################################################### 13151869SN/A 13161869SN/A# This function generates a config header file that #defines the 13175863Snate@binkert.org# variable symbol to the current variable setting (0 or 1). The source 13185863Snate@binkert.org# operands are the name of the variable and a Value node containing the 13195863Snate@binkert.org# value of the variable. 13201869SN/Adef build_config_file(target, source, env): 13215863Snate@binkert.org (variable, value) = [s.get_contents() for s in source] 13221869SN/A f = file(str(target[0]), 'w') 13235863Snate@binkert.org print >> f, '#define', variable, value 13241869SN/A f.close() 13251869SN/A return None 13261869SN/A 13271869SN/A# Combine the two functions into a scons Action object. 13288483Sgblack@eecs.umich.educonfig_action = MakeAction(build_config_file, Transform("CONFIG H", 2)) 13291869SN/A 13301869SN/A# The emitter munges the source & target node lists to reflect what 13311869SN/A# we're really doing. 13321869SN/Adef config_emitter(target, source, env): 13335863Snate@binkert.org # extract variable name from Builder arg 13345863Snate@binkert.org variable = str(target[0]) 13351869SN/A # True target is config header file 13365863Snate@binkert.org target = joinpath('config', variable.lower() + '.hh') 13375863Snate@binkert.org val = env[variable] 13383356Sbinkertn@umich.edu if isinstance(val, bool): 13393356Sbinkertn@umich.edu # Force value to 0/1 13403356Sbinkertn@umich.edu val = int(val) 13413356Sbinkertn@umich.edu elif isinstance(val, str): 13423356Sbinkertn@umich.edu val = '"' + val + '"' 13434781Snate@binkert.org 13445863Snate@binkert.org # Sources are variable name & value (packaged in SCons Value nodes) 13455863Snate@binkert.org return ([target], [Value(variable), Value(val)]) 13461869SN/A 13471869SN/Aconfig_builder = Builder(emitter = config_emitter, action = config_action) 13481869SN/A 13496121Snate@binkert.orgmain.Append(BUILDERS = { 'ConfigFile' : config_builder }) 13501869SN/A 135111982Sgabeblack@google.com################################################### 135211982Sgabeblack@google.com# 135311982Sgabeblack@google.com# Builders for static and shared partially linked object files. 135411982Sgabeblack@google.com# 135511982Sgabeblack@google.com################################################### 135611982Sgabeblack@google.com 135711982Sgabeblack@google.compartial_static_builder = Builder(action=SCons.Defaults.LinkAction, 135811982Sgabeblack@google.com src_suffix='$OBJSUFFIX', 135911982Sgabeblack@google.com src_builder=['StaticObject', 'Object'], 136011982Sgabeblack@google.com LINKFLAGS='$PLINKFLAGS', 136111982Sgabeblack@google.com LIBS='') 136211982Sgabeblack@google.com 136311982Sgabeblack@google.comdef partial_shared_emitter(target, source, env): 136411982Sgabeblack@google.com for tgt in target: 136511982Sgabeblack@google.com tgt.attributes.shared = 1 136611982Sgabeblack@google.com return (target, source) 136711982Sgabeblack@google.compartial_shared_builder = Builder(action=SCons.Defaults.ShLinkAction, 136811982Sgabeblack@google.com emitter=partial_shared_emitter, 136911982Sgabeblack@google.com src_suffix='$SHOBJSUFFIX', 137011982Sgabeblack@google.com src_builder='SharedObject', 137111982Sgabeblack@google.com SHLINKFLAGS='$PSHLINKFLAGS', 137211982Sgabeblack@google.com LIBS='') 137311982Sgabeblack@google.com 137411982Sgabeblack@google.commain.Append(BUILDERS = { 'PartialShared' : partial_shared_builder, 137511982Sgabeblack@google.com 'PartialStatic' : partial_static_builder }) 137611982Sgabeblack@google.com 137711978Sgabeblack@google.com# builds in ext are shared across all configs in the build root. 137811978Sgabeblack@google.comext_dir = abspath(joinpath(str(main.root), 'ext')) 137911978Sgabeblack@google.comfor root, dirs, files in os.walk(ext_dir): 138011978Sgabeblack@google.com if 'SConscript' in files: 138111978Sgabeblack@google.com build_dir = os.path.relpath(root, ext_dir) 138211978Sgabeblack@google.com main.SConscript(joinpath(root, 'SConscript'), 138311978Sgabeblack@google.com variant_dir=joinpath(build_root, build_dir)) 138410915Sandreas.sandberg@arm.com 138511986Sandreas.sandberg@arm.commain.Prepend(CPPPATH=Dir('ext/pybind11/include/')) 138611986Sandreas.sandberg@arm.com 13871869SN/A################################################### 13881869SN/A# 13893546Sgblack@eecs.umich.edu# This function is used to set up a directory with switching headers 13903546Sgblack@eecs.umich.edu# 13913546Sgblack@eecs.umich.edu################################################### 13923546Sgblack@eecs.umich.edu 13936121Snate@binkert.orgmain['ALL_ISA_LIST'] = all_isa_list 139411308Santhony.gutierrez@amd.commain['ALL_GPU_ISA_LIST'] = all_gpu_isa_list 139510196SCurtis.Dunham@arm.comall_isa_deps = {} 13965863Snate@binkert.orgdef make_switching_dir(dname, switch_headers, env): 13973546Sgblack@eecs.umich.edu # Generate the header. target[0] is the full path of the output 13983546Sgblack@eecs.umich.edu # header to generate. 'source' is a dummy variable, since we get the 13993546Sgblack@eecs.umich.edu # list of ISAs from env['ALL_ISA_LIST']. 14003546Sgblack@eecs.umich.edu def gen_switch_hdr(target, source, env): 14014781Snate@binkert.org fname = str(target[0]) 14026658Snate@binkert.org isa = env['TARGET_ISA'].lower() 140310196SCurtis.Dunham@arm.com try: 140410196SCurtis.Dunham@arm.com f = open(fname, 'w') 140510196SCurtis.Dunham@arm.com print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname)) 140610196SCurtis.Dunham@arm.com f.close() 140710196SCurtis.Dunham@arm.com except IOError: 140810196SCurtis.Dunham@arm.com print "Failed to create %s" % fname 140910196SCurtis.Dunham@arm.com raise 14103546Sgblack@eecs.umich.edu 14113546Sgblack@eecs.umich.edu # Build SCons Action object. 'varlist' specifies env vars that this 14123546Sgblack@eecs.umich.edu # action depends on; when env['ALL_ISA_LIST'] changes these actions 14133546Sgblack@eecs.umich.edu # should get re-executed. 14147756SAli.Saidi@ARM.com switch_hdr_action = MakeAction(gen_switch_hdr, 14157816Ssteve.reinhardt@amd.com Transform("GENERATE"), varlist=['ALL_ISA_LIST']) 14163546Sgblack@eecs.umich.edu 14173546Sgblack@eecs.umich.edu # Instantiate actions for each header 14183546Sgblack@eecs.umich.edu for hdr in switch_headers: 14193546Sgblack@eecs.umich.edu env.Command(hdr, [], switch_hdr_action) 142010196SCurtis.Dunham@arm.com 142110196SCurtis.Dunham@arm.com isa_target = Dir('.').up().name.lower().replace('_', '-') 142210196SCurtis.Dunham@arm.com env['PHONY_BASE'] = '#'+isa_target 142310196SCurtis.Dunham@arm.com all_isa_deps[isa_target] = None 142410196SCurtis.Dunham@arm.com 14254202Sbinkertn@umich.eduExport('make_switching_dir') 14263546Sgblack@eecs.umich.edu 142711308Santhony.gutierrez@amd.comdef make_gpu_switching_dir(dname, switch_headers, env): 142811308Santhony.gutierrez@amd.com # Generate the header. target[0] is the full path of the output 142911308Santhony.gutierrez@amd.com # header to generate. 'source' is a dummy variable, since we get the 143011308Santhony.gutierrez@amd.com # list of ISAs from env['ALL_ISA_LIST']. 143111308Santhony.gutierrez@amd.com def gen_switch_hdr(target, source, env): 143211308Santhony.gutierrez@amd.com fname = str(target[0]) 143311308Santhony.gutierrez@amd.com 143411308Santhony.gutierrez@amd.com isa = env['TARGET_GPU_ISA'].lower() 143511308Santhony.gutierrez@amd.com 143611308Santhony.gutierrez@amd.com try: 143711308Santhony.gutierrez@amd.com f = open(fname, 'w') 143811308Santhony.gutierrez@amd.com print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname)) 143911308Santhony.gutierrez@amd.com f.close() 144011308Santhony.gutierrez@amd.com except IOError: 144111308Santhony.gutierrez@amd.com print "Failed to create %s" % fname 144211308Santhony.gutierrez@amd.com raise 144311308Santhony.gutierrez@amd.com 144411308Santhony.gutierrez@amd.com # Build SCons Action object. 'varlist' specifies env vars that this 144511308Santhony.gutierrez@amd.com # action depends on; when env['ALL_ISA_LIST'] changes these actions 144611308Santhony.gutierrez@amd.com # should get re-executed. 144711308Santhony.gutierrez@amd.com switch_hdr_action = MakeAction(gen_switch_hdr, 144811308Santhony.gutierrez@amd.com Transform("GENERATE"), varlist=['ALL_ISA_GPU_LIST']) 144911308Santhony.gutierrez@amd.com 145011308Santhony.gutierrez@amd.com # Instantiate actions for each header 145111308Santhony.gutierrez@amd.com for hdr in switch_headers: 145211308Santhony.gutierrez@amd.com env.Command(hdr, [], switch_hdr_action) 145311308Santhony.gutierrez@amd.com 145411308Santhony.gutierrez@amd.comExport('make_gpu_switching_dir') 145511308Santhony.gutierrez@amd.com 145610196SCurtis.Dunham@arm.com# all-isas -> all-deps -> all-environs -> all_targets 145710196SCurtis.Dunham@arm.commain.Alias('#all-isas', []) 145810196SCurtis.Dunham@arm.commain.Alias('#all-deps', '#all-isas') 145910196SCurtis.Dunham@arm.com 146010196SCurtis.Dunham@arm.com# Dummy target to ensure all environments are created before telling 146110196SCurtis.Dunham@arm.com# SCons what to actually make (the command line arguments). We attach 146210196SCurtis.Dunham@arm.com# them to the dependence graph after the environments are complete. 146310196SCurtis.Dunham@arm.comORIG_BUILD_TARGETS = list(BUILD_TARGETS) # force a copy; gets closure to work. 146410196SCurtis.Dunham@arm.comdef environsComplete(target, source, env): 146510196SCurtis.Dunham@arm.com for t in ORIG_BUILD_TARGETS: 146610196SCurtis.Dunham@arm.com main.Depends('#all-targets', t) 146710196SCurtis.Dunham@arm.com 146810196SCurtis.Dunham@arm.com# Each build/* switching_dir attaches its *-environs target to #all-environs. 146910196SCurtis.Dunham@arm.commain.Append(BUILDERS = {'CompleteEnvirons' : 147010196SCurtis.Dunham@arm.com Builder(action=MakeAction(environsComplete, None))}) 147110196SCurtis.Dunham@arm.commain.CompleteEnvirons('#all-environs', []) 147210196SCurtis.Dunham@arm.com 147310196SCurtis.Dunham@arm.comdef doNothing(**ignored): pass 147410196SCurtis.Dunham@arm.commain.Append(BUILDERS = {'Dummy': Builder(action=MakeAction(doNothing, None))}) 147510196SCurtis.Dunham@arm.com 147610196SCurtis.Dunham@arm.com# The final target to which all the original targets ultimately get attached. 147710196SCurtis.Dunham@arm.commain.Dummy('#all-targets', '#all-environs') 147810196SCurtis.Dunham@arm.comBUILD_TARGETS[:] = ['#all-targets'] 147910196SCurtis.Dunham@arm.com 14803546Sgblack@eecs.umich.edu################################################### 14813546Sgblack@eecs.umich.edu# 1482955SN/A# Define build environments for selected configurations. 1483955SN/A# 1484955SN/A################################################### 1485955SN/A 14865863Snate@binkert.orgfor variant_path in variant_paths: 148710135SCurtis.Dunham@arm.com if not GetOption('silent'): 148810135SCurtis.Dunham@arm.com print "Building in", variant_path 14895343Sstever@gmail.com 14905343Sstever@gmail.com # Make a copy of the build-root environment to use for this config. 14916121Snate@binkert.org env = main.Clone() 14925863Snate@binkert.org env['BUILDDIR'] = variant_path 14934773Snate@binkert.org 14945863Snate@binkert.org # variant_dir is the tail component of build path, and is used to 14952632Sstever@eecs.umich.edu # determine the build parameters (e.g., 'ALPHA_SE') 14965863Snate@binkert.org (build_root, variant_dir) = splitpath(variant_path) 14972023SN/A 14985863Snate@binkert.org # Set env variables according to the build directory config. 14995863Snate@binkert.org sticky_vars.files = [] 15005863Snate@binkert.org # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in 15015863Snate@binkert.org # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke 15025863Snate@binkert.org # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings. 15035863Snate@binkert.org current_vars_file = joinpath(build_root, 'variables', variant_dir) 15045863Snate@binkert.org if isfile(current_vars_file): 15055863Snate@binkert.org sticky_vars.files.append(current_vars_file) 150610135SCurtis.Dunham@arm.com if not GetOption('silent'): 150710135SCurtis.Dunham@arm.com print "Using saved variables file %s" % current_vars_file 15082632Sstever@eecs.umich.edu else: 15095863Snate@binkert.org # Build dir-specific variables file doesn't exist. 15102023SN/A 15112632Sstever@eecs.umich.edu # Make sure the directory is there so we can create it later 15125863Snate@binkert.org opt_dir = dirname(current_vars_file) 15135342Sstever@gmail.com if not isdir(opt_dir): 15145863Snate@binkert.org mkdir(opt_dir) 15152632Sstever@eecs.umich.edu 15165863Snate@binkert.org # Get default build variables from source tree. Variables are 15175863Snate@binkert.org # normally determined by name of $VARIANT_DIR, but can be 15188267Ssteve.reinhardt@amd.com # overridden by '--default=' arg on command line. 15198120Sgblack@eecs.umich.edu default = GetOption('default') 15208267Ssteve.reinhardt@amd.com opts_dir = joinpath(main.root.abspath, 'build_opts') 15218267Ssteve.reinhardt@amd.com if default: 15228267Ssteve.reinhardt@amd.com default_vars_files = [joinpath(build_root, 'variables', default), 15238267Ssteve.reinhardt@amd.com joinpath(opts_dir, default)] 15248267Ssteve.reinhardt@amd.com else: 15258267Ssteve.reinhardt@amd.com default_vars_files = [joinpath(opts_dir, variant_dir)] 15268267Ssteve.reinhardt@amd.com existing_files = filter(isfile, default_vars_files) 15278267Ssteve.reinhardt@amd.com if existing_files: 15288267Ssteve.reinhardt@amd.com default_vars_file = existing_files[0] 15295863Snate@binkert.org sticky_vars.files.append(default_vars_file) 15305863Snate@binkert.org print "Variables file %s not found,\n using defaults in %s" \ 15315863Snate@binkert.org % (current_vars_file, default_vars_file) 15322632Sstever@eecs.umich.edu else: 15338267Ssteve.reinhardt@amd.com print "Error: cannot find variables file %s or " \ 15348267Ssteve.reinhardt@amd.com "default file(s) %s" \ 15358267Ssteve.reinhardt@amd.com % (current_vars_file, ' or '.join(default_vars_files)) 15362632Sstever@eecs.umich.edu Exit(1) 15371888SN/A 15385863Snate@binkert.org # Apply current variable settings to env 15395863Snate@binkert.org sticky_vars.Update(env) 15401858SN/A 15418120Sgblack@eecs.umich.edu help_texts["local_vars"] += \ 15428120Sgblack@eecs.umich.edu "Build variables for %s:\n" % variant_dir \ 15437756SAli.Saidi@ARM.com + sticky_vars.GenerateHelpText(env) 15442598SN/A 15455863Snate@binkert.org # Process variable settings. 15461858SN/A 15471858SN/A if not have_fenv and env['USE_FENV']: 15481858SN/A print "Warning: <fenv.h> not available; " \ 15495863Snate@binkert.org "forcing USE_FENV to False in", variant_dir + "." 15501858SN/A env['USE_FENV'] = False 15511858SN/A 15521858SN/A if not env['USE_FENV']: 15535863Snate@binkert.org print "Warning: No IEEE FP rounding mode control in", variant_dir + "." 15541871SN/A print " FP results may deviate slightly from other platforms." 15551858SN/A 15561858SN/A if env['EFENCE']: 15571858SN/A env.Append(LIBS=['efence']) 15581858SN/A 15599651SAndreas.Sandberg@ARM.com if env['USE_KVM']: 15609651SAndreas.Sandberg@ARM.com if not have_kvm: 15619651SAndreas.Sandberg@ARM.com print "Warning: Can not enable KVM, host seems to lack KVM support" 15629651SAndreas.Sandberg@ARM.com env['USE_KVM'] = False 15639651SAndreas.Sandberg@ARM.com elif not is_isa_kvm_compatible(env['TARGET_ISA']): 15649651SAndreas.Sandberg@ARM.com print "Info: KVM support disabled due to unsupported host and " \ 15659651SAndreas.Sandberg@ARM.com "target ISA combination" 15669651SAndreas.Sandberg@ARM.com env['USE_KVM'] = False 15679651SAndreas.Sandberg@ARM.com 156811798Santhony.gutierrez@amd.com if env['BUILD_GPU']: 156911798Santhony.gutierrez@amd.com env.Append(CPPDEFINES=['BUILD_GPU']) 157011798Santhony.gutierrez@amd.com 15719986Sandreas@sandberg.pp.se # Warn about missing optional functionality 15729986Sandreas@sandberg.pp.se if env['USE_KVM']: 15739986Sandreas@sandberg.pp.se if not main['HAVE_PERF_ATTR_EXCLUDE_HOST']: 15749986Sandreas@sandberg.pp.se print "Warning: perf_event headers lack support for the " \ 15759986Sandreas@sandberg.pp.se "exclude_host attribute. KVM instruction counts will " \ 15769986Sandreas@sandberg.pp.se "be inaccurate." 15779986Sandreas@sandberg.pp.se 15785863Snate@binkert.org # Save sticky variable settings back to current variables file 15795863Snate@binkert.org sticky_vars.Save(current_vars_file, env) 15801869SN/A 15811965SN/A if env['USE_SSE2']: 15827739Sgblack@eecs.umich.edu env.Append(CCFLAGS=['-msse2']) 15831965SN/A 15842761Sstever@eecs.umich.edu # The src/SConscript file sets up the build rules in 'env' according 15855863Snate@binkert.org # to the configured variables. It returns a list of environments, 15861869SN/A # one for each variant build (debug, opt, etc.) 158710196SCurtis.Dunham@arm.com SConscript('src/SConscript', variant_dir = variant_path, exports = 'env') 15881869SN/A 158910196SCurtis.Dunham@arm.comdef pairwise(iterable): 159010196SCurtis.Dunham@arm.com "s -> (s0,s1), (s1,s2), (s2, s3), ..." 159110196SCurtis.Dunham@arm.com a, b = itertools.tee(iterable) 159210196SCurtis.Dunham@arm.com b.next() 159310196SCurtis.Dunham@arm.com return itertools.izip(a, b) 159410196SCurtis.Dunham@arm.com 159510196SCurtis.Dunham@arm.com# Create false dependencies so SCons will parse ISAs, establish 159610196SCurtis.Dunham@arm.com# dependencies, and setup the build Environments serially. Either 159710196SCurtis.Dunham@arm.com# SCons (likely) and/or our SConscripts (possibly) cannot cope with -j 159810196SCurtis.Dunham@arm.com# greater than 1. It appears to be standard race condition stuff; it 159910196SCurtis.Dunham@arm.com# doesn't always fail, but usually, and the behaviors are different. 160010196SCurtis.Dunham@arm.com# Every time I tried to remove this, builds would fail in some 160110196SCurtis.Dunham@arm.com# creative new way. So, don't do that. You'll want to, though, because 160210196SCurtis.Dunham@arm.com# tests/SConscript takes a long time to make its Environments. 160310196SCurtis.Dunham@arm.comfor t1, t2 in pairwise(sorted(all_isa_deps.iterkeys())): 160410196SCurtis.Dunham@arm.com main.Depends('#%s-deps' % t2, '#%s-deps' % t1) 160510196SCurtis.Dunham@arm.com main.Depends('#%s-environs' % t2, '#%s-environs' % t1) 1606955SN/A 16078120Sgblack@eecs.umich.edu# base help text 16088120Sgblack@eecs.umich.eduHelp(''' 16098120Sgblack@eecs.umich.eduUsage: scons [scons options] [build variables] [target(s)] 16108120Sgblack@eecs.umich.edu 16118120Sgblack@eecs.umich.eduExtra scons options: 16128120Sgblack@eecs.umich.edu%(options)s 16138120Sgblack@eecs.umich.edu 16148120Sgblack@eecs.umich.eduGlobal build variables: 16158120Sgblack@eecs.umich.edu%(global_vars)s 16168120Sgblack@eecs.umich.edu 16178120Sgblack@eecs.umich.edu%(local_vars)s 16188120Sgblack@eecs.umich.edu''' % help_texts) 1619