SConstruct revision 13421
1955SN/A# -*- mode:python -*- 2955SN/A 312230Sgiacomo.travaglini@arm.com# Copyright (c) 2013, 2015-2017 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 8112563Sgabeblack@google.comfrom __future__ import print_function 8212563Sgabeblack@google.com 836654Snate@binkert.org# Global Python includes 8410196SCurtis.Dunham@arm.comimport itertools 85955SN/Aimport os 865396Ssaidi@eecs.umich.eduimport re 8711401Sandreas.sandberg@arm.comimport shutil 885863Snate@binkert.orgimport subprocess 895863Snate@binkert.orgimport sys 904202Sbinkertn@umich.edu 915863Snate@binkert.orgfrom os import mkdir, environ 925863Snate@binkert.orgfrom os.path import abspath, basename, dirname, expanduser, normpath 935863Snate@binkert.orgfrom os.path import exists, isdir, isfile 945863Snate@binkert.orgfrom os.path import join as joinpath, split as splitpath 95955SN/A 966654Snate@binkert.org# SCons includes 975273Sstever@gmail.comimport SCons 985871Snate@binkert.orgimport SCons.Node 995273Sstever@gmail.com 1006654Snate@binkert.orgfrom m5.util import compareVersions, readCommand 1015396Ssaidi@eecs.umich.edu 1028120Sgblack@eecs.umich.eduhelp_texts = { 1038120Sgblack@eecs.umich.edu "options" : "", 1048120Sgblack@eecs.umich.edu "global_vars" : "", 1058120Sgblack@eecs.umich.edu "local_vars" : "" 1068120Sgblack@eecs.umich.edu} 1078120Sgblack@eecs.umich.edu 1088120Sgblack@eecs.umich.eduExport("help_texts") 1098120Sgblack@eecs.umich.edu 1108879Ssteve.reinhardt@amd.com 1118879Ssteve.reinhardt@amd.com# There's a bug in scons in that (1) by default, the help texts from 1128879Ssteve.reinhardt@amd.com# AddOption() are supposed to be displayed when you type 'scons -h' 1138879Ssteve.reinhardt@amd.com# and (2) you can override the help displayed by 'scons -h' using the 1148879Ssteve.reinhardt@amd.com# Help() function, but these two features are incompatible: once 1158879Ssteve.reinhardt@amd.com# you've overridden the help text using Help(), there's no way to get 1168879Ssteve.reinhardt@amd.com# at the help texts from AddOptions. See: 1178879Ssteve.reinhardt@amd.com# http://scons.tigris.org/issues/show_bug.cgi?id=2356 1188879Ssteve.reinhardt@amd.com# http://scons.tigris.org/issues/show_bug.cgi?id=2611 1198879Ssteve.reinhardt@amd.com# This hack lets us extract the help text from AddOptions and 1208879Ssteve.reinhardt@amd.com# re-inject it via Help(). Ideally someday this bug will be fixed and 1218879Ssteve.reinhardt@amd.com# we can just use AddOption directly. 1228879Ssteve.reinhardt@amd.comdef AddLocalOption(*args, **kwargs): 1238120Sgblack@eecs.umich.edu col_width = 30 1248120Sgblack@eecs.umich.edu 1258120Sgblack@eecs.umich.edu help = " " + ", ".join(args) 1268120Sgblack@eecs.umich.edu if "help" in kwargs: 1278120Sgblack@eecs.umich.edu length = len(help) 1288120Sgblack@eecs.umich.edu if length >= col_width: 1298120Sgblack@eecs.umich.edu help += "\n" + " " * col_width 1308120Sgblack@eecs.umich.edu else: 1318120Sgblack@eecs.umich.edu help += " " * (col_width - length) 1328120Sgblack@eecs.umich.edu help += kwargs["help"] 1338120Sgblack@eecs.umich.edu help_texts["options"] += help + "\n" 1348120Sgblack@eecs.umich.edu 1358120Sgblack@eecs.umich.edu AddOption(*args, **kwargs) 1368120Sgblack@eecs.umich.edu 1378879Ssteve.reinhardt@amd.comAddLocalOption('--colors', dest='use_colors', action='store_true', 1388879Ssteve.reinhardt@amd.com help="Add color to abbreviated scons output") 1398879Ssteve.reinhardt@amd.comAddLocalOption('--no-colors', dest='use_colors', action='store_false', 1408879Ssteve.reinhardt@amd.com help="Don't add color to abbreviated scons output") 14110458Sandreas.hansson@arm.comAddLocalOption('--with-cxx-config', dest='with_cxx_config', 14210458Sandreas.hansson@arm.com action='store_true', 14310458Sandreas.hansson@arm.com help="Build with support for C++-based configuration") 1448879Ssteve.reinhardt@amd.comAddLocalOption('--default', dest='default', type='string', action='store', 1458879Ssteve.reinhardt@amd.com help='Override which build_opts file to use for defaults') 1468879Ssteve.reinhardt@amd.comAddLocalOption('--ignore-style', dest='ignore_style', action='store_true', 1478879Ssteve.reinhardt@amd.com help='Disable style checking hooks') 14813421Sciro.santilli@arm.comAddLocalOption('--gold-linker', dest='gold_linker', action='store_true', 14913421Sciro.santilli@arm.com help='Use the gold linker') 1509227Sandreas.hansson@arm.comAddLocalOption('--no-lto', dest='no_lto', action='store_true', 1519227Sandreas.hansson@arm.com help='Disable Link-Time Optimization for fast') 15212063Sgabeblack@google.comAddLocalOption('--force-lto', dest='force_lto', action='store_true', 15312063Sgabeblack@google.com help='Use Link-Time Optimization instead of partial linking' + 15412063Sgabeblack@google.com ' when the compiler doesn\'t support using them together.') 1558879Ssteve.reinhardt@amd.comAddLocalOption('--update-ref', dest='update_ref', action='store_true', 1568879Ssteve.reinhardt@amd.com help='Update test reference outputs') 1578879Ssteve.reinhardt@amd.comAddLocalOption('--verbose', dest='verbose', action='store_true', 1588879Ssteve.reinhardt@amd.com help='Print full tool command lines') 15910453SAndrew.Bardsley@arm.comAddLocalOption('--without-python', dest='without_python', 16010453SAndrew.Bardsley@arm.com action='store_true', 16110453SAndrew.Bardsley@arm.com help='Build without Python configuration support') 16210456SCurtis.Dunham@arm.comAddLocalOption('--without-tcmalloc', dest='without_tcmalloc', 16310456SCurtis.Dunham@arm.com action='store_true', 16410456SCurtis.Dunham@arm.com help='Disable linking against tcmalloc') 16510457Sandreas.hansson@arm.comAddLocalOption('--with-ubsan', dest='with_ubsan', action='store_true', 16610457Sandreas.hansson@arm.com help='Build with Undefined Behavior Sanitizer if available') 16711342Sandreas.hansson@arm.comAddLocalOption('--with-asan', dest='with_asan', action='store_true', 16811342Sandreas.hansson@arm.com help='Build with Address Sanitizer if available') 1698120Sgblack@eecs.umich.edu 17012063Sgabeblack@google.comif GetOption('no_lto') and GetOption('force_lto'): 17112563Sgabeblack@google.com print('--no-lto and --force-lto are mutually exclusive') 17212063Sgabeblack@google.com Exit(1) 17312063Sgabeblack@google.com 1745871Snate@binkert.org######################################################################## 1755871Snate@binkert.org# 1766121Snate@binkert.org# Set up the main build environment. 1775871Snate@binkert.org# 1785871Snate@binkert.org######################################################################## 1799926Sstan.czerniawski@arm.com 18012243Sgabeblack@google.commain = Environment() 1811533SN/A 18212246Sgabeblack@google.comfrom gem5_scons import Transform 18312246Sgabeblack@google.comfrom gem5_scons.util import get_termcap 18412246Sgabeblack@google.comtermcap = get_termcap() 18512246Sgabeblack@google.com 1869239Sandreas.hansson@arm.commain_dict_keys = main.Dictionary().keys() 1879239Sandreas.hansson@arm.com 1889239Sandreas.hansson@arm.com# Check that we have a C/C++ compiler 1899239Sandreas.hansson@arm.comif not ('CC' in main_dict_keys and 'CXX' in main_dict_keys): 19012563Sgabeblack@google.com print("No C++ compiler installed (package g++ on Ubuntu and RedHat)") 1919239Sandreas.hansson@arm.com Exit(1) 1929239Sandreas.hansson@arm.com 193955SN/A################################################### 194955SN/A# 1952632Sstever@eecs.umich.edu# Figure out which configurations to set up based on the path(s) of 1962632Sstever@eecs.umich.edu# the target(s). 197955SN/A# 198955SN/A################################################### 199955SN/A 200955SN/A# Find default configuration & binary. 2018878Ssteve.reinhardt@amd.comDefault(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug')) 202955SN/A 2032632Sstever@eecs.umich.edu# helper function: find last occurrence of element in list 2042632Sstever@eecs.umich.edudef rfind(l, elt, offs = -1): 2052632Sstever@eecs.umich.edu for i in range(len(l)+offs, 0, -1): 2062632Sstever@eecs.umich.edu if l[i] == elt: 2072632Sstever@eecs.umich.edu return i 2082632Sstever@eecs.umich.edu raise ValueError, "element not found" 2092632Sstever@eecs.umich.edu 2108268Ssteve.reinhardt@amd.com# Take a list of paths (or SCons Nodes) and return a list with all 2118268Ssteve.reinhardt@amd.com# paths made absolute and ~-expanded. Paths will be interpreted 2128268Ssteve.reinhardt@amd.com# relative to the launch directory unless a different root is provided 2138268Ssteve.reinhardt@amd.comdef makePathListAbsolute(path_list, root=GetLaunchDir()): 2148268Ssteve.reinhardt@amd.com return [abspath(joinpath(root, expanduser(str(p)))) 2158268Ssteve.reinhardt@amd.com for p in path_list] 2168268Ssteve.reinhardt@amd.com 2172632Sstever@eecs.umich.edu# Each target must have 'build' in the interior of the path; the 2182632Sstever@eecs.umich.edu# directory below this will determine the build parameters. For 2192632Sstever@eecs.umich.edu# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we 2202632Sstever@eecs.umich.edu# recognize that ALPHA_SE specifies the configuration because it 2218268Ssteve.reinhardt@amd.com# follow 'build' in the build path. 2222632Sstever@eecs.umich.edu 2238268Ssteve.reinhardt@amd.com# The funky assignment to "[:]" is needed to replace the list contents 2248268Ssteve.reinhardt@amd.com# in place rather than reassign the symbol to a new list, which 2258268Ssteve.reinhardt@amd.com# doesn't work (obviously!). 2268268Ssteve.reinhardt@amd.comBUILD_TARGETS[:] = makePathListAbsolute(BUILD_TARGETS) 2273718Sstever@eecs.umich.edu 2282634Sstever@eecs.umich.edu# Generate a list of the unique build roots and configs that the 2292634Sstever@eecs.umich.edu# collected targets reference. 2305863Snate@binkert.orgvariant_paths = [] 2312638Sstever@eecs.umich.edubuild_root = None 2328268Ssteve.reinhardt@amd.comfor t in BUILD_TARGETS: 2332632Sstever@eecs.umich.edu path_dirs = t.split('/') 2342632Sstever@eecs.umich.edu try: 2352632Sstever@eecs.umich.edu build_top = rfind(path_dirs, 'build', -2) 2362632Sstever@eecs.umich.edu except: 23712563Sgabeblack@google.com print("Error: no non-leaf 'build' dir found on target path", t) 2381858SN/A Exit(1) 2393716Sstever@eecs.umich.edu this_build_root = joinpath('/',*path_dirs[:build_top+1]) 2402638Sstever@eecs.umich.edu if not build_root: 2412638Sstever@eecs.umich.edu build_root = this_build_root 2422638Sstever@eecs.umich.edu else: 2432638Sstever@eecs.umich.edu if this_build_root != build_root: 24412563Sgabeblack@google.com print("Error: build targets not under same build root\n" 24512563Sgabeblack@google.com " %s\n %s" % (build_root, this_build_root)) 2462638Sstever@eecs.umich.edu Exit(1) 2475863Snate@binkert.org variant_path = joinpath('/',*path_dirs[:build_top+2]) 2485863Snate@binkert.org if variant_path not in variant_paths: 2495863Snate@binkert.org variant_paths.append(variant_path) 250955SN/A 2515341Sstever@gmail.com# Make sure build_root exists (might not if this is the first build there) 2525341Sstever@gmail.comif not isdir(build_root): 2535863Snate@binkert.org mkdir(build_root) 2547756SAli.Saidi@ARM.commain['BUILDROOT'] = build_root 2555341Sstever@gmail.com 2566121Snate@binkert.orgExport('main') 2574494Ssaidi@eecs.umich.edu 2586121Snate@binkert.orgmain.SConsignFile(joinpath(build_root, "sconsign")) 2591105SN/A 2602667Sstever@eecs.umich.edu# Default duplicate option is to use hard links, but this messes up 2612667Sstever@eecs.umich.edu# when you use emacs to edit a file in the target dir, as emacs moves 2622667Sstever@eecs.umich.edu# file to file~ then copies to file, breaking the link. Symbolic 2632667Sstever@eecs.umich.edu# (soft) links work better. 2646121Snate@binkert.orgmain.SetOption('duplicate', 'soft-copy') 2652667Sstever@eecs.umich.edu 2665341Sstever@gmail.com# 2675863Snate@binkert.org# Set up global sticky variables... these are common to an entire build 2685341Sstever@gmail.com# tree (not specific to a particular build like ALPHA_SE) 2695341Sstever@gmail.com# 2705341Sstever@gmail.com 2718120Sgblack@eecs.umich.eduglobal_vars_file = joinpath(build_root, 'variables.global') 2725341Sstever@gmail.com 2738120Sgblack@eecs.umich.eduglobal_vars = Variables(global_vars_file, args=ARGUMENTS) 2745341Sstever@gmail.com 2758120Sgblack@eecs.umich.eduglobal_vars.AddVariables( 2766121Snate@binkert.org ('CC', 'C compiler', environ.get('CC', main['CC'])), 2776121Snate@binkert.org ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])), 2789396Sandreas.hansson@arm.com ('PROTOC', 'protoc tool', environ.get('PROTOC', 'protoc')), 2795397Ssaidi@eecs.umich.edu ('BATCH', 'Use batch pool for build and tests', False), 2805397Ssaidi@eecs.umich.edu ('BATCH_CMD', 'Batch pool submission command name', 'qdo'), 2817727SAli.Saidi@ARM.com ('M5_BUILD_CACHE', 'Cache built objects in this directory', False), 2828268Ssteve.reinhardt@amd.com ('EXTRAS', 'Add extra directories to the compilation', '') 2836168Snate@binkert.org ) 2845341Sstever@gmail.com 2858120Sgblack@eecs.umich.edu# Update main environment with values from ARGUMENTS & global_vars_file 2868120Sgblack@eecs.umich.eduglobal_vars.Update(main) 2878120Sgblack@eecs.umich.eduhelp_texts["global_vars"] += global_vars.GenerateHelpText(main) 2886814Sgblack@eecs.umich.edu 2895863Snate@binkert.org# Save sticky variable settings back to current variables file 2908120Sgblack@eecs.umich.eduglobal_vars.Save(global_vars_file, main) 2915341Sstever@gmail.com 2925863Snate@binkert.org# Parse EXTRAS variable to build list of all directories where we're 2938268Ssteve.reinhardt@amd.com# look for sources etc. This list is exported as extras_dir_list. 2946121Snate@binkert.orgbase_dir = main.srcdir.abspath 2956121Snate@binkert.orgif main['EXTRAS']: 2968268Ssteve.reinhardt@amd.com extras_dir_list = makePathListAbsolute(main['EXTRAS'].split(':')) 2975742Snate@binkert.orgelse: 2985742Snate@binkert.org extras_dir_list = [] 2995341Sstever@gmail.com 3005742Snate@binkert.orgExport('base_dir') 3015742Snate@binkert.orgExport('extras_dir_list') 3025341Sstever@gmail.com 3036017Snate@binkert.org# the ext directory should be on the #includes path 3046121Snate@binkert.orgmain.Append(CPPPATH=[Dir('ext')]) 3056017Snate@binkert.org 30612158Sandreas.sandberg@arm.com# Add shared top-level headers 30712158Sandreas.sandberg@arm.commain.Prepend(CPPPATH=Dir('include')) 30812158Sandreas.sandberg@arm.com 3098120Sgblack@eecs.umich.eduif GetOption('verbose'): 3107756SAli.Saidi@ARM.com def MakeAction(action, string, *args, **kwargs): 3117756SAli.Saidi@ARM.com return Action(action, *args, **kwargs) 3127756SAli.Saidi@ARM.comelse: 3137756SAli.Saidi@ARM.com MakeAction = Action 3147816Ssteve.reinhardt@amd.com main['CCCOMSTR'] = Transform("CC") 3157816Ssteve.reinhardt@amd.com main['CXXCOMSTR'] = Transform("CXX") 3167816Ssteve.reinhardt@amd.com main['ASCOMSTR'] = Transform("AS") 3177816Ssteve.reinhardt@amd.com main['ARCOMSTR'] = Transform("AR", 0) 3187816Ssteve.reinhardt@amd.com main['LINKCOMSTR'] = Transform("LINK", 0) 31911979Sgabeblack@google.com main['SHLINKCOMSTR'] = Transform("SHLINK", 0) 3207816Ssteve.reinhardt@amd.com main['RANLIBCOMSTR'] = Transform("RANLIB", 0) 3217816Ssteve.reinhardt@amd.com main['M4COMSTR'] = Transform("M4") 3227816Ssteve.reinhardt@amd.com main['SHCCCOMSTR'] = Transform("SHCC") 3237816Ssteve.reinhardt@amd.com main['SHCXXCOMSTR'] = Transform("SHCXX") 3247756SAli.Saidi@ARM.comExport('MakeAction') 3257756SAli.Saidi@ARM.com 3269227Sandreas.hansson@arm.com# Initialize the Link-Time Optimization (LTO) flags 3279227Sandreas.hansson@arm.commain['LTO_CCFLAGS'] = [] 3289227Sandreas.hansson@arm.commain['LTO_LDFLAGS'] = [] 3299227Sandreas.hansson@arm.com 3309590Sandreas@sandberg.pp.se# According to the readme, tcmalloc works best if the compiler doesn't 3319590Sandreas@sandberg.pp.se# assume that we're using the builtin malloc and friends. These flags 3329590Sandreas@sandberg.pp.se# are compiler-specific, so we need to set them after we detect which 3339590Sandreas@sandberg.pp.se# compiler we're using. 3349590Sandreas@sandberg.pp.semain['TCMALLOC_CCFLAGS'] = [] 3359590Sandreas@sandberg.pp.se 3366654Snate@binkert.orgCXX_version = readCommand([main['CXX'],'--version'], exception=False) 3376654Snate@binkert.orgCXX_V = readCommand([main['CXX'],'-V'], exception=False) 3385871Snate@binkert.org 3396121Snate@binkert.orgmain['GCC'] = CXX_version and CXX_version.find('g++') >= 0 3408946Sandreas.hansson@arm.commain['CLANG'] = CXX_version and CXX_version.find('clang') >= 0 3419419Sandreas.hansson@arm.comif main['GCC'] + main['CLANG'] > 1: 34212563Sgabeblack@google.com print('Error: How can we have two at the same time?') 3433918Ssaidi@eecs.umich.edu Exit(1) 3443918Ssaidi@eecs.umich.edu 3451858SN/A# Set up default C++ compiler flags 3469556Sandreas.hansson@arm.comif main['GCC'] or main['CLANG']: 3479556Sandreas.hansson@arm.com # As gcc and clang share many flags, do the common parts here 3489556Sandreas.hansson@arm.com main.Append(CCFLAGS=['-pipe']) 3499556Sandreas.hansson@arm.com main.Append(CCFLAGS=['-fno-strict-aliasing']) 35011294Sandreas.hansson@arm.com # Enable -Wall and -Wextra and then disable the few warnings that 35111294Sandreas.hansson@arm.com # we consistently violate 35211294Sandreas.hansson@arm.com main.Append(CCFLAGS=['-Wall', '-Wundef', '-Wextra', 35311294Sandreas.hansson@arm.com '-Wno-sign-compare', '-Wno-unused-parameter']) 35410878Sandreas.hansson@arm.com # We always compile using C++11 35510878Sandreas.hansson@arm.com main.Append(CXXFLAGS=['-std=c++11']) 35611811Sbaz21@cam.ac.uk if sys.platform.startswith('freebsd'): 35711811Sbaz21@cam.ac.uk main.Append(CCFLAGS=['-I/usr/local/include']) 35811811Sbaz21@cam.ac.uk main.Append(CXXFLAGS=['-I/usr/local/include']) 35911982Sgabeblack@google.com 36011982Sgabeblack@google.com main['FILTER_PSHLINKFLAGS'] = lambda x: str(x).replace(' -shared', '') 36111982Sgabeblack@google.com main['PSHLINKFLAGS'] = main.subst('${FILTER_PSHLINKFLAGS(SHLINKFLAGS)}') 36213421Sciro.santilli@arm.com if GetOption('gold_linker'): 36313421Sciro.santilli@arm.com main.Append(LINKFLAGS='-fuse-ld=gold') 36411982Sgabeblack@google.com main['PLINKFLAGS'] = main.subst('${LINKFLAGS}') 36511992Sgabeblack@google.com shared_partial_flags = ['-r', '-nostdlib'] 36611982Sgabeblack@google.com main.Append(PSHLINKFLAGS=shared_partial_flags) 36711982Sgabeblack@google.com main.Append(PLINKFLAGS=shared_partial_flags) 36812305Sgabeblack@google.com 36912305Sgabeblack@google.com # Treat warnings as errors but white list some warnings that we 37012305Sgabeblack@google.com # want to allow (e.g., deprecation warnings). 37112305Sgabeblack@google.com main.Append(CCFLAGS=['-Werror', 37212305Sgabeblack@google.com '-Wno-error=deprecated-declarations', 37312305Sgabeblack@google.com '-Wno-error=deprecated', 37412305Sgabeblack@google.com ]) 3759556Sandreas.hansson@arm.comelse: 37612563Sgabeblack@google.com print(termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal, end=' ') 37712563Sgabeblack@google.com print("Don't know what compiler options to use for your compiler.") 37812563Sgabeblack@google.com print(termcap.Yellow + ' compiler:' + termcap.Normal, main['CXX']) 37912563Sgabeblack@google.com print(termcap.Yellow + ' version:' + termcap.Normal, end = ' ') 3809556Sandreas.hansson@arm.com if not CXX_version: 38112563Sgabeblack@google.com print(termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" + 38212563Sgabeblack@google.com termcap.Normal) 3839556Sandreas.hansson@arm.com else: 38412563Sgabeblack@google.com print(CXX_version.replace('\n', '<nl>')) 38512563Sgabeblack@google.com print(" If you're trying to use a compiler other than GCC") 38612563Sgabeblack@google.com print(" or clang, there appears to be something wrong with your") 38712563Sgabeblack@google.com print(" environment.") 38812563Sgabeblack@google.com print(" ") 38912563Sgabeblack@google.com print(" If you are trying to use a compiler other than those listed") 39012563Sgabeblack@google.com print(" above you will need to ease fix SConstruct and ") 39112563Sgabeblack@google.com print(" src/SConscript to support that compiler.") 3929556Sandreas.hansson@arm.com Exit(1) 3939556Sandreas.hansson@arm.com 3946121Snate@binkert.orgif main['GCC']: 39511500Sandreas.hansson@arm.com # Check for a supported version of gcc. >= 4.8 is chosen for its 39610238Sandreas.hansson@arm.com # level of c++11 support. See 39710878Sandreas.hansson@arm.com # http://gcc.gnu.org/projects/cxx0x.html for details. 3989420Sandreas.hansson@arm.com gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False) 39911500Sandreas.hansson@arm.com if compareVersions(gcc_version, "4.8") < 0: 40012563Sgabeblack@google.com print('Error: gcc version 4.8 or newer required.') 40112563Sgabeblack@google.com print(' Installed version: ', gcc_version) 4029420Sandreas.hansson@arm.com Exit(1) 4039420Sandreas.hansson@arm.com 4049420Sandreas.hansson@arm.com main['GCC_VERSION'] = gcc_version 4059420Sandreas.hansson@arm.com 40612063Sgabeblack@google.com if compareVersions(gcc_version, '4.9') >= 0: 40712063Sgabeblack@google.com # Incremental linking with LTO is currently broken in gcc versions 40812063Sgabeblack@google.com # 4.9 and above. A version where everything works completely hasn't 40912063Sgabeblack@google.com # yet been identified. 41012063Sgabeblack@google.com # 41112063Sgabeblack@google.com # https://gcc.gnu.org/bugzilla/show_bug.cgi?id=67548 41212063Sgabeblack@google.com main['BROKEN_INCREMENTAL_LTO'] = True 41312063Sgabeblack@google.com if compareVersions(gcc_version, '6.0') >= 0: 41412063Sgabeblack@google.com # gcc versions 6.0 and greater accept an -flinker-output flag which 41512063Sgabeblack@google.com # selects what type of output the linker should generate. This is 41612063Sgabeblack@google.com # necessary for incremental lto to work, but is also broken in 41712063Sgabeblack@google.com # current versions of gcc. It may not be necessary in future 41812063Sgabeblack@google.com # versions. We add it here since it might be, and as a reminder that 41912063Sgabeblack@google.com # it exists. It's excluded if lto is being forced. 42012063Sgabeblack@google.com # 42112063Sgabeblack@google.com # https://gcc.gnu.org/gcc-6/changes.html 42212063Sgabeblack@google.com # https://gcc.gnu.org/ml/gcc-patches/2015-11/msg03161.html 42312063Sgabeblack@google.com # https://gcc.gnu.org/bugzilla/show_bug.cgi?id=69866 42412063Sgabeblack@google.com if not GetOption('force_lto'): 42512063Sgabeblack@google.com main.Append(PSHLINKFLAGS='-flinker-output=rel') 42612063Sgabeblack@google.com main.Append(PLINKFLAGS='-flinker-output=rel') 42712063Sgabeblack@google.com 42810457Sandreas.hansson@arm.com # Make sure we warn if the user has requested to compile with the 42910457Sandreas.hansson@arm.com # Undefined Benahvior Sanitizer and this version of gcc does not 43010457Sandreas.hansson@arm.com # support it. 43110457Sandreas.hansson@arm.com if GetOption('with_ubsan') and \ 43210457Sandreas.hansson@arm.com compareVersions(gcc_version, '4.9') < 0: 43312563Sgabeblack@google.com print(termcap.Yellow + termcap.Bold + 43412563Sgabeblack@google.com 'Warning: UBSan is only supported using gcc 4.9 and later.' + 43512563Sgabeblack@google.com termcap.Normal) 43610457Sandreas.hansson@arm.com 43712063Sgabeblack@google.com disable_lto = GetOption('no_lto') 43812063Sgabeblack@google.com if not disable_lto and main.get('BROKEN_INCREMENTAL_LTO', False) and \ 43912063Sgabeblack@google.com not GetOption('force_lto'): 44012563Sgabeblack@google.com print(termcap.Yellow + termcap.Bold + 44112563Sgabeblack@google.com 'Warning: Your compiler doesn\'t support incremental linking' + 44212563Sgabeblack@google.com ' and lto at the same time, so lto is being disabled. To force' + 44312563Sgabeblack@google.com ' lto on anyway, use the --force-lto option. That will disable' + 44412563Sgabeblack@google.com ' partial linking.' + 44512563Sgabeblack@google.com termcap.Normal) 44612063Sgabeblack@google.com disable_lto = True 44712063Sgabeblack@google.com 44810238Sandreas.hansson@arm.com # Add the appropriate Link-Time Optimization (LTO) flags 44910238Sandreas.hansson@arm.com # unless LTO is explicitly turned off. Note that these flags 45010238Sandreas.hansson@arm.com # are only used by the fast target. 45112063Sgabeblack@google.com if not disable_lto: 45210238Sandreas.hansson@arm.com # Pass the LTO flag when compiling to produce GIMPLE 45310238Sandreas.hansson@arm.com # output, we merely create the flags here and only append 45410416Sandreas.hansson@arm.com # them later 45510238Sandreas.hansson@arm.com main['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')] 4569227Sandreas.hansson@arm.com 45710238Sandreas.hansson@arm.com # Use the same amount of jobs for LTO as we are running 45810416Sandreas.hansson@arm.com # scons with 45910416Sandreas.hansson@arm.com main['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs')] 4609227Sandreas.hansson@arm.com 4619590Sandreas@sandberg.pp.se main.Append(TCMALLOC_CCFLAGS=['-fno-builtin-malloc', '-fno-builtin-calloc', 4629590Sandreas@sandberg.pp.se '-fno-builtin-realloc', '-fno-builtin-free']) 4639590Sandreas@sandberg.pp.se 46412304Sgabeblack@google.com # The address sanitizer is available for gcc >= 4.8 46512304Sgabeblack@google.com if GetOption('with_asan'): 46612304Sgabeblack@google.com if GetOption('with_ubsan') and \ 46712688Sgiacomo.travaglini@arm.com compareVersions(main['GCC_VERSION'], '4.9') >= 0: 46812688Sgiacomo.travaglini@arm.com main.Append(CCFLAGS=['-fsanitize=address,undefined', 46912688Sgiacomo.travaglini@arm.com '-fno-omit-frame-pointer'], 47013020Sshunhsingou@google.com LINKFLAGS='-fsanitize=address,undefined') 47112304Sgabeblack@google.com else: 47212688Sgiacomo.travaglini@arm.com main.Append(CCFLAGS=['-fsanitize=address', 47312688Sgiacomo.travaglini@arm.com '-fno-omit-frame-pointer'], 47413020Sshunhsingou@google.com LINKFLAGS='-fsanitize=address') 47512304Sgabeblack@google.com # Only gcc >= 4.9 supports UBSan, so check both the version 47612304Sgabeblack@google.com # and the command-line option before adding the compiler and 47712304Sgabeblack@google.com # linker flags. 47812304Sgabeblack@google.com elif GetOption('with_ubsan') and \ 47912688Sgiacomo.travaglini@arm.com compareVersions(main['GCC_VERSION'], '4.9') >= 0: 48012688Sgiacomo.travaglini@arm.com main.Append(CCFLAGS='-fsanitize=undefined') 48112688Sgiacomo.travaglini@arm.com main.Append(LINKFLAGS='-fsanitize=undefined') 48212304Sgabeblack@google.com 4838737Skoansin.tan@gmail.comelif main['CLANG']: 48410878Sandreas.hansson@arm.com # Check for a supported version of clang, >= 3.1 is needed to 48511500Sandreas.hansson@arm.com # support similar features as gcc 4.8. See 4869420Sandreas.hansson@arm.com # http://clang.llvm.org/cxx_status.html for details 4878737Skoansin.tan@gmail.com clang_version_re = re.compile(".* version (\d+\.\d+)") 48810106SMitch.Hayenga@arm.com clang_version_match = clang_version_re.search(CXX_version) 4898737Skoansin.tan@gmail.com if (clang_version_match): 4908737Skoansin.tan@gmail.com clang_version = clang_version_match.groups()[0] 49110878Sandreas.hansson@arm.com if compareVersions(clang_version, "3.1") < 0: 49212563Sgabeblack@google.com print('Error: clang version 3.1 or newer required.') 49312563Sgabeblack@google.com print(' Installed version:', clang_version) 4948737Skoansin.tan@gmail.com Exit(1) 4958737Skoansin.tan@gmail.com else: 49612563Sgabeblack@google.com print('Error: Unable to determine clang version.') 4978737Skoansin.tan@gmail.com Exit(1) 4988737Skoansin.tan@gmail.com 49911294Sandreas.hansson@arm.com # clang has a few additional warnings that we disable, extraneous 5009556Sandreas.hansson@arm.com # parantheses are allowed due to Ruby's printing of the AST, 5019556Sandreas.hansson@arm.com # finally self assignments are allowed as the generated CPU code 5029556Sandreas.hansson@arm.com # is relying on this 50311294Sandreas.hansson@arm.com main.Append(CCFLAGS=['-Wno-parentheses', 50410278SAndreas.Sandberg@ARM.com '-Wno-self-assign', 50510278SAndreas.Sandberg@ARM.com # Some versions of libstdc++ (4.8?) seem to 50610278SAndreas.Sandberg@ARM.com # use struct hash and class hash 50710278SAndreas.Sandberg@ARM.com # interchangeably. 50810278SAndreas.Sandberg@ARM.com '-Wno-mismatched-tags', 50910278SAndreas.Sandberg@ARM.com ]) 5109556Sandreas.hansson@arm.com 5119590Sandreas@sandberg.pp.se main.Append(TCMALLOC_CCFLAGS=['-fno-builtin']) 5129590Sandreas@sandberg.pp.se 5139420Sandreas.hansson@arm.com # On Mac OS X/Darwin we need to also use libc++ (part of XCode) as 5149846Sandreas.hansson@arm.com # opposed to libstdc++, as the later is dated. 5159846Sandreas.hansson@arm.com if sys.platform == "darwin": 5169846Sandreas.hansson@arm.com main.Append(CXXFLAGS=['-stdlib=libc++']) 5179846Sandreas.hansson@arm.com main.Append(LIBS=['c++']) 5188946Sandreas.hansson@arm.com 51911811Sbaz21@cam.ac.uk # On FreeBSD we need libthr. 52011811Sbaz21@cam.ac.uk if sys.platform.startswith('freebsd'): 52111811Sbaz21@cam.ac.uk main.Append(LIBS=['thr']) 52211811Sbaz21@cam.ac.uk 52312304Sgabeblack@google.com # We require clang >= 3.1, so there is no need to check any 52412304Sgabeblack@google.com # versions here. 52512304Sgabeblack@google.com if GetOption('with_ubsan'): 52612304Sgabeblack@google.com if GetOption('with_asan'): 52713020Sshunhsingou@google.com main.Append(CCFLAGS=['-fsanitize=address,undefined', 52813020Sshunhsingou@google.com '-fno-omit-frame-pointer'], 52912304Sgabeblack@google.com LINKFLAGS='-fsanitize=address,undefined') 53012304Sgabeblack@google.com else: 53113020Sshunhsingou@google.com main.Append(CCFLAGS='-fsanitize=undefined', 53213020Sshunhsingou@google.com LINKFLAGS='-fsanitize=undefined') 53312304Sgabeblack@google.com 53412304Sgabeblack@google.com elif GetOption('with_asan'): 53513020Sshunhsingou@google.com main.Append(CCFLAGS=['-fsanitize=address', 53613020Sshunhsingou@google.com '-fno-omit-frame-pointer'], 53712304Sgabeblack@google.com LINKFLAGS='-fsanitize=address') 53812304Sgabeblack@google.com 5393918Ssaidi@eecs.umich.eduelse: 54012563Sgabeblack@google.com print(termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal, end=' ') 54112563Sgabeblack@google.com print("Don't know what compiler options to use for your compiler.") 54212563Sgabeblack@google.com print(termcap.Yellow + ' compiler:' + termcap.Normal, main['CXX']) 54312563Sgabeblack@google.com print(termcap.Yellow + ' version:' + termcap.Normal, end=' ') 5449068SAli.Saidi@ARM.com if not CXX_version: 54512563Sgabeblack@google.com print(termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" + 54612563Sgabeblack@google.com termcap.Normal) 5479068SAli.Saidi@ARM.com else: 54812563Sgabeblack@google.com print(CXX_version.replace('\n', '<nl>')) 54912563Sgabeblack@google.com print(" If you're trying to use a compiler other than GCC") 55012563Sgabeblack@google.com print(" or clang, there appears to be something wrong with your") 55112563Sgabeblack@google.com print(" environment.") 55212563Sgabeblack@google.com print(" ") 55312563Sgabeblack@google.com print(" If you are trying to use a compiler other than those listed") 55412563Sgabeblack@google.com print(" above you will need to ease fix SConstruct and ") 55512563Sgabeblack@google.com print(" src/SConscript to support that compiler.") 5563918Ssaidi@eecs.umich.edu Exit(1) 5573918Ssaidi@eecs.umich.edu 5586157Snate@binkert.org# Set up common yacc/bison flags (needed for Ruby) 5596157Snate@binkert.orgmain['YACCFLAGS'] = '-d' 5606157Snate@binkert.orgmain['YACCHXXFILESUFFIX'] = '.hh' 5616157Snate@binkert.org 5625397Ssaidi@eecs.umich.edu# Do this after we save setting back, or else we'll tack on an 5635397Ssaidi@eecs.umich.edu# extra 'qdo' every time we run scons. 5646121Snate@binkert.orgif main['BATCH']: 5656121Snate@binkert.org main['CC'] = main['BATCH_CMD'] + ' ' + main['CC'] 5666121Snate@binkert.org main['CXX'] = main['BATCH_CMD'] + ' ' + main['CXX'] 5676121Snate@binkert.org main['AS'] = main['BATCH_CMD'] + ' ' + main['AS'] 5686121Snate@binkert.org main['AR'] = main['BATCH_CMD'] + ' ' + main['AR'] 5696121Snate@binkert.org main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB'] 5705397Ssaidi@eecs.umich.edu 5711851SN/Aif sys.platform == 'cygwin': 5721851SN/A # cygwin has some header file issues... 5737739Sgblack@eecs.umich.edu main.Append(CCFLAGS=["-Wno-uninitialized"]) 574955SN/A 5759396Sandreas.hansson@arm.com# Check for the protobuf compiler 5769396Sandreas.hansson@arm.comprotoc_version = readCommand([main['PROTOC'], '--version'], 5779396Sandreas.hansson@arm.com exception='').split() 5789396Sandreas.hansson@arm.com 5799396Sandreas.hansson@arm.com# First two words should be "libprotoc x.y.z" 5809396Sandreas.hansson@arm.comif len(protoc_version) < 2 or protoc_version[0] != 'libprotoc': 58112563Sgabeblack@google.com print(termcap.Yellow + termcap.Bold + 58212563Sgabeblack@google.com 'Warning: Protocol buffer compiler (protoc) not found.\n' + 58312563Sgabeblack@google.com ' Please install protobuf-compiler for tracing support.' + 58412563Sgabeblack@google.com termcap.Normal) 5859396Sandreas.hansson@arm.com main['PROTOC'] = False 5869396Sandreas.hansson@arm.comelse: 5879396Sandreas.hansson@arm.com # Based on the availability of the compress stream wrappers, 5889396Sandreas.hansson@arm.com # require 2.1.0 5899396Sandreas.hansson@arm.com min_protoc_version = '2.1.0' 5909396Sandreas.hansson@arm.com if compareVersions(protoc_version[1], min_protoc_version) < 0: 59112563Sgabeblack@google.com print(termcap.Yellow + termcap.Bold + 59212563Sgabeblack@google.com 'Warning: protoc version', min_protoc_version, 59312563Sgabeblack@google.com 'or newer required.\n' + 59412563Sgabeblack@google.com ' Installed version:', protoc_version[1], 59512563Sgabeblack@google.com termcap.Normal) 5969477Sandreas.hansson@arm.com main['PROTOC'] = False 5979477Sandreas.hansson@arm.com else: 5989477Sandreas.hansson@arm.com # Attempt to determine the appropriate include path and 5999477Sandreas.hansson@arm.com # library path using pkg-config, that means we also need to 6009477Sandreas.hansson@arm.com # check for pkg-config. Note that it is possible to use 6019477Sandreas.hansson@arm.com # protobuf without the involvement of pkg-config. Later on we 6029477Sandreas.hansson@arm.com # check go a library config check and at that point the test 6039477Sandreas.hansson@arm.com # will fail if libprotobuf cannot be found. 6049477Sandreas.hansson@arm.com if readCommand(['pkg-config', '--version'], exception=''): 6059477Sandreas.hansson@arm.com try: 6069477Sandreas.hansson@arm.com # Attempt to establish what linking flags to add for protobuf 6079477Sandreas.hansson@arm.com # using pkg-config 6089477Sandreas.hansson@arm.com main.ParseConfig('pkg-config --cflags --libs-only-L protobuf') 6099477Sandreas.hansson@arm.com except: 61012563Sgabeblack@google.com print(termcap.Yellow + termcap.Bold + 61112563Sgabeblack@google.com 'Warning: pkg-config could not get protobuf flags.' + 61212563Sgabeblack@google.com termcap.Normal) 6139396Sandreas.hansson@arm.com 6142667Sstever@eecs.umich.edu 61510710Sandreas.hansson@arm.com# Check for 'timeout' from GNU coreutils. If present, regressions will 61610710Sandreas.hansson@arm.com# be run with a time limit. We require version 8.13 since we rely on 61710710Sandreas.hansson@arm.com# support for the '--foreground' option. 61811811Sbaz21@cam.ac.ukif sys.platform.startswith('freebsd'): 61911811Sbaz21@cam.ac.uk timeout_lines = readCommand(['gtimeout', '--version'], 62011811Sbaz21@cam.ac.uk exception='').splitlines() 62111811Sbaz21@cam.ac.ukelse: 62211811Sbaz21@cam.ac.uk timeout_lines = readCommand(['timeout', '--version'], 62311811Sbaz21@cam.ac.uk exception='').splitlines() 62410710Sandreas.hansson@arm.com# Get the first line and tokenize it 62510710Sandreas.hansson@arm.comtimeout_version = timeout_lines[0].split() if timeout_lines else [] 62610710Sandreas.hansson@arm.commain['TIMEOUT'] = timeout_version and \ 62710710Sandreas.hansson@arm.com compareVersions(timeout_version[-1], '8.13') >= 0 62810384SCurtis.Dunham@arm.com 6299986Sandreas@sandberg.pp.se# Add a custom Check function to test for structure members. 6309986Sandreas@sandberg.pp.sedef CheckMember(context, include, decl, member, include_quotes="<>"): 6319986Sandreas@sandberg.pp.se context.Message("Checking for member %s in %s..." % 6329986Sandreas@sandberg.pp.se (member, decl)) 6339986Sandreas@sandberg.pp.se text = """ 6349986Sandreas@sandberg.pp.se#include %(header)s 6359986Sandreas@sandberg.pp.seint main(){ 6369986Sandreas@sandberg.pp.se %(decl)s test; 6379986Sandreas@sandberg.pp.se (void)test.%(member)s; 6389986Sandreas@sandberg.pp.se return 0; 6399986Sandreas@sandberg.pp.se}; 6409986Sandreas@sandberg.pp.se""" % { "header" : include_quotes[0] + include + include_quotes[1], 6419986Sandreas@sandberg.pp.se "decl" : decl, 6429986Sandreas@sandberg.pp.se "member" : member, 6439986Sandreas@sandberg.pp.se } 6449986Sandreas@sandberg.pp.se 6459986Sandreas@sandberg.pp.se ret = context.TryCompile(text, extension=".cc") 6469986Sandreas@sandberg.pp.se context.Result(ret) 6479986Sandreas@sandberg.pp.se return ret 6489986Sandreas@sandberg.pp.se 6492638Sstever@eecs.umich.edu# Platform-specific configuration. Note again that we assume that all 6502638Sstever@eecs.umich.edu# builds under a given build root run on the same host platform. 6516121Snate@binkert.orgconf = Configure(main, 6523716Sstever@eecs.umich.edu conf_dir = joinpath(build_root, '.scons_config'), 6535522Snate@binkert.org log_file = joinpath(build_root, 'scons_config.log'), 6549986Sandreas@sandberg.pp.se custom_tests = { 6559986Sandreas@sandberg.pp.se 'CheckMember' : CheckMember, 6569986Sandreas@sandberg.pp.se }) 6575522Snate@binkert.org 6585227Ssaidi@eecs.umich.edu# Check if we should compile a 64 bit binary on Mac OS X/Darwin 6595227Ssaidi@eecs.umich.edutry: 6605227Ssaidi@eecs.umich.edu import platform 6615227Ssaidi@eecs.umich.edu uname = platform.uname() 6626654Snate@binkert.org if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0: 6636654Snate@binkert.org if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]): 6647769SAli.Saidi@ARM.com main.Append(CCFLAGS=['-arch', 'x86_64']) 6657769SAli.Saidi@ARM.com main.Append(CFLAGS=['-arch', 'x86_64']) 6667769SAli.Saidi@ARM.com main.Append(LINKFLAGS=['-arch', 'x86_64']) 6677769SAli.Saidi@ARM.com main.Append(ASFLAGS=['-arch', 'x86_64']) 6685227Ssaidi@eecs.umich.eduexcept: 6695227Ssaidi@eecs.umich.edu pass 6705227Ssaidi@eecs.umich.edu 6715204Sstever@gmail.com# Recent versions of scons substitute a "Null" object for Configure() 6725204Sstever@gmail.com# when configuration isn't necessary, e.g., if the "--help" option is 6735204Sstever@gmail.com# present. Unfortuantely this Null object always returns false, 6745204Sstever@gmail.com# breaking all our configuration checks. We replace it with our own 6755204Sstever@gmail.com# more optimistic null object that returns True instead. 6765204Sstever@gmail.comif not conf: 6775204Sstever@gmail.com def NullCheck(*args, **kwargs): 6785204Sstever@gmail.com return True 6795204Sstever@gmail.com 6805204Sstever@gmail.com class NullConf: 6815204Sstever@gmail.com def __init__(self, env): 6825204Sstever@gmail.com self.env = env 6835204Sstever@gmail.com def Finish(self): 6845204Sstever@gmail.com return self.env 6855204Sstever@gmail.com def __getattr__(self, mname): 6865204Sstever@gmail.com return NullCheck 6875204Sstever@gmail.com 6886121Snate@binkert.org conf = NullConf(main) 6895204Sstever@gmail.com 6907727SAli.Saidi@ARM.com# Cache build files in the supplied directory. 6917727SAli.Saidi@ARM.comif main['M5_BUILD_CACHE']: 69212563Sgabeblack@google.com print('Using build cache located at', main['M5_BUILD_CACHE']) 6937727SAli.Saidi@ARM.com CacheDir(main['M5_BUILD_CACHE']) 6947727SAli.Saidi@ARM.com 69511988Sandreas.sandberg@arm.commain['USE_PYTHON'] = not GetOption('without_python') 69611988Sandreas.sandberg@arm.comif main['USE_PYTHON']: 69710453SAndrew.Bardsley@arm.com # Find Python include and library directories for embedding the 69810453SAndrew.Bardsley@arm.com # interpreter. We rely on python-config to resolve the appropriate 69910453SAndrew.Bardsley@arm.com # includes and linker flags. ParseConfig does not seem to understand 70010453SAndrew.Bardsley@arm.com # the more exotic linker flags such as -Xlinker and -export-dynamic so 70110453SAndrew.Bardsley@arm.com # we add them explicitly below. If you want to link in an alternate 70210453SAndrew.Bardsley@arm.com # version of python, see above for instructions on how to invoke 70310453SAndrew.Bardsley@arm.com # scons with the appropriate PATH set. 70410453SAndrew.Bardsley@arm.com # 70510453SAndrew.Bardsley@arm.com # First we check if python2-config exists, else we use python-config 70610453SAndrew.Bardsley@arm.com python_config = readCommand(['which', 'python2-config'], 70710160Sandreas.hansson@arm.com exception='').strip() 70810453SAndrew.Bardsley@arm.com if not os.path.exists(python_config): 70910453SAndrew.Bardsley@arm.com python_config = readCommand(['which', 'python-config'], 71010453SAndrew.Bardsley@arm.com exception='').strip() 71110453SAndrew.Bardsley@arm.com py_includes = readCommand([python_config, '--includes'], 71210453SAndrew.Bardsley@arm.com exception='').split() 71310453SAndrew.Bardsley@arm.com # Strip the -I from the include folders before adding them to the 71410453SAndrew.Bardsley@arm.com # CPPPATH 71510453SAndrew.Bardsley@arm.com main.Append(CPPPATH=map(lambda inc: inc[2:], py_includes)) 7169812Sandreas.hansson@arm.com 71710453SAndrew.Bardsley@arm.com # Read the linker flags and split them into libraries and other link 71810453SAndrew.Bardsley@arm.com # flags. The libraries are added later through the call the CheckLib. 71910453SAndrew.Bardsley@arm.com py_ld_flags = readCommand([python_config, '--ldflags'], 72010453SAndrew.Bardsley@arm.com exception='').split() 72110453SAndrew.Bardsley@arm.com py_libs = [] 72210453SAndrew.Bardsley@arm.com for lib in py_ld_flags: 72310453SAndrew.Bardsley@arm.com if not lib.startswith('-l'): 72410453SAndrew.Bardsley@arm.com main.Append(LINKFLAGS=[lib]) 72510453SAndrew.Bardsley@arm.com else: 72610453SAndrew.Bardsley@arm.com lib = lib[2:] 72710453SAndrew.Bardsley@arm.com if lib not in py_libs: 72810453SAndrew.Bardsley@arm.com py_libs.append(lib) 7297727SAli.Saidi@ARM.com 73010453SAndrew.Bardsley@arm.com # verify that this stuff works 73110453SAndrew.Bardsley@arm.com if not conf.CheckHeader('Python.h', '<>'): 73212790Smatteo.fusi@bsc.es print("Error: Check failed for Python.h header in", py_includes) 73312790Smatteo.fusi@bsc.es print("Two possible reasons:") 73412790Smatteo.fusi@bsc.es print("1. Python headers are not installed (You can install the " 73512790Smatteo.fusi@bsc.es "package python-dev on Ubuntu and RedHat)") 73612790Smatteo.fusi@bsc.es print("2. SCons is using a wrong C compiler. This can happen if " 73712790Smatteo.fusi@bsc.es "CC has the wrong value.") 73812790Smatteo.fusi@bsc.es print("CC = %s" % main['CC']) 73910453SAndrew.Bardsley@arm.com Exit(1) 7403118Sstever@eecs.umich.edu 74110453SAndrew.Bardsley@arm.com for lib in py_libs: 74210453SAndrew.Bardsley@arm.com if not conf.CheckLib(lib): 74312563Sgabeblack@google.com print("Error: can't find library %s required by python" % lib) 74410453SAndrew.Bardsley@arm.com Exit(1) 7453118Sstever@eecs.umich.edu 7463483Ssaidi@eecs.umich.edu# On Solaris you need to use libsocket for socket ops 7473494Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'): 7483494Ssaidi@eecs.umich.edu if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'): 74912563Sgabeblack@google.com print("Can't find library with socket calls (e.g. accept())") 7503483Ssaidi@eecs.umich.edu Exit(1) 7513483Ssaidi@eecs.umich.edu 7523053Sstever@eecs.umich.edu# Check for zlib. If the check passes, libz will be automatically 7533053Sstever@eecs.umich.edu# added to the LIBS environment variable. 7543918Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'): 75512563Sgabeblack@google.com print('Error: did not find needed zlib compression library ' 75612563Sgabeblack@google.com 'and/or zlib.h header file.') 75712563Sgabeblack@google.com print(' Please install zlib and try again.') 7583053Sstever@eecs.umich.edu Exit(1) 7593053Sstever@eecs.umich.edu 7609396Sandreas.hansson@arm.com# If we have the protobuf compiler, also make sure we have the 7619396Sandreas.hansson@arm.com# development libraries. If the check passes, libprotobuf will be 7629396Sandreas.hansson@arm.com# automatically added to the LIBS environment variable. After 7639396Sandreas.hansson@arm.com# this, we can use the HAVE_PROTOBUF flag to determine if we have 7649396Sandreas.hansson@arm.com# got both protoc and libprotobuf available. 7659396Sandreas.hansson@arm.commain['HAVE_PROTOBUF'] = main['PROTOC'] and \ 7669396Sandreas.hansson@arm.com conf.CheckLibWithHeader('protobuf', 'google/protobuf/message.h', 7679396Sandreas.hansson@arm.com 'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;') 7689396Sandreas.hansson@arm.com 76912920Sgabeblack@google.com# Valgrind gets much less confused if you tell it when you're using 77012920Sgabeblack@google.com# alternative stacks. 77112920Sgabeblack@google.commain['HAVE_VALGRIND'] = conf.CheckCHeader('valgrind/valgrind.h') 77212920Sgabeblack@google.com 7739477Sandreas.hansson@arm.com# If we have the compiler but not the library, print another warning. 7749396Sandreas.hansson@arm.comif main['PROTOC'] and not main['HAVE_PROTOBUF']: 77512563Sgabeblack@google.com print(termcap.Yellow + termcap.Bold + 77612563Sgabeblack@google.com 'Warning: did not find protocol buffer library and/or headers.\n' + 77712563Sgabeblack@google.com ' Please install libprotobuf-dev for tracing support.' + 77812563Sgabeblack@google.com termcap.Normal) 7799396Sandreas.hansson@arm.com 7807840Snate@binkert.org# Check for librt. 7817865Sgblack@eecs.umich.eduhave_posix_clock = \ 7827865Sgblack@eecs.umich.edu conf.CheckLibWithHeader(None, 'time.h', 'C', 7837865Sgblack@eecs.umich.edu 'clock_nanosleep(0,0,NULL,NULL);') or \ 7847865Sgblack@eecs.umich.edu conf.CheckLibWithHeader('rt', 'time.h', 'C', 7857865Sgblack@eecs.umich.edu 'clock_nanosleep(0,0,NULL,NULL);') 7867840Snate@binkert.org 7879900Sandreas@sandberg.pp.sehave_posix_timers = \ 7889900Sandreas@sandberg.pp.se conf.CheckLibWithHeader([None, 'rt'], [ 'time.h', 'signal.h' ], 'C', 7899900Sandreas@sandberg.pp.se 'timer_create(CLOCK_MONOTONIC, NULL, NULL);') 7909900Sandreas@sandberg.pp.se 79110456SCurtis.Dunham@arm.comif not GetOption('without_tcmalloc'): 79210456SCurtis.Dunham@arm.com if conf.CheckLib('tcmalloc'): 79310456SCurtis.Dunham@arm.com main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS']) 79410456SCurtis.Dunham@arm.com elif conf.CheckLib('tcmalloc_minimal'): 79510456SCurtis.Dunham@arm.com main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS']) 79610456SCurtis.Dunham@arm.com else: 79712563Sgabeblack@google.com print(termcap.Yellow + termcap.Bold + 79812563Sgabeblack@google.com "You can get a 12% performance improvement by " 79912563Sgabeblack@google.com "installing tcmalloc (libgoogle-perftools-dev package " 80012563Sgabeblack@google.com "on Ubuntu or RedHat)." + termcap.Normal) 8019045SAli.Saidi@ARM.com 80211235Sandreas.sandberg@arm.com 80311235Sandreas.sandberg@arm.com# Detect back trace implementations. The last implementation in the 80411235Sandreas.sandberg@arm.com# list will be used by default. 80511235Sandreas.sandberg@arm.combacktrace_impls = [ "none" ] 80611235Sandreas.sandberg@arm.com 80712485Sjang.hanhwi@gmail.combacktrace_checker = 'char temp;' + \ 80812485Sjang.hanhwi@gmail.com ' backtrace_symbols_fd((void*)&temp, 0, 0);' 80912485Sjang.hanhwi@gmail.comif conf.CheckLibWithHeader(None, 'execinfo.h', 'C', backtrace_checker): 81011235Sandreas.sandberg@arm.com backtrace_impls.append("glibc") 81111811Sbaz21@cam.ac.ukelif conf.CheckLibWithHeader('execinfo', 'execinfo.h', 'C', 81212485Sjang.hanhwi@gmail.com backtrace_checker): 81311811Sbaz21@cam.ac.uk # NetBSD and FreeBSD need libexecinfo. 81411811Sbaz21@cam.ac.uk backtrace_impls.append("glibc") 81511811Sbaz21@cam.ac.uk main.Append(LIBS=['execinfo']) 81611235Sandreas.sandberg@arm.com 81711235Sandreas.sandberg@arm.comif backtrace_impls[-1] == "none": 81811235Sandreas.sandberg@arm.com default_backtrace_impl = "none" 81912563Sgabeblack@google.com print(termcap.Yellow + termcap.Bold + 82012563Sgabeblack@google.com "No suitable back trace implementation found." + 82112563Sgabeblack@google.com termcap.Normal) 82211235Sandreas.sandberg@arm.com 8237840Snate@binkert.orgif not have_posix_clock: 82412563Sgabeblack@google.com print("Can't find library for POSIX clocks.") 8257840Snate@binkert.org 8261858SN/A# Check for <fenv.h> (C99 FP environment control) 8271858SN/Ahave_fenv = conf.CheckHeader('fenv.h', '<>') 8281858SN/Aif not have_fenv: 82912563Sgabeblack@google.com print("Warning: Header file <fenv.h> not found.") 83012563Sgabeblack@google.com print(" This host has no IEEE FP rounding mode control.") 8311858SN/A 83212230Sgiacomo.travaglini@arm.com# Check for <png.h> (libpng library needed if wanting to dump 83312230Sgiacomo.travaglini@arm.com# frame buffer image in png format) 83412230Sgiacomo.travaglini@arm.comhave_png = conf.CheckHeader('png.h', '<>') 83512230Sgiacomo.travaglini@arm.comif not have_png: 83612563Sgabeblack@google.com print("Warning: Header file <png.h> not found.") 83712563Sgabeblack@google.com print(" This host has no libpng library.") 83812563Sgabeblack@google.com print(" Disabling support for PNG framebuffers.") 83912230Sgiacomo.travaglini@arm.com 8409903Sandreas.hansson@arm.com# Check if we should enable KVM-based hardware virtualization. The API 8419903Sandreas.hansson@arm.com# we rely on exists since version 2.6.36 of the kernel, but somehow 8429903Sandreas.hansson@arm.com# the KVM_API_VERSION does not reflect the change. We test for one of 8439903Sandreas.hansson@arm.com# the types as a fall back. 84410841Sandreas.sandberg@arm.comhave_kvm = conf.CheckHeader('linux/kvm.h', '<>') 8459651SAndreas.Sandberg@ARM.comif not have_kvm: 84612563Sgabeblack@google.com print("Info: Compatible header file <linux/kvm.h> not found, " 84712563Sgabeblack@google.com "disabling KVM support.") 8489651SAndreas.Sandberg@ARM.com 84912056Sgabeblack@google.com# Check if the TUN/TAP driver is available. 85012056Sgabeblack@google.comhave_tuntap = conf.CheckHeader('linux/if_tun.h', '<>') 85112056Sgabeblack@google.comif not have_tuntap: 85212563Sgabeblack@google.com print("Info: Compatible header file <linux/if_tun.h> not found.") 85312056Sgabeblack@google.com 85410841Sandreas.sandberg@arm.com# x86 needs support for xsave. We test for the structure here since we 85510841Sandreas.sandberg@arm.com# won't be able to run new tests by the time we know which ISA we're 85610841Sandreas.sandberg@arm.com# targeting. 85710841Sandreas.sandberg@arm.comhave_kvm_xsave = conf.CheckTypeSize('struct kvm_xsave', 85810841Sandreas.sandberg@arm.com '#include <linux/kvm.h>') != 0 85910841Sandreas.sandberg@arm.com 8609651SAndreas.Sandberg@ARM.com# Check if the requested target ISA is compatible with the host 8619651SAndreas.Sandberg@ARM.comdef is_isa_kvm_compatible(isa): 8629651SAndreas.Sandberg@ARM.com try: 8639651SAndreas.Sandberg@ARM.com import platform 8649651SAndreas.Sandberg@ARM.com host_isa = platform.machine() 8659651SAndreas.Sandberg@ARM.com except: 86612563Sgabeblack@google.com print("Warning: Failed to determine host ISA.") 8679651SAndreas.Sandberg@ARM.com return False 8689651SAndreas.Sandberg@ARM.com 86910841Sandreas.sandberg@arm.com if not have_posix_timers: 87012563Sgabeblack@google.com print("Warning: Can not enable KVM, host seems to lack support " 87112563Sgabeblack@google.com "for POSIX timers") 87210841Sandreas.sandberg@arm.com return False 87310841Sandreas.sandberg@arm.com 87410841Sandreas.sandberg@arm.com if isa == "arm": 87510860Sandreas.sandberg@arm.com return host_isa in ( "armv7l", "aarch64" ) 87610841Sandreas.sandberg@arm.com elif isa == "x86": 87710841Sandreas.sandberg@arm.com if host_isa != "x86_64": 87810841Sandreas.sandberg@arm.com return False 87910841Sandreas.sandberg@arm.com 88010841Sandreas.sandberg@arm.com if not have_kvm_xsave: 88112563Sgabeblack@google.com print("KVM on x86 requires xsave support in kernel headers.") 88210841Sandreas.sandberg@arm.com return False 88310841Sandreas.sandberg@arm.com 88410841Sandreas.sandberg@arm.com return True 88510841Sandreas.sandberg@arm.com else: 88610841Sandreas.sandberg@arm.com return False 8879651SAndreas.Sandberg@ARM.com 8889651SAndreas.Sandberg@ARM.com 8899986Sandreas@sandberg.pp.se# Check if the exclude_host attribute is available. We want this to 8909986Sandreas@sandberg.pp.se# get accurate instruction counts in KVM. 8919986Sandreas@sandberg.pp.semain['HAVE_PERF_ATTR_EXCLUDE_HOST'] = conf.CheckMember( 8929986Sandreas@sandberg.pp.se 'linux/perf_event.h', 'struct perf_event_attr', 'exclude_host') 8939986Sandreas@sandberg.pp.se 8949986Sandreas@sandberg.pp.se 8955863Snate@binkert.org###################################################################### 8965863Snate@binkert.org# 8975863Snate@binkert.org# Finish the configuration 8985863Snate@binkert.org# 8996121Snate@binkert.orgmain = conf.Finish() 9001858SN/A 9015863Snate@binkert.org###################################################################### 9025863Snate@binkert.org# 9035863Snate@binkert.org# Collect all non-global variables 9045863Snate@binkert.org# 9055863Snate@binkert.org 9062139SN/A# Define the universe of supported ISAs 9074202Sbinkertn@umich.eduall_isa_list = [ ] 90811308Santhony.gutierrez@amd.comall_gpu_isa_list = [ ] 9094202Sbinkertn@umich.eduExport('all_isa_list') 91011308Santhony.gutierrez@amd.comExport('all_gpu_isa_list') 9112139SN/A 9126994Snate@binkert.orgclass CpuModel(object): 9136994Snate@binkert.org '''The CpuModel class encapsulates everything the ISA parser needs to 9146994Snate@binkert.org know about a particular CPU model.''' 9156994Snate@binkert.org 9166994Snate@binkert.org # Dict of available CPU model objects. Accessible as CpuModel.dict. 9176994Snate@binkert.org dict = {} 9186994Snate@binkert.org 9196994Snate@binkert.org # Constructor. Automatically adds models to CpuModel.dict. 92010319SAndreas.Sandberg@ARM.com def __init__(self, name, default=False): 9216994Snate@binkert.org self.name = name # name of model 9226994Snate@binkert.org 9236994Snate@binkert.org # This cpu is enabled by default 9246994Snate@binkert.org self.default = default 9256994Snate@binkert.org 9266994Snate@binkert.org # Add self to dict 9276994Snate@binkert.org if name in CpuModel.dict: 9286994Snate@binkert.org raise AttributeError, "CpuModel '%s' already registered" % name 9296994Snate@binkert.org CpuModel.dict[name] = self 9306994Snate@binkert.org 9316994Snate@binkert.orgExport('CpuModel') 9322155SN/A 9335863Snate@binkert.org# Sticky variables get saved in the variables file so they persist from 9341869SN/A# one invocation to the next (unless overridden, in which case the new 9351869SN/A# value becomes sticky). 9365863Snate@binkert.orgsticky_vars = Variables(args=ARGUMENTS) 9375863Snate@binkert.orgExport('sticky_vars') 9384202Sbinkertn@umich.edu 9396108Snate@binkert.org# Sticky variables that should be exported 9406108Snate@binkert.orgexport_vars = [] 9416108Snate@binkert.orgExport('export_vars') 9426108Snate@binkert.org 9439219Spower.jg@gmail.com# For Ruby 9449219Spower.jg@gmail.comall_protocols = [] 9459219Spower.jg@gmail.comExport('all_protocols') 9469219Spower.jg@gmail.comprotocol_dirs = [] 9479219Spower.jg@gmail.comExport('protocol_dirs') 9489219Spower.jg@gmail.comslicc_includes = [] 9499219Spower.jg@gmail.comExport('slicc_includes') 9509219Spower.jg@gmail.com 9514202Sbinkertn@umich.edu# Walk the tree and execute all SConsopts scripts that wil add to the 9525863Snate@binkert.org# above variables 95310135SCurtis.Dunham@arm.comif GetOption('verbose'): 95412563Sgabeblack@google.com print("Reading SConsopts") 9555742Snate@binkert.orgfor bdir in [ base_dir ] + extras_dir_list: 9568268Ssteve.reinhardt@amd.com if not isdir(bdir): 95712563Sgabeblack@google.com print("Error: directory '%s' does not exist" % bdir) 9588268Ssteve.reinhardt@amd.com Exit(1) 9595742Snate@binkert.org for root, dirs, files in os.walk(bdir): 9605341Sstever@gmail.com if 'SConsopts' in files: 9618474Sgblack@eecs.umich.edu if GetOption('verbose'): 96212563Sgabeblack@google.com print("Reading", joinpath(root, 'SConsopts')) 9635342Sstever@gmail.com SConscript(joinpath(root, 'SConsopts')) 9644202Sbinkertn@umich.edu 9654202Sbinkertn@umich.eduall_isa_list.sort() 96611308Santhony.gutierrez@amd.comall_gpu_isa_list.sort() 9674202Sbinkertn@umich.edu 9685863Snate@binkert.orgsticky_vars.AddVariables( 9695863Snate@binkert.org EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list), 97011308Santhony.gutierrez@amd.com EnumVariable('TARGET_GPU_ISA', 'Target GPU ISA', 'hsail', all_gpu_isa_list), 9716994Snate@binkert.org ListVariable('CPU_MODELS', 'CPU models', 9726994Snate@binkert.org sorted(n for n,m in CpuModel.dict.iteritems() if m.default), 97310319SAndreas.Sandberg@ARM.com sorted(CpuModel.dict.keys())), 9745863Snate@binkert.org BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger', 9755863Snate@binkert.org False), 9765863Snate@binkert.org BoolVariable('SS_COMPATIBLE_FP', 9775863Snate@binkert.org 'Make floating-point results compatible with SimpleScalar', 9785863Snate@binkert.org False), 9795863Snate@binkert.org BoolVariable('USE_SSE2', 9805863Snate@binkert.org 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts', 9815863Snate@binkert.org False), 9827840Snate@binkert.org BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock), 9835863Snate@binkert.org BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv), 98412230Sgiacomo.travaglini@arm.com BoolVariable('USE_PNG', 'Enable support for PNG images', have_png), 98512230Sgiacomo.travaglini@arm.com BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', 98612230Sgiacomo.travaglini@arm.com False), 98712230Sgiacomo.travaglini@arm.com BoolVariable('USE_KVM', 'Enable hardware virtualized (KVM) CPU models', 98812230Sgiacomo.travaglini@arm.com have_kvm), 98912056Sgabeblack@google.com BoolVariable('USE_TUNTAP', 99012056Sgabeblack@google.com 'Enable using a tap device to bridge to the host network', 99112056Sgabeblack@google.com have_tuntap), 99211308Santhony.gutierrez@amd.com BoolVariable('BUILD_GPU', 'Build the compute-GPU model', False), 9939219Spower.jg@gmail.com EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None', 9949219Spower.jg@gmail.com all_protocols), 99511235Sandreas.sandberg@arm.com EnumVariable('BACKTRACE_IMPL', 'Post-mortem dump implementation', 99611235Sandreas.sandberg@arm.com backtrace_impls[-1], backtrace_impls) 9971869SN/A ) 9981858SN/A 9995863Snate@binkert.org# These variables get exported to #defines in config/*.hh (see src/SConscript). 100011308Santhony.gutierrez@amd.comexport_vars += ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'TARGET_GPU_ISA', 100112061Sjason@lowepower.com 'CP_ANNOTATE', 'USE_POSIX_CLOCK', 'USE_KVM', 'USE_TUNTAP', 100212920Sgabeblack@google.com 'PROTOCOL', 'HAVE_PROTOBUF', 'HAVE_VALGRIND', 100312920Sgabeblack@google.com 'HAVE_PERF_ATTR_EXCLUDE_HOST', 'USE_PNG'] 10041858SN/A 1005955SN/A################################################### 1006955SN/A# 10071869SN/A# Define a SCons builder for configuration flag headers. 10081869SN/A# 10091869SN/A################################################### 10101869SN/A 10111869SN/A# This function generates a config header file that #defines the 10125863Snate@binkert.org# variable symbol to the current variable setting (0 or 1). The source 10135863Snate@binkert.org# operands are the name of the variable and a Value node containing the 10145863Snate@binkert.org# value of the variable. 10151869SN/Adef build_config_file(target, source, env): 10165863Snate@binkert.org (variable, value) = [s.get_contents() for s in source] 10171869SN/A f = file(str(target[0]), 'w') 101812563Sgabeblack@google.com print('#define', variable, value, file=f) 10191869SN/A f.close() 10201869SN/A return None 10211869SN/A 10221869SN/A# Combine the two functions into a scons Action object. 10238483Sgblack@eecs.umich.educonfig_action = MakeAction(build_config_file, Transform("CONFIG H", 2)) 10241869SN/A 10251869SN/A# The emitter munges the source & target node lists to reflect what 10261869SN/A# we're really doing. 10271869SN/Adef config_emitter(target, source, env): 10285863Snate@binkert.org # extract variable name from Builder arg 10295863Snate@binkert.org variable = str(target[0]) 10301869SN/A # True target is config header file 10315863Snate@binkert.org target = joinpath('config', variable.lower() + '.hh') 10325863Snate@binkert.org val = env[variable] 10333356Sbinkertn@umich.edu if isinstance(val, bool): 10343356Sbinkertn@umich.edu # Force value to 0/1 10353356Sbinkertn@umich.edu val = int(val) 10363356Sbinkertn@umich.edu elif isinstance(val, str): 10373356Sbinkertn@umich.edu val = '"' + val + '"' 10384781Snate@binkert.org 10395863Snate@binkert.org # Sources are variable name & value (packaged in SCons Value nodes) 10405863Snate@binkert.org return ([target], [Value(variable), Value(val)]) 10411869SN/A 10421869SN/Aconfig_builder = Builder(emitter = config_emitter, action = config_action) 10431869SN/A 10446121Snate@binkert.orgmain.Append(BUILDERS = { 'ConfigFile' : config_builder }) 10451869SN/A 104611982Sgabeblack@google.com################################################### 104711982Sgabeblack@google.com# 104811982Sgabeblack@google.com# Builders for static and shared partially linked object files. 104911982Sgabeblack@google.com# 105011982Sgabeblack@google.com################################################### 105111982Sgabeblack@google.com 105211982Sgabeblack@google.compartial_static_builder = Builder(action=SCons.Defaults.LinkAction, 105311982Sgabeblack@google.com src_suffix='$OBJSUFFIX', 105411982Sgabeblack@google.com src_builder=['StaticObject', 'Object'], 105511982Sgabeblack@google.com LINKFLAGS='$PLINKFLAGS', 105611982Sgabeblack@google.com LIBS='') 105711982Sgabeblack@google.com 105811982Sgabeblack@google.comdef partial_shared_emitter(target, source, env): 105911982Sgabeblack@google.com for tgt in target: 106011982Sgabeblack@google.com tgt.attributes.shared = 1 106111982Sgabeblack@google.com return (target, source) 106211982Sgabeblack@google.compartial_shared_builder = Builder(action=SCons.Defaults.ShLinkAction, 106311982Sgabeblack@google.com emitter=partial_shared_emitter, 106411982Sgabeblack@google.com src_suffix='$SHOBJSUFFIX', 106511982Sgabeblack@google.com src_builder='SharedObject', 106611982Sgabeblack@google.com SHLINKFLAGS='$PSHLINKFLAGS', 106711982Sgabeblack@google.com LIBS='') 106811982Sgabeblack@google.com 106911982Sgabeblack@google.commain.Append(BUILDERS = { 'PartialShared' : partial_shared_builder, 107011982Sgabeblack@google.com 'PartialStatic' : partial_static_builder }) 107111982Sgabeblack@google.com 107211978Sgabeblack@google.com# builds in ext are shared across all configs in the build root. 107311978Sgabeblack@google.comext_dir = abspath(joinpath(str(main.root), 'ext')) 107412034Sgabeblack@google.comext_build_dirs = [] 107511978Sgabeblack@google.comfor root, dirs, files in os.walk(ext_dir): 107611978Sgabeblack@google.com if 'SConscript' in files: 107711978Sgabeblack@google.com build_dir = os.path.relpath(root, ext_dir) 107812034Sgabeblack@google.com ext_build_dirs.append(build_dir) 107911978Sgabeblack@google.com main.SConscript(joinpath(root, 'SConscript'), 108011978Sgabeblack@google.com variant_dir=joinpath(build_root, build_dir)) 108110915Sandreas.sandberg@arm.com 108211986Sandreas.sandberg@arm.commain.Prepend(CPPPATH=Dir('ext/pybind11/include/')) 108311986Sandreas.sandberg@arm.com 10841869SN/A################################################### 10851869SN/A# 108612015Sgabeblack@google.com# This builder and wrapper method are used to set up a directory with 108712015Sgabeblack@google.com# switching headers. Those are headers which are in a generic location and 108812015Sgabeblack@google.com# that include more specific headers from a directory chosen at build time 108912015Sgabeblack@google.com# based on the current build settings. 10903546Sgblack@eecs.umich.edu# 10913546Sgblack@eecs.umich.edu################################################### 10923546Sgblack@eecs.umich.edu 109312015Sgabeblack@google.comdef build_switching_header(target, source, env): 109412015Sgabeblack@google.com path = str(target[0]) 109512015Sgabeblack@google.com subdir = str(source[0]) 109612015Sgabeblack@google.com dp, fp = os.path.split(path) 109712015Sgabeblack@google.com dp = os.path.relpath(os.path.realpath(dp), 109812015Sgabeblack@google.com os.path.realpath(env['BUILDDIR'])) 109912015Sgabeblack@google.com with open(path, 'w') as hdr: 110012563Sgabeblack@google.com print('#include "%s/%s/%s"' % (dp, subdir, fp), file=hdr) 11013546Sgblack@eecs.umich.edu 110212015Sgabeblack@google.comswitching_header_action = MakeAction(build_switching_header, 110312015Sgabeblack@google.com Transform('GENERATE')) 110410196SCurtis.Dunham@arm.com 110512015Sgabeblack@google.comswitching_header_builder = Builder(action=switching_header_action, 110612015Sgabeblack@google.com source_factory=Value, 110712015Sgabeblack@google.com single_source=True) 110812015Sgabeblack@google.com 110912015Sgabeblack@google.commain.Append(BUILDERS = { 'SwitchingHeader': switching_header_builder }) 111012015Sgabeblack@google.com 111112015Sgabeblack@google.comdef switching_headers(self, headers, source): 111212015Sgabeblack@google.com for header in headers: 111312015Sgabeblack@google.com self.SwitchingHeader(header, source) 111412015Sgabeblack@google.com 111512015Sgabeblack@google.commain.AddMethod(switching_headers, 'SwitchingHeaders') 11163546Sgblack@eecs.umich.edu 11173546Sgblack@eecs.umich.edu################################################### 11183546Sgblack@eecs.umich.edu# 1119955SN/A# Define build environments for selected configurations. 1120955SN/A# 1121955SN/A################################################### 1122955SN/A 11235863Snate@binkert.orgfor variant_path in variant_paths: 112410135SCurtis.Dunham@arm.com if not GetOption('silent'): 112512563Sgabeblack@google.com print("Building in", variant_path) 11265343Sstever@gmail.com 11275343Sstever@gmail.com # Make a copy of the build-root environment to use for this config. 11286121Snate@binkert.org env = main.Clone() 11295863Snate@binkert.org env['BUILDDIR'] = variant_path 11304773Snate@binkert.org 11315863Snate@binkert.org # variant_dir is the tail component of build path, and is used to 11322632Sstever@eecs.umich.edu # determine the build parameters (e.g., 'ALPHA_SE') 11335863Snate@binkert.org (build_root, variant_dir) = splitpath(variant_path) 11342023SN/A 11355863Snate@binkert.org # Set env variables according to the build directory config. 11365863Snate@binkert.org sticky_vars.files = [] 11375863Snate@binkert.org # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in 11385863Snate@binkert.org # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke 11395863Snate@binkert.org # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings. 11405863Snate@binkert.org current_vars_file = joinpath(build_root, 'variables', variant_dir) 11415863Snate@binkert.org if isfile(current_vars_file): 11425863Snate@binkert.org sticky_vars.files.append(current_vars_file) 114310135SCurtis.Dunham@arm.com if not GetOption('silent'): 114412563Sgabeblack@google.com print("Using saved variables file %s" % current_vars_file) 114512034Sgabeblack@google.com elif variant_dir in ext_build_dirs: 114612034Sgabeblack@google.com # Things in ext are built without a variant directory. 114712034Sgabeblack@google.com continue 11482632Sstever@eecs.umich.edu else: 11495863Snate@binkert.org # Build dir-specific variables file doesn't exist. 11502023SN/A 11512632Sstever@eecs.umich.edu # Make sure the directory is there so we can create it later 11525863Snate@binkert.org opt_dir = dirname(current_vars_file) 11535342Sstever@gmail.com if not isdir(opt_dir): 11545863Snate@binkert.org mkdir(opt_dir) 11552632Sstever@eecs.umich.edu 11565863Snate@binkert.org # Get default build variables from source tree. Variables are 11575863Snate@binkert.org # normally determined by name of $VARIANT_DIR, but can be 11588267Ssteve.reinhardt@amd.com # overridden by '--default=' arg on command line. 11598120Sgblack@eecs.umich.edu default = GetOption('default') 11608267Ssteve.reinhardt@amd.com opts_dir = joinpath(main.root.abspath, 'build_opts') 11618267Ssteve.reinhardt@amd.com if default: 11628267Ssteve.reinhardt@amd.com default_vars_files = [joinpath(build_root, 'variables', default), 11638267Ssteve.reinhardt@amd.com joinpath(opts_dir, default)] 11648267Ssteve.reinhardt@amd.com else: 11658267Ssteve.reinhardt@amd.com default_vars_files = [joinpath(opts_dir, variant_dir)] 11668267Ssteve.reinhardt@amd.com existing_files = filter(isfile, default_vars_files) 11678267Ssteve.reinhardt@amd.com if existing_files: 11688267Ssteve.reinhardt@amd.com default_vars_file = existing_files[0] 11695863Snate@binkert.org sticky_vars.files.append(default_vars_file) 117012563Sgabeblack@google.com print("Variables file %s not found,\n using defaults in %s" 117112563Sgabeblack@google.com % (current_vars_file, default_vars_file)) 11722632Sstever@eecs.umich.edu else: 117312563Sgabeblack@google.com print("Error: cannot find variables file %s or " 117412563Sgabeblack@google.com "default file(s) %s" 117512563Sgabeblack@google.com % (current_vars_file, ' or '.join(default_vars_files))) 11762632Sstever@eecs.umich.edu Exit(1) 11771888SN/A 11785863Snate@binkert.org # Apply current variable settings to env 11795863Snate@binkert.org sticky_vars.Update(env) 11801858SN/A 11818120Sgblack@eecs.umich.edu help_texts["local_vars"] += \ 11828120Sgblack@eecs.umich.edu "Build variables for %s:\n" % variant_dir \ 11837756SAli.Saidi@ARM.com + sticky_vars.GenerateHelpText(env) 11842598SN/A 11855863Snate@binkert.org # Process variable settings. 11861858SN/A 11871858SN/A if not have_fenv and env['USE_FENV']: 118812563Sgabeblack@google.com print("Warning: <fenv.h> not available; " 118912563Sgabeblack@google.com "forcing USE_FENV to False in", variant_dir + ".") 11901858SN/A env['USE_FENV'] = False 11911858SN/A 11921858SN/A if not env['USE_FENV']: 119312563Sgabeblack@google.com print("Warning: No IEEE FP rounding mode control in", 119412563Sgabeblack@google.com variant_dir + ".") 119512563Sgabeblack@google.com print(" FP results may deviate slightly from other platforms.") 11961858SN/A 119712230Sgiacomo.travaglini@arm.com if not have_png and env['USE_PNG']: 119812563Sgabeblack@google.com print("Warning: <png.h> not available; " 119912563Sgabeblack@google.com "forcing USE_PNG to False in", variant_dir + ".") 120012230Sgiacomo.travaglini@arm.com env['USE_PNG'] = False 120112230Sgiacomo.travaglini@arm.com 120212230Sgiacomo.travaglini@arm.com if env['USE_PNG']: 120312230Sgiacomo.travaglini@arm.com env.Append(LIBS=['png']) 120412230Sgiacomo.travaglini@arm.com 12051858SN/A if env['EFENCE']: 12061858SN/A env.Append(LIBS=['efence']) 12071858SN/A 12089651SAndreas.Sandberg@ARM.com if env['USE_KVM']: 12099651SAndreas.Sandberg@ARM.com if not have_kvm: 121012563Sgabeblack@google.com print("Warning: Can not enable KVM, host seems to " 121112563Sgabeblack@google.com "lack KVM support") 12129651SAndreas.Sandberg@ARM.com env['USE_KVM'] = False 12139651SAndreas.Sandberg@ARM.com elif not is_isa_kvm_compatible(env['TARGET_ISA']): 121412563Sgabeblack@google.com print("Info: KVM support disabled due to unsupported host and " 121512563Sgabeblack@google.com "target ISA combination") 12169651SAndreas.Sandberg@ARM.com env['USE_KVM'] = False 12179651SAndreas.Sandberg@ARM.com 121812056Sgabeblack@google.com if env['USE_TUNTAP']: 121912056Sgabeblack@google.com if not have_tuntap: 122012563Sgabeblack@google.com print("Warning: Can't connect EtherTap with a tap device.") 122112056Sgabeblack@google.com env['USE_TUNTAP'] = False 122212056Sgabeblack@google.com 122311798Santhony.gutierrez@amd.com if env['BUILD_GPU']: 122411798Santhony.gutierrez@amd.com env.Append(CPPDEFINES=['BUILD_GPU']) 122511798Santhony.gutierrez@amd.com 12269986Sandreas@sandberg.pp.se # Warn about missing optional functionality 12279986Sandreas@sandberg.pp.se if env['USE_KVM']: 12289986Sandreas@sandberg.pp.se if not main['HAVE_PERF_ATTR_EXCLUDE_HOST']: 122912563Sgabeblack@google.com print("Warning: perf_event headers lack support for the " 123012563Sgabeblack@google.com "exclude_host attribute. KVM instruction counts will " 123112563Sgabeblack@google.com "be inaccurate.") 12329986Sandreas@sandberg.pp.se 12335863Snate@binkert.org # Save sticky variable settings back to current variables file 12345863Snate@binkert.org sticky_vars.Save(current_vars_file, env) 12351869SN/A 12361965SN/A if env['USE_SSE2']: 12377739Sgblack@eecs.umich.edu env.Append(CCFLAGS=['-msse2']) 12381965SN/A 12392761Sstever@eecs.umich.edu # The src/SConscript file sets up the build rules in 'env' according 12405863Snate@binkert.org # to the configured variables. It returns a list of environments, 12411869SN/A # one for each variant build (debug, opt, etc.) 124210196SCurtis.Dunham@arm.com SConscript('src/SConscript', variant_dir = variant_path, exports = 'env') 12431869SN/A 12448120Sgblack@eecs.umich.edu# base help text 12458120Sgblack@eecs.umich.eduHelp(''' 12468120Sgblack@eecs.umich.eduUsage: scons [scons options] [build variables] [target(s)] 12478120Sgblack@eecs.umich.edu 12488120Sgblack@eecs.umich.eduExtra scons options: 12498120Sgblack@eecs.umich.edu%(options)s 12508120Sgblack@eecs.umich.edu 12518120Sgblack@eecs.umich.eduGlobal build variables: 12528120Sgblack@eecs.umich.edu%(global_vars)s 12538120Sgblack@eecs.umich.edu 12548120Sgblack@eecs.umich.edu%(local_vars)s 12558120Sgblack@eecs.umich.edu''' % help_texts) 1256