SConstruct revision 13715
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 9513541Sandrea.mondelli@ucf.edufrom re import match 96955SN/A 976654Snate@binkert.org# SCons includes 985273Sstever@gmail.comimport SCons 995871Snate@binkert.orgimport SCons.Node 1005273Sstever@gmail.com 1016654Snate@binkert.orgfrom m5.util import compareVersions, readCommand 1025396Ssaidi@eecs.umich.edu 1038120Sgblack@eecs.umich.eduhelp_texts = { 1048120Sgblack@eecs.umich.edu "options" : "", 1058120Sgblack@eecs.umich.edu "global_vars" : "", 1068120Sgblack@eecs.umich.edu "local_vars" : "" 1078120Sgblack@eecs.umich.edu} 1088120Sgblack@eecs.umich.edu 1098120Sgblack@eecs.umich.eduExport("help_texts") 1108120Sgblack@eecs.umich.edu 1118879Ssteve.reinhardt@amd.com 1128879Ssteve.reinhardt@amd.com# There's a bug in scons in that (1) by default, the help texts from 1138879Ssteve.reinhardt@amd.com# AddOption() are supposed to be displayed when you type 'scons -h' 1148879Ssteve.reinhardt@amd.com# and (2) you can override the help displayed by 'scons -h' using the 1158879Ssteve.reinhardt@amd.com# Help() function, but these two features are incompatible: once 1168879Ssteve.reinhardt@amd.com# you've overridden the help text using Help(), there's no way to get 1178879Ssteve.reinhardt@amd.com# at the help texts from AddOptions. See: 1188879Ssteve.reinhardt@amd.com# http://scons.tigris.org/issues/show_bug.cgi?id=2356 1198879Ssteve.reinhardt@amd.com# http://scons.tigris.org/issues/show_bug.cgi?id=2611 1208879Ssteve.reinhardt@amd.com# This hack lets us extract the help text from AddOptions and 1218879Ssteve.reinhardt@amd.com# re-inject it via Help(). Ideally someday this bug will be fixed and 1228879Ssteve.reinhardt@amd.com# we can just use AddOption directly. 1238879Ssteve.reinhardt@amd.comdef AddLocalOption(*args, **kwargs): 1248120Sgblack@eecs.umich.edu col_width = 30 1258120Sgblack@eecs.umich.edu 1268120Sgblack@eecs.umich.edu help = " " + ", ".join(args) 1278120Sgblack@eecs.umich.edu if "help" in kwargs: 1288120Sgblack@eecs.umich.edu length = len(help) 1298120Sgblack@eecs.umich.edu if length >= col_width: 1308120Sgblack@eecs.umich.edu help += "\n" + " " * col_width 1318120Sgblack@eecs.umich.edu else: 1328120Sgblack@eecs.umich.edu help += " " * (col_width - length) 1338120Sgblack@eecs.umich.edu help += kwargs["help"] 1348120Sgblack@eecs.umich.edu help_texts["options"] += help + "\n" 1358120Sgblack@eecs.umich.edu 1368120Sgblack@eecs.umich.edu AddOption(*args, **kwargs) 1378120Sgblack@eecs.umich.edu 1388879Ssteve.reinhardt@amd.comAddLocalOption('--colors', dest='use_colors', action='store_true', 1398879Ssteve.reinhardt@amd.com help="Add color to abbreviated scons output") 1408879Ssteve.reinhardt@amd.comAddLocalOption('--no-colors', dest='use_colors', action='store_false', 1418879Ssteve.reinhardt@amd.com help="Don't add color to abbreviated scons output") 14210458Sandreas.hansson@arm.comAddLocalOption('--with-cxx-config', dest='with_cxx_config', 14310458Sandreas.hansson@arm.com action='store_true', 14410458Sandreas.hansson@arm.com help="Build with support for C++-based configuration") 1458879Ssteve.reinhardt@amd.comAddLocalOption('--default', dest='default', type='string', action='store', 1468879Ssteve.reinhardt@amd.com help='Override which build_opts file to use for defaults') 1478879Ssteve.reinhardt@amd.comAddLocalOption('--ignore-style', dest='ignore_style', action='store_true', 1488879Ssteve.reinhardt@amd.com help='Disable style checking hooks') 14913421Sciro.santilli@arm.comAddLocalOption('--gold-linker', dest='gold_linker', action='store_true', 15013421Sciro.santilli@arm.com help='Use the gold linker') 1519227Sandreas.hansson@arm.comAddLocalOption('--no-lto', dest='no_lto', action='store_true', 1529227Sandreas.hansson@arm.com help='Disable Link-Time Optimization for fast') 15312063Sgabeblack@google.comAddLocalOption('--force-lto', dest='force_lto', action='store_true', 15412063Sgabeblack@google.com help='Use Link-Time Optimization instead of partial linking' + 15512063Sgabeblack@google.com ' when the compiler doesn\'t support using them together.') 1568879Ssteve.reinhardt@amd.comAddLocalOption('--update-ref', dest='update_ref', action='store_true', 1578879Ssteve.reinhardt@amd.com help='Update test reference outputs') 1588879Ssteve.reinhardt@amd.comAddLocalOption('--verbose', dest='verbose', action='store_true', 1598879Ssteve.reinhardt@amd.com help='Print full tool command lines') 16010453SAndrew.Bardsley@arm.comAddLocalOption('--without-python', dest='without_python', 16110453SAndrew.Bardsley@arm.com action='store_true', 16210453SAndrew.Bardsley@arm.com help='Build without Python configuration support') 16310456SCurtis.Dunham@arm.comAddLocalOption('--without-tcmalloc', dest='without_tcmalloc', 16410456SCurtis.Dunham@arm.com action='store_true', 16510456SCurtis.Dunham@arm.com help='Disable linking against tcmalloc') 16610457Sandreas.hansson@arm.comAddLocalOption('--with-ubsan', dest='with_ubsan', action='store_true', 16710457Sandreas.hansson@arm.com help='Build with Undefined Behavior Sanitizer if available') 16811342Sandreas.hansson@arm.comAddLocalOption('--with-asan', dest='with_asan', action='store_true', 16911342Sandreas.hansson@arm.com help='Build with Address Sanitizer if available') 1708120Sgblack@eecs.umich.edu 17112063Sgabeblack@google.comif GetOption('no_lto') and GetOption('force_lto'): 17212563Sgabeblack@google.com print('--no-lto and --force-lto are mutually exclusive') 17312063Sgabeblack@google.com Exit(1) 17412063Sgabeblack@google.com 1755871Snate@binkert.org######################################################################## 1765871Snate@binkert.org# 1776121Snate@binkert.org# Set up the main build environment. 1785871Snate@binkert.org# 1795871Snate@binkert.org######################################################################## 1809926Sstan.czerniawski@arm.com 18112243Sgabeblack@google.commain = Environment() 1821533SN/A 18312246Sgabeblack@google.comfrom gem5_scons import Transform 18412246Sgabeblack@google.comfrom gem5_scons.util import get_termcap 18512246Sgabeblack@google.comtermcap = get_termcap() 18612246Sgabeblack@google.com 1879239Sandreas.hansson@arm.commain_dict_keys = main.Dictionary().keys() 1889239Sandreas.hansson@arm.com 1899239Sandreas.hansson@arm.com# Check that we have a C/C++ compiler 1909239Sandreas.hansson@arm.comif not ('CC' in main_dict_keys and 'CXX' in main_dict_keys): 19112563Sgabeblack@google.com print("No C++ compiler installed (package g++ on Ubuntu and RedHat)") 1929239Sandreas.hansson@arm.com Exit(1) 1939239Sandreas.hansson@arm.com 194955SN/A################################################### 195955SN/A# 1962632Sstever@eecs.umich.edu# Figure out which configurations to set up based on the path(s) of 1972632Sstever@eecs.umich.edu# the target(s). 198955SN/A# 199955SN/A################################################### 200955SN/A 201955SN/A# Find default configuration & binary. 2028878Ssteve.reinhardt@amd.comDefault(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug')) 203955SN/A 2042632Sstever@eecs.umich.edu# helper function: find last occurrence of element in list 2052632Sstever@eecs.umich.edudef rfind(l, elt, offs = -1): 2062632Sstever@eecs.umich.edu for i in range(len(l)+offs, 0, -1): 2072632Sstever@eecs.umich.edu if l[i] == elt: 2082632Sstever@eecs.umich.edu return i 2092632Sstever@eecs.umich.edu raise ValueError, "element not found" 2102632Sstever@eecs.umich.edu 2118268Ssteve.reinhardt@amd.com# Take a list of paths (or SCons Nodes) and return a list with all 2128268Ssteve.reinhardt@amd.com# paths made absolute and ~-expanded. Paths will be interpreted 2138268Ssteve.reinhardt@amd.com# relative to the launch directory unless a different root is provided 2148268Ssteve.reinhardt@amd.comdef makePathListAbsolute(path_list, root=GetLaunchDir()): 2158268Ssteve.reinhardt@amd.com return [abspath(joinpath(root, expanduser(str(p)))) 2168268Ssteve.reinhardt@amd.com for p in path_list] 2178268Ssteve.reinhardt@amd.com 21813715Sandreas.sandberg@arm.comdef find_first_prog(prog_names): 21913715Sandreas.sandberg@arm.com """Find the absolute path to the first existing binary in prog_names""" 22013715Sandreas.sandberg@arm.com 22113715Sandreas.sandberg@arm.com if not isinstance(prog_names, (list, tuple)): 22213715Sandreas.sandberg@arm.com prog_names = [ prog_names ] 22313715Sandreas.sandberg@arm.com 22413715Sandreas.sandberg@arm.com for p in prog_names: 22513715Sandreas.sandberg@arm.com p = main.WhereIs(p) 22613715Sandreas.sandberg@arm.com if p is not None: 22713715Sandreas.sandberg@arm.com return p 22813715Sandreas.sandberg@arm.com 22913715Sandreas.sandberg@arm.com return None 23013715Sandreas.sandberg@arm.com 2312632Sstever@eecs.umich.edu# Each target must have 'build' in the interior of the path; the 2322632Sstever@eecs.umich.edu# directory below this will determine the build parameters. For 2332632Sstever@eecs.umich.edu# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we 2342632Sstever@eecs.umich.edu# recognize that ALPHA_SE specifies the configuration because it 2358268Ssteve.reinhardt@amd.com# follow 'build' in the build path. 2362632Sstever@eecs.umich.edu 2378268Ssteve.reinhardt@amd.com# The funky assignment to "[:]" is needed to replace the list contents 2388268Ssteve.reinhardt@amd.com# in place rather than reassign the symbol to a new list, which 2398268Ssteve.reinhardt@amd.com# doesn't work (obviously!). 2408268Ssteve.reinhardt@amd.comBUILD_TARGETS[:] = makePathListAbsolute(BUILD_TARGETS) 2413718Sstever@eecs.umich.edu 2422634Sstever@eecs.umich.edu# Generate a list of the unique build roots and configs that the 2432634Sstever@eecs.umich.edu# collected targets reference. 2445863Snate@binkert.orgvariant_paths = [] 2452638Sstever@eecs.umich.edubuild_root = None 2468268Ssteve.reinhardt@amd.comfor t in BUILD_TARGETS: 2472632Sstever@eecs.umich.edu path_dirs = t.split('/') 2482632Sstever@eecs.umich.edu try: 2492632Sstever@eecs.umich.edu build_top = rfind(path_dirs, 'build', -2) 2502632Sstever@eecs.umich.edu except: 25112563Sgabeblack@google.com print("Error: no non-leaf 'build' dir found on target path", t) 2521858SN/A Exit(1) 2533716Sstever@eecs.umich.edu this_build_root = joinpath('/',*path_dirs[:build_top+1]) 2542638Sstever@eecs.umich.edu if not build_root: 2552638Sstever@eecs.umich.edu build_root = this_build_root 2562638Sstever@eecs.umich.edu else: 2572638Sstever@eecs.umich.edu if this_build_root != build_root: 25812563Sgabeblack@google.com print("Error: build targets not under same build root\n" 25912563Sgabeblack@google.com " %s\n %s" % (build_root, this_build_root)) 2602638Sstever@eecs.umich.edu Exit(1) 2615863Snate@binkert.org variant_path = joinpath('/',*path_dirs[:build_top+2]) 2625863Snate@binkert.org if variant_path not in variant_paths: 2635863Snate@binkert.org variant_paths.append(variant_path) 264955SN/A 2655341Sstever@gmail.com# Make sure build_root exists (might not if this is the first build there) 2665341Sstever@gmail.comif not isdir(build_root): 2675863Snate@binkert.org mkdir(build_root) 2687756SAli.Saidi@ARM.commain['BUILDROOT'] = build_root 2695341Sstever@gmail.com 2706121Snate@binkert.orgExport('main') 2714494Ssaidi@eecs.umich.edu 2726121Snate@binkert.orgmain.SConsignFile(joinpath(build_root, "sconsign")) 2731105SN/A 2742667Sstever@eecs.umich.edu# Default duplicate option is to use hard links, but this messes up 2752667Sstever@eecs.umich.edu# when you use emacs to edit a file in the target dir, as emacs moves 2762667Sstever@eecs.umich.edu# file to file~ then copies to file, breaking the link. Symbolic 2772667Sstever@eecs.umich.edu# (soft) links work better. 2786121Snate@binkert.orgmain.SetOption('duplicate', 'soft-copy') 2792667Sstever@eecs.umich.edu 2805341Sstever@gmail.com# 2815863Snate@binkert.org# Set up global sticky variables... these are common to an entire build 2825341Sstever@gmail.com# tree (not specific to a particular build like ALPHA_SE) 2835341Sstever@gmail.com# 2845341Sstever@gmail.com 2858120Sgblack@eecs.umich.eduglobal_vars_file = joinpath(build_root, 'variables.global') 2865341Sstever@gmail.com 2878120Sgblack@eecs.umich.eduglobal_vars = Variables(global_vars_file, args=ARGUMENTS) 2885341Sstever@gmail.com 2898120Sgblack@eecs.umich.eduglobal_vars.AddVariables( 2906121Snate@binkert.org ('CC', 'C compiler', environ.get('CC', main['CC'])), 2916121Snate@binkert.org ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])), 29213715Sandreas.sandberg@arm.com ('PYTHON_CONFIG', 'Python config binary to use', 29313715Sandreas.sandberg@arm.com [ 'python2.7-config', 'python-config' ]), 2949396Sandreas.hansson@arm.com ('PROTOC', 'protoc tool', environ.get('PROTOC', 'protoc')), 2955397Ssaidi@eecs.umich.edu ('BATCH', 'Use batch pool for build and tests', False), 2965397Ssaidi@eecs.umich.edu ('BATCH_CMD', 'Batch pool submission command name', 'qdo'), 2977727SAli.Saidi@ARM.com ('M5_BUILD_CACHE', 'Cache built objects in this directory', False), 2988268Ssteve.reinhardt@amd.com ('EXTRAS', 'Add extra directories to the compilation', '') 2996168Snate@binkert.org ) 3005341Sstever@gmail.com 3018120Sgblack@eecs.umich.edu# Update main environment with values from ARGUMENTS & global_vars_file 3028120Sgblack@eecs.umich.eduglobal_vars.Update(main) 3038120Sgblack@eecs.umich.eduhelp_texts["global_vars"] += global_vars.GenerateHelpText(main) 3046814Sgblack@eecs.umich.edu 3055863Snate@binkert.org# Save sticky variable settings back to current variables file 3068120Sgblack@eecs.umich.eduglobal_vars.Save(global_vars_file, main) 3075341Sstever@gmail.com 3085863Snate@binkert.org# Parse EXTRAS variable to build list of all directories where we're 3098268Ssteve.reinhardt@amd.com# look for sources etc. This list is exported as extras_dir_list. 3106121Snate@binkert.orgbase_dir = main.srcdir.abspath 3116121Snate@binkert.orgif main['EXTRAS']: 3128268Ssteve.reinhardt@amd.com extras_dir_list = makePathListAbsolute(main['EXTRAS'].split(':')) 3135742Snate@binkert.orgelse: 3145742Snate@binkert.org extras_dir_list = [] 3155341Sstever@gmail.com 3165742Snate@binkert.orgExport('base_dir') 3175742Snate@binkert.orgExport('extras_dir_list') 3185341Sstever@gmail.com 3196017Snate@binkert.org# the ext directory should be on the #includes path 3206121Snate@binkert.orgmain.Append(CPPPATH=[Dir('ext')]) 3216017Snate@binkert.org 32212158Sandreas.sandberg@arm.com# Add shared top-level headers 32312158Sandreas.sandberg@arm.commain.Prepend(CPPPATH=Dir('include')) 32412158Sandreas.sandberg@arm.com 3258120Sgblack@eecs.umich.eduif GetOption('verbose'): 3267756SAli.Saidi@ARM.com def MakeAction(action, string, *args, **kwargs): 3277756SAli.Saidi@ARM.com return Action(action, *args, **kwargs) 3287756SAli.Saidi@ARM.comelse: 3297756SAli.Saidi@ARM.com MakeAction = Action 3307816Ssteve.reinhardt@amd.com main['CCCOMSTR'] = Transform("CC") 3317816Ssteve.reinhardt@amd.com main['CXXCOMSTR'] = Transform("CXX") 3327816Ssteve.reinhardt@amd.com main['ASCOMSTR'] = Transform("AS") 3337816Ssteve.reinhardt@amd.com main['ARCOMSTR'] = Transform("AR", 0) 3347816Ssteve.reinhardt@amd.com main['LINKCOMSTR'] = Transform("LINK", 0) 33511979Sgabeblack@google.com main['SHLINKCOMSTR'] = Transform("SHLINK", 0) 3367816Ssteve.reinhardt@amd.com main['RANLIBCOMSTR'] = Transform("RANLIB", 0) 3377816Ssteve.reinhardt@amd.com main['M4COMSTR'] = Transform("M4") 3387816Ssteve.reinhardt@amd.com main['SHCCCOMSTR'] = Transform("SHCC") 3397816Ssteve.reinhardt@amd.com main['SHCXXCOMSTR'] = Transform("SHCXX") 3407756SAli.Saidi@ARM.comExport('MakeAction') 3417756SAli.Saidi@ARM.com 3429227Sandreas.hansson@arm.com# Initialize the Link-Time Optimization (LTO) flags 3439227Sandreas.hansson@arm.commain['LTO_CCFLAGS'] = [] 3449227Sandreas.hansson@arm.commain['LTO_LDFLAGS'] = [] 3459227Sandreas.hansson@arm.com 3469590Sandreas@sandberg.pp.se# According to the readme, tcmalloc works best if the compiler doesn't 3479590Sandreas@sandberg.pp.se# assume that we're using the builtin malloc and friends. These flags 3489590Sandreas@sandberg.pp.se# are compiler-specific, so we need to set them after we detect which 3499590Sandreas@sandberg.pp.se# compiler we're using. 3509590Sandreas@sandberg.pp.semain['TCMALLOC_CCFLAGS'] = [] 3519590Sandreas@sandberg.pp.se 3526654Snate@binkert.orgCXX_version = readCommand([main['CXX'],'--version'], exception=False) 3536654Snate@binkert.orgCXX_V = readCommand([main['CXX'],'-V'], exception=False) 3545871Snate@binkert.org 3556121Snate@binkert.orgmain['GCC'] = CXX_version and CXX_version.find('g++') >= 0 3568946Sandreas.hansson@arm.commain['CLANG'] = CXX_version and CXX_version.find('clang') >= 0 3579419Sandreas.hansson@arm.comif main['GCC'] + main['CLANG'] > 1: 35812563Sgabeblack@google.com print('Error: How can we have two at the same time?') 3593918Ssaidi@eecs.umich.edu Exit(1) 3603918Ssaidi@eecs.umich.edu 3611858SN/A# Set up default C++ compiler flags 3629556Sandreas.hansson@arm.comif main['GCC'] or main['CLANG']: 3639556Sandreas.hansson@arm.com # As gcc and clang share many flags, do the common parts here 3649556Sandreas.hansson@arm.com main.Append(CCFLAGS=['-pipe']) 3659556Sandreas.hansson@arm.com main.Append(CCFLAGS=['-fno-strict-aliasing']) 36611294Sandreas.hansson@arm.com # Enable -Wall and -Wextra and then disable the few warnings that 36711294Sandreas.hansson@arm.com # we consistently violate 36811294Sandreas.hansson@arm.com main.Append(CCFLAGS=['-Wall', '-Wundef', '-Wextra', 36911294Sandreas.hansson@arm.com '-Wno-sign-compare', '-Wno-unused-parameter']) 37010878Sandreas.hansson@arm.com # We always compile using C++11 37110878Sandreas.hansson@arm.com main.Append(CXXFLAGS=['-std=c++11']) 37211811Sbaz21@cam.ac.uk if sys.platform.startswith('freebsd'): 37311811Sbaz21@cam.ac.uk main.Append(CCFLAGS=['-I/usr/local/include']) 37411811Sbaz21@cam.ac.uk main.Append(CXXFLAGS=['-I/usr/local/include']) 37511982Sgabeblack@google.com 37611982Sgabeblack@google.com main['FILTER_PSHLINKFLAGS'] = lambda x: str(x).replace(' -shared', '') 37711982Sgabeblack@google.com main['PSHLINKFLAGS'] = main.subst('${FILTER_PSHLINKFLAGS(SHLINKFLAGS)}') 37813421Sciro.santilli@arm.com if GetOption('gold_linker'): 37913421Sciro.santilli@arm.com main.Append(LINKFLAGS='-fuse-ld=gold') 38011982Sgabeblack@google.com main['PLINKFLAGS'] = main.subst('${LINKFLAGS}') 38111992Sgabeblack@google.com shared_partial_flags = ['-r', '-nostdlib'] 38211982Sgabeblack@google.com main.Append(PSHLINKFLAGS=shared_partial_flags) 38311982Sgabeblack@google.com main.Append(PLINKFLAGS=shared_partial_flags) 38412305Sgabeblack@google.com 38512305Sgabeblack@google.com # Treat warnings as errors but white list some warnings that we 38612305Sgabeblack@google.com # want to allow (e.g., deprecation warnings). 38712305Sgabeblack@google.com main.Append(CCFLAGS=['-Werror', 38812305Sgabeblack@google.com '-Wno-error=deprecated-declarations', 38912305Sgabeblack@google.com '-Wno-error=deprecated', 39012305Sgabeblack@google.com ]) 3919556Sandreas.hansson@arm.comelse: 39212563Sgabeblack@google.com print(termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal, end=' ') 39312563Sgabeblack@google.com print("Don't know what compiler options to use for your compiler.") 39412563Sgabeblack@google.com print(termcap.Yellow + ' compiler:' + termcap.Normal, main['CXX']) 39512563Sgabeblack@google.com print(termcap.Yellow + ' version:' + termcap.Normal, end = ' ') 3969556Sandreas.hansson@arm.com if not CXX_version: 39712563Sgabeblack@google.com print(termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" + 39812563Sgabeblack@google.com termcap.Normal) 3999556Sandreas.hansson@arm.com else: 40012563Sgabeblack@google.com print(CXX_version.replace('\n', '<nl>')) 40112563Sgabeblack@google.com print(" If you're trying to use a compiler other than GCC") 40212563Sgabeblack@google.com print(" or clang, there appears to be something wrong with your") 40312563Sgabeblack@google.com print(" environment.") 40412563Sgabeblack@google.com print(" ") 40512563Sgabeblack@google.com print(" If you are trying to use a compiler other than those listed") 40612563Sgabeblack@google.com print(" above you will need to ease fix SConstruct and ") 40712563Sgabeblack@google.com print(" src/SConscript to support that compiler.") 4089556Sandreas.hansson@arm.com Exit(1) 4099556Sandreas.hansson@arm.com 4106121Snate@binkert.orgif main['GCC']: 41111500Sandreas.hansson@arm.com # Check for a supported version of gcc. >= 4.8 is chosen for its 41210238Sandreas.hansson@arm.com # level of c++11 support. See 41310878Sandreas.hansson@arm.com # http://gcc.gnu.org/projects/cxx0x.html for details. 4149420Sandreas.hansson@arm.com gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False) 41511500Sandreas.hansson@arm.com if compareVersions(gcc_version, "4.8") < 0: 41612563Sgabeblack@google.com print('Error: gcc version 4.8 or newer required.') 41712563Sgabeblack@google.com print(' Installed version: ', gcc_version) 4189420Sandreas.hansson@arm.com Exit(1) 4199420Sandreas.hansson@arm.com 4209420Sandreas.hansson@arm.com main['GCC_VERSION'] = gcc_version 4219420Sandreas.hansson@arm.com 42212063Sgabeblack@google.com if compareVersions(gcc_version, '4.9') >= 0: 42312063Sgabeblack@google.com # Incremental linking with LTO is currently broken in gcc versions 42412063Sgabeblack@google.com # 4.9 and above. A version where everything works completely hasn't 42512063Sgabeblack@google.com # yet been identified. 42612063Sgabeblack@google.com # 42712063Sgabeblack@google.com # https://gcc.gnu.org/bugzilla/show_bug.cgi?id=67548 42812063Sgabeblack@google.com main['BROKEN_INCREMENTAL_LTO'] = True 42912063Sgabeblack@google.com if compareVersions(gcc_version, '6.0') >= 0: 43012063Sgabeblack@google.com # gcc versions 6.0 and greater accept an -flinker-output flag which 43112063Sgabeblack@google.com # selects what type of output the linker should generate. This is 43212063Sgabeblack@google.com # necessary for incremental lto to work, but is also broken in 43312063Sgabeblack@google.com # current versions of gcc. It may not be necessary in future 43412063Sgabeblack@google.com # versions. We add it here since it might be, and as a reminder that 43512063Sgabeblack@google.com # it exists. It's excluded if lto is being forced. 43612063Sgabeblack@google.com # 43712063Sgabeblack@google.com # https://gcc.gnu.org/gcc-6/changes.html 43812063Sgabeblack@google.com # https://gcc.gnu.org/ml/gcc-patches/2015-11/msg03161.html 43912063Sgabeblack@google.com # https://gcc.gnu.org/bugzilla/show_bug.cgi?id=69866 44012063Sgabeblack@google.com if not GetOption('force_lto'): 44112063Sgabeblack@google.com main.Append(PSHLINKFLAGS='-flinker-output=rel') 44212063Sgabeblack@google.com main.Append(PLINKFLAGS='-flinker-output=rel') 44312063Sgabeblack@google.com 44410457Sandreas.hansson@arm.com # Make sure we warn if the user has requested to compile with the 44510457Sandreas.hansson@arm.com # Undefined Benahvior Sanitizer and this version of gcc does not 44610457Sandreas.hansson@arm.com # support it. 44710457Sandreas.hansson@arm.com if GetOption('with_ubsan') and \ 44810457Sandreas.hansson@arm.com compareVersions(gcc_version, '4.9') < 0: 44912563Sgabeblack@google.com print(termcap.Yellow + termcap.Bold + 45012563Sgabeblack@google.com 'Warning: UBSan is only supported using gcc 4.9 and later.' + 45112563Sgabeblack@google.com termcap.Normal) 45210457Sandreas.hansson@arm.com 45312063Sgabeblack@google.com disable_lto = GetOption('no_lto') 45412063Sgabeblack@google.com if not disable_lto and main.get('BROKEN_INCREMENTAL_LTO', False) and \ 45512063Sgabeblack@google.com not GetOption('force_lto'): 45612563Sgabeblack@google.com print(termcap.Yellow + termcap.Bold + 45712563Sgabeblack@google.com 'Warning: Your compiler doesn\'t support incremental linking' + 45812563Sgabeblack@google.com ' and lto at the same time, so lto is being disabled. To force' + 45912563Sgabeblack@google.com ' lto on anyway, use the --force-lto option. That will disable' + 46012563Sgabeblack@google.com ' partial linking.' + 46112563Sgabeblack@google.com termcap.Normal) 46212063Sgabeblack@google.com disable_lto = True 46312063Sgabeblack@google.com 46410238Sandreas.hansson@arm.com # Add the appropriate Link-Time Optimization (LTO) flags 46510238Sandreas.hansson@arm.com # unless LTO is explicitly turned off. Note that these flags 46610238Sandreas.hansson@arm.com # are only used by the fast target. 46712063Sgabeblack@google.com if not disable_lto: 46810238Sandreas.hansson@arm.com # Pass the LTO flag when compiling to produce GIMPLE 46910238Sandreas.hansson@arm.com # output, we merely create the flags here and only append 47010416Sandreas.hansson@arm.com # them later 47110238Sandreas.hansson@arm.com main['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')] 4729227Sandreas.hansson@arm.com 47310238Sandreas.hansson@arm.com # Use the same amount of jobs for LTO as we are running 47410416Sandreas.hansson@arm.com # scons with 47510416Sandreas.hansson@arm.com main['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs')] 4769227Sandreas.hansson@arm.com 4779590Sandreas@sandberg.pp.se main.Append(TCMALLOC_CCFLAGS=['-fno-builtin-malloc', '-fno-builtin-calloc', 4789590Sandreas@sandberg.pp.se '-fno-builtin-realloc', '-fno-builtin-free']) 4799590Sandreas@sandberg.pp.se 48012304Sgabeblack@google.com # The address sanitizer is available for gcc >= 4.8 48112304Sgabeblack@google.com if GetOption('with_asan'): 48212304Sgabeblack@google.com if GetOption('with_ubsan') and \ 48312688Sgiacomo.travaglini@arm.com compareVersions(main['GCC_VERSION'], '4.9') >= 0: 48412688Sgiacomo.travaglini@arm.com main.Append(CCFLAGS=['-fsanitize=address,undefined', 48512688Sgiacomo.travaglini@arm.com '-fno-omit-frame-pointer'], 48613020Sshunhsingou@google.com LINKFLAGS='-fsanitize=address,undefined') 48712304Sgabeblack@google.com else: 48812688Sgiacomo.travaglini@arm.com main.Append(CCFLAGS=['-fsanitize=address', 48912688Sgiacomo.travaglini@arm.com '-fno-omit-frame-pointer'], 49013020Sshunhsingou@google.com LINKFLAGS='-fsanitize=address') 49112304Sgabeblack@google.com # Only gcc >= 4.9 supports UBSan, so check both the version 49212304Sgabeblack@google.com # and the command-line option before adding the compiler and 49312304Sgabeblack@google.com # linker flags. 49412304Sgabeblack@google.com elif GetOption('with_ubsan') and \ 49512688Sgiacomo.travaglini@arm.com compareVersions(main['GCC_VERSION'], '4.9') >= 0: 49612688Sgiacomo.travaglini@arm.com main.Append(CCFLAGS='-fsanitize=undefined') 49712688Sgiacomo.travaglini@arm.com main.Append(LINKFLAGS='-fsanitize=undefined') 49812304Sgabeblack@google.com 4998737Skoansin.tan@gmail.comelif main['CLANG']: 50010878Sandreas.hansson@arm.com # Check for a supported version of clang, >= 3.1 is needed to 50111500Sandreas.hansson@arm.com # support similar features as gcc 4.8. See 5029420Sandreas.hansson@arm.com # http://clang.llvm.org/cxx_status.html for details 5038737Skoansin.tan@gmail.com clang_version_re = re.compile(".* version (\d+\.\d+)") 50410106SMitch.Hayenga@arm.com clang_version_match = clang_version_re.search(CXX_version) 5058737Skoansin.tan@gmail.com if (clang_version_match): 5068737Skoansin.tan@gmail.com clang_version = clang_version_match.groups()[0] 50710878Sandreas.hansson@arm.com if compareVersions(clang_version, "3.1") < 0: 50812563Sgabeblack@google.com print('Error: clang version 3.1 or newer required.') 50912563Sgabeblack@google.com print(' Installed version:', clang_version) 5108737Skoansin.tan@gmail.com Exit(1) 5118737Skoansin.tan@gmail.com else: 51212563Sgabeblack@google.com print('Error: Unable to determine clang version.') 5138737Skoansin.tan@gmail.com Exit(1) 5148737Skoansin.tan@gmail.com 51511294Sandreas.hansson@arm.com # clang has a few additional warnings that we disable, extraneous 5169556Sandreas.hansson@arm.com # parantheses are allowed due to Ruby's printing of the AST, 5179556Sandreas.hansson@arm.com # finally self assignments are allowed as the generated CPU code 5189556Sandreas.hansson@arm.com # is relying on this 51911294Sandreas.hansson@arm.com main.Append(CCFLAGS=['-Wno-parentheses', 52010278SAndreas.Sandberg@ARM.com '-Wno-self-assign', 52110278SAndreas.Sandberg@ARM.com # Some versions of libstdc++ (4.8?) seem to 52210278SAndreas.Sandberg@ARM.com # use struct hash and class hash 52310278SAndreas.Sandberg@ARM.com # interchangeably. 52410278SAndreas.Sandberg@ARM.com '-Wno-mismatched-tags', 52510278SAndreas.Sandberg@ARM.com ]) 5269556Sandreas.hansson@arm.com 5279590Sandreas@sandberg.pp.se main.Append(TCMALLOC_CCFLAGS=['-fno-builtin']) 5289590Sandreas@sandberg.pp.se 5299420Sandreas.hansson@arm.com # On Mac OS X/Darwin we need to also use libc++ (part of XCode) as 5309846Sandreas.hansson@arm.com # opposed to libstdc++, as the later is dated. 5319846Sandreas.hansson@arm.com if sys.platform == "darwin": 5329846Sandreas.hansson@arm.com main.Append(CXXFLAGS=['-stdlib=libc++']) 5339846Sandreas.hansson@arm.com main.Append(LIBS=['c++']) 5348946Sandreas.hansson@arm.com 53511811Sbaz21@cam.ac.uk # On FreeBSD we need libthr. 53611811Sbaz21@cam.ac.uk if sys.platform.startswith('freebsd'): 53711811Sbaz21@cam.ac.uk main.Append(LIBS=['thr']) 53811811Sbaz21@cam.ac.uk 53912304Sgabeblack@google.com # We require clang >= 3.1, so there is no need to check any 54012304Sgabeblack@google.com # versions here. 54112304Sgabeblack@google.com if GetOption('with_ubsan'): 54212304Sgabeblack@google.com if GetOption('with_asan'): 54313020Sshunhsingou@google.com main.Append(CCFLAGS=['-fsanitize=address,undefined', 54413020Sshunhsingou@google.com '-fno-omit-frame-pointer'], 54512304Sgabeblack@google.com LINKFLAGS='-fsanitize=address,undefined') 54612304Sgabeblack@google.com else: 54713020Sshunhsingou@google.com main.Append(CCFLAGS='-fsanitize=undefined', 54813020Sshunhsingou@google.com LINKFLAGS='-fsanitize=undefined') 54912304Sgabeblack@google.com 55012304Sgabeblack@google.com elif GetOption('with_asan'): 55113020Sshunhsingou@google.com main.Append(CCFLAGS=['-fsanitize=address', 55213020Sshunhsingou@google.com '-fno-omit-frame-pointer'], 55312304Sgabeblack@google.com LINKFLAGS='-fsanitize=address') 55412304Sgabeblack@google.com 5553918Ssaidi@eecs.umich.eduelse: 55612563Sgabeblack@google.com print(termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal, end=' ') 55712563Sgabeblack@google.com print("Don't know what compiler options to use for your compiler.") 55812563Sgabeblack@google.com print(termcap.Yellow + ' compiler:' + termcap.Normal, main['CXX']) 55912563Sgabeblack@google.com print(termcap.Yellow + ' version:' + termcap.Normal, end=' ') 5609068SAli.Saidi@ARM.com if not CXX_version: 56112563Sgabeblack@google.com print(termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" + 56212563Sgabeblack@google.com termcap.Normal) 5639068SAli.Saidi@ARM.com else: 56412563Sgabeblack@google.com print(CXX_version.replace('\n', '<nl>')) 56512563Sgabeblack@google.com print(" If you're trying to use a compiler other than GCC") 56612563Sgabeblack@google.com print(" or clang, there appears to be something wrong with your") 56712563Sgabeblack@google.com print(" environment.") 56812563Sgabeblack@google.com print(" ") 56912563Sgabeblack@google.com print(" If you are trying to use a compiler other than those listed") 57012563Sgabeblack@google.com print(" above you will need to ease fix SConstruct and ") 57112563Sgabeblack@google.com print(" src/SConscript to support that compiler.") 5723918Ssaidi@eecs.umich.edu Exit(1) 5733918Ssaidi@eecs.umich.edu 5746157Snate@binkert.org# Set up common yacc/bison flags (needed for Ruby) 5756157Snate@binkert.orgmain['YACCFLAGS'] = '-d' 5766157Snate@binkert.orgmain['YACCHXXFILESUFFIX'] = '.hh' 5776157Snate@binkert.org 5785397Ssaidi@eecs.umich.edu# Do this after we save setting back, or else we'll tack on an 5795397Ssaidi@eecs.umich.edu# extra 'qdo' every time we run scons. 5806121Snate@binkert.orgif main['BATCH']: 5816121Snate@binkert.org main['CC'] = main['BATCH_CMD'] + ' ' + main['CC'] 5826121Snate@binkert.org main['CXX'] = main['BATCH_CMD'] + ' ' + main['CXX'] 5836121Snate@binkert.org main['AS'] = main['BATCH_CMD'] + ' ' + main['AS'] 5846121Snate@binkert.org main['AR'] = main['BATCH_CMD'] + ' ' + main['AR'] 5856121Snate@binkert.org main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB'] 5865397Ssaidi@eecs.umich.edu 5871851SN/Aif sys.platform == 'cygwin': 5881851SN/A # cygwin has some header file issues... 5897739Sgblack@eecs.umich.edu main.Append(CCFLAGS=["-Wno-uninitialized"]) 590955SN/A 5919396Sandreas.hansson@arm.com# Check for the protobuf compiler 5929396Sandreas.hansson@arm.comprotoc_version = readCommand([main['PROTOC'], '--version'], 5939396Sandreas.hansson@arm.com exception='').split() 5949396Sandreas.hansson@arm.com 5959396Sandreas.hansson@arm.com# First two words should be "libprotoc x.y.z" 5969396Sandreas.hansson@arm.comif len(protoc_version) < 2 or protoc_version[0] != 'libprotoc': 59712563Sgabeblack@google.com print(termcap.Yellow + termcap.Bold + 59812563Sgabeblack@google.com 'Warning: Protocol buffer compiler (protoc) not found.\n' + 59912563Sgabeblack@google.com ' Please install protobuf-compiler for tracing support.' + 60012563Sgabeblack@google.com termcap.Normal) 6019396Sandreas.hansson@arm.com main['PROTOC'] = False 6029396Sandreas.hansson@arm.comelse: 6039396Sandreas.hansson@arm.com # Based on the availability of the compress stream wrappers, 6049396Sandreas.hansson@arm.com # require 2.1.0 6059396Sandreas.hansson@arm.com min_protoc_version = '2.1.0' 6069396Sandreas.hansson@arm.com if compareVersions(protoc_version[1], min_protoc_version) < 0: 60712563Sgabeblack@google.com print(termcap.Yellow + termcap.Bold + 60812563Sgabeblack@google.com 'Warning: protoc version', min_protoc_version, 60912563Sgabeblack@google.com 'or newer required.\n' + 61012563Sgabeblack@google.com ' Installed version:', protoc_version[1], 61112563Sgabeblack@google.com termcap.Normal) 6129477Sandreas.hansson@arm.com main['PROTOC'] = False 6139477Sandreas.hansson@arm.com else: 6149477Sandreas.hansson@arm.com # Attempt to determine the appropriate include path and 6159477Sandreas.hansson@arm.com # library path using pkg-config, that means we also need to 6169477Sandreas.hansson@arm.com # check for pkg-config. Note that it is possible to use 6179477Sandreas.hansson@arm.com # protobuf without the involvement of pkg-config. Later on we 6189477Sandreas.hansson@arm.com # check go a library config check and at that point the test 6199477Sandreas.hansson@arm.com # will fail if libprotobuf cannot be found. 6209477Sandreas.hansson@arm.com if readCommand(['pkg-config', '--version'], exception=''): 6219477Sandreas.hansson@arm.com try: 6229477Sandreas.hansson@arm.com # Attempt to establish what linking flags to add for protobuf 6239477Sandreas.hansson@arm.com # using pkg-config 6249477Sandreas.hansson@arm.com main.ParseConfig('pkg-config --cflags --libs-only-L protobuf') 6259477Sandreas.hansson@arm.com except: 62612563Sgabeblack@google.com print(termcap.Yellow + termcap.Bold + 62712563Sgabeblack@google.com 'Warning: pkg-config could not get protobuf flags.' + 62812563Sgabeblack@google.com termcap.Normal) 6299396Sandreas.hansson@arm.com 6302667Sstever@eecs.umich.edu 63110710Sandreas.hansson@arm.com# Check for 'timeout' from GNU coreutils. If present, regressions will 63210710Sandreas.hansson@arm.com# be run with a time limit. We require version 8.13 since we rely on 63310710Sandreas.hansson@arm.com# support for the '--foreground' option. 63411811Sbaz21@cam.ac.ukif sys.platform.startswith('freebsd'): 63511811Sbaz21@cam.ac.uk timeout_lines = readCommand(['gtimeout', '--version'], 63611811Sbaz21@cam.ac.uk exception='').splitlines() 63711811Sbaz21@cam.ac.ukelse: 63811811Sbaz21@cam.ac.uk timeout_lines = readCommand(['timeout', '--version'], 63911811Sbaz21@cam.ac.uk exception='').splitlines() 64010710Sandreas.hansson@arm.com# Get the first line and tokenize it 64110710Sandreas.hansson@arm.comtimeout_version = timeout_lines[0].split() if timeout_lines else [] 64210710Sandreas.hansson@arm.commain['TIMEOUT'] = timeout_version and \ 64310710Sandreas.hansson@arm.com compareVersions(timeout_version[-1], '8.13') >= 0 64410384SCurtis.Dunham@arm.com 6459986Sandreas@sandberg.pp.se# Add a custom Check function to test for structure members. 6469986Sandreas@sandberg.pp.sedef CheckMember(context, include, decl, member, include_quotes="<>"): 6479986Sandreas@sandberg.pp.se context.Message("Checking for member %s in %s..." % 6489986Sandreas@sandberg.pp.se (member, decl)) 6499986Sandreas@sandberg.pp.se text = """ 6509986Sandreas@sandberg.pp.se#include %(header)s 6519986Sandreas@sandberg.pp.seint main(){ 6529986Sandreas@sandberg.pp.se %(decl)s test; 6539986Sandreas@sandberg.pp.se (void)test.%(member)s; 6549986Sandreas@sandberg.pp.se return 0; 6559986Sandreas@sandberg.pp.se}; 6569986Sandreas@sandberg.pp.se""" % { "header" : include_quotes[0] + include + include_quotes[1], 6579986Sandreas@sandberg.pp.se "decl" : decl, 6589986Sandreas@sandberg.pp.se "member" : member, 6599986Sandreas@sandberg.pp.se } 6609986Sandreas@sandberg.pp.se 6619986Sandreas@sandberg.pp.se ret = context.TryCompile(text, extension=".cc") 6629986Sandreas@sandberg.pp.se context.Result(ret) 6639986Sandreas@sandberg.pp.se return ret 6649986Sandreas@sandberg.pp.se 6652638Sstever@eecs.umich.edu# Platform-specific configuration. Note again that we assume that all 6662638Sstever@eecs.umich.edu# builds under a given build root run on the same host platform. 6676121Snate@binkert.orgconf = Configure(main, 6683716Sstever@eecs.umich.edu conf_dir = joinpath(build_root, '.scons_config'), 6695522Snate@binkert.org log_file = joinpath(build_root, 'scons_config.log'), 6709986Sandreas@sandberg.pp.se custom_tests = { 6719986Sandreas@sandberg.pp.se 'CheckMember' : CheckMember, 6729986Sandreas@sandberg.pp.se }) 6735522Snate@binkert.org 6745227Ssaidi@eecs.umich.edu# Check if we should compile a 64 bit binary on Mac OS X/Darwin 6755227Ssaidi@eecs.umich.edutry: 6765227Ssaidi@eecs.umich.edu import platform 6775227Ssaidi@eecs.umich.edu uname = platform.uname() 6786654Snate@binkert.org if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0: 6796654Snate@binkert.org if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]): 6807769SAli.Saidi@ARM.com main.Append(CCFLAGS=['-arch', 'x86_64']) 6817769SAli.Saidi@ARM.com main.Append(CFLAGS=['-arch', 'x86_64']) 6827769SAli.Saidi@ARM.com main.Append(LINKFLAGS=['-arch', 'x86_64']) 6837769SAli.Saidi@ARM.com main.Append(ASFLAGS=['-arch', 'x86_64']) 6845227Ssaidi@eecs.umich.eduexcept: 6855227Ssaidi@eecs.umich.edu pass 6865227Ssaidi@eecs.umich.edu 6875204Sstever@gmail.com# Recent versions of scons substitute a "Null" object for Configure() 6885204Sstever@gmail.com# when configuration isn't necessary, e.g., if the "--help" option is 6895204Sstever@gmail.com# present. Unfortuantely this Null object always returns false, 6905204Sstever@gmail.com# breaking all our configuration checks. We replace it with our own 6915204Sstever@gmail.com# more optimistic null object that returns True instead. 6925204Sstever@gmail.comif not conf: 6935204Sstever@gmail.com def NullCheck(*args, **kwargs): 6945204Sstever@gmail.com return True 6955204Sstever@gmail.com 6965204Sstever@gmail.com class NullConf: 6975204Sstever@gmail.com def __init__(self, env): 6985204Sstever@gmail.com self.env = env 6995204Sstever@gmail.com def Finish(self): 7005204Sstever@gmail.com return self.env 7015204Sstever@gmail.com def __getattr__(self, mname): 7025204Sstever@gmail.com return NullCheck 7035204Sstever@gmail.com 7046121Snate@binkert.org conf = NullConf(main) 7055204Sstever@gmail.com 7067727SAli.Saidi@ARM.com# Cache build files in the supplied directory. 7077727SAli.Saidi@ARM.comif main['M5_BUILD_CACHE']: 70812563Sgabeblack@google.com print('Using build cache located at', main['M5_BUILD_CACHE']) 7097727SAli.Saidi@ARM.com CacheDir(main['M5_BUILD_CACHE']) 7107727SAli.Saidi@ARM.com 71111988Sandreas.sandberg@arm.commain['USE_PYTHON'] = not GetOption('without_python') 71211988Sandreas.sandberg@arm.comif main['USE_PYTHON']: 71310453SAndrew.Bardsley@arm.com # Find Python include and library directories for embedding the 71410453SAndrew.Bardsley@arm.com # interpreter. We rely on python-config to resolve the appropriate 71510453SAndrew.Bardsley@arm.com # includes and linker flags. ParseConfig does not seem to understand 71610453SAndrew.Bardsley@arm.com # the more exotic linker flags such as -Xlinker and -export-dynamic so 71710453SAndrew.Bardsley@arm.com # we add them explicitly below. If you want to link in an alternate 71810453SAndrew.Bardsley@arm.com # version of python, see above for instructions on how to invoke 71910453SAndrew.Bardsley@arm.com # scons with the appropriate PATH set. 72013715Sandreas.sandberg@arm.com 72113715Sandreas.sandberg@arm.com python_config = find_first_prog(main['PYTHON_CONFIG']) 72213715Sandreas.sandberg@arm.com if python_config is None: 72313715Sandreas.sandberg@arm.com print("Error: can't find a suitable python-config, tried %s" % \ 72413715Sandreas.sandberg@arm.com main['PYTHON_CONFIG']) 72513715Sandreas.sandberg@arm.com Exit(1) 72613715Sandreas.sandberg@arm.com 72713715Sandreas.sandberg@arm.com print("Info: Using Python config: %s" % (python_config, )) 72810453SAndrew.Bardsley@arm.com py_includes = readCommand([python_config, '--includes'], 72910453SAndrew.Bardsley@arm.com exception='').split() 73013541Sandrea.mondelli@ucf.edu py_includes = filter(lambda s: match(r'.*\/include\/.*',s), py_includes) 73110453SAndrew.Bardsley@arm.com # Strip the -I from the include folders before adding them to the 73210453SAndrew.Bardsley@arm.com # CPPPATH 73313541Sandrea.mondelli@ucf.edu py_includes = map(lambda s: s[2:] if s.startswith('-I') else s, py_includes) 73413541Sandrea.mondelli@ucf.edu main.Append(CPPPATH=py_includes) 7359812Sandreas.hansson@arm.com 73610453SAndrew.Bardsley@arm.com # Read the linker flags and split them into libraries and other link 73710453SAndrew.Bardsley@arm.com # flags. The libraries are added later through the call the CheckLib. 73810453SAndrew.Bardsley@arm.com py_ld_flags = readCommand([python_config, '--ldflags'], 73910453SAndrew.Bardsley@arm.com exception='').split() 74010453SAndrew.Bardsley@arm.com py_libs = [] 74110453SAndrew.Bardsley@arm.com for lib in py_ld_flags: 74210453SAndrew.Bardsley@arm.com if not lib.startswith('-l'): 74310453SAndrew.Bardsley@arm.com main.Append(LINKFLAGS=[lib]) 74410453SAndrew.Bardsley@arm.com else: 74510453SAndrew.Bardsley@arm.com lib = lib[2:] 74610453SAndrew.Bardsley@arm.com if lib not in py_libs: 74710453SAndrew.Bardsley@arm.com py_libs.append(lib) 7487727SAli.Saidi@ARM.com 74910453SAndrew.Bardsley@arm.com # verify that this stuff works 75010453SAndrew.Bardsley@arm.com if not conf.CheckHeader('Python.h', '<>'): 75112790Smatteo.fusi@bsc.es print("Error: Check failed for Python.h header in", py_includes) 75212790Smatteo.fusi@bsc.es print("Two possible reasons:") 75312790Smatteo.fusi@bsc.es print("1. Python headers are not installed (You can install the " 75412790Smatteo.fusi@bsc.es "package python-dev on Ubuntu and RedHat)") 75512790Smatteo.fusi@bsc.es print("2. SCons is using a wrong C compiler. This can happen if " 75612790Smatteo.fusi@bsc.es "CC has the wrong value.") 75712790Smatteo.fusi@bsc.es print("CC = %s" % main['CC']) 75810453SAndrew.Bardsley@arm.com Exit(1) 7593118Sstever@eecs.umich.edu 76010453SAndrew.Bardsley@arm.com for lib in py_libs: 76110453SAndrew.Bardsley@arm.com if not conf.CheckLib(lib): 76212563Sgabeblack@google.com print("Error: can't find library %s required by python" % lib) 76310453SAndrew.Bardsley@arm.com Exit(1) 7643118Sstever@eecs.umich.edu 7653483Ssaidi@eecs.umich.edu# On Solaris you need to use libsocket for socket ops 7663494Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'): 7673494Ssaidi@eecs.umich.edu if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'): 76812563Sgabeblack@google.com print("Can't find library with socket calls (e.g. accept())") 7693483Ssaidi@eecs.umich.edu Exit(1) 7703483Ssaidi@eecs.umich.edu 7713053Sstever@eecs.umich.edu# Check for zlib. If the check passes, libz will be automatically 7723053Sstever@eecs.umich.edu# added to the LIBS environment variable. 7733918Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'): 77412563Sgabeblack@google.com print('Error: did not find needed zlib compression library ' 77512563Sgabeblack@google.com 'and/or zlib.h header file.') 77612563Sgabeblack@google.com print(' Please install zlib and try again.') 7773053Sstever@eecs.umich.edu Exit(1) 7783053Sstever@eecs.umich.edu 7799396Sandreas.hansson@arm.com# If we have the protobuf compiler, also make sure we have the 7809396Sandreas.hansson@arm.com# development libraries. If the check passes, libprotobuf will be 7819396Sandreas.hansson@arm.com# automatically added to the LIBS environment variable. After 7829396Sandreas.hansson@arm.com# this, we can use the HAVE_PROTOBUF flag to determine if we have 7839396Sandreas.hansson@arm.com# got both protoc and libprotobuf available. 7849396Sandreas.hansson@arm.commain['HAVE_PROTOBUF'] = main['PROTOC'] and \ 7859396Sandreas.hansson@arm.com conf.CheckLibWithHeader('protobuf', 'google/protobuf/message.h', 7869396Sandreas.hansson@arm.com 'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;') 7879396Sandreas.hansson@arm.com 78812920Sgabeblack@google.com# Valgrind gets much less confused if you tell it when you're using 78912920Sgabeblack@google.com# alternative stacks. 79012920Sgabeblack@google.commain['HAVE_VALGRIND'] = conf.CheckCHeader('valgrind/valgrind.h') 79112920Sgabeblack@google.com 7929477Sandreas.hansson@arm.com# If we have the compiler but not the library, print another warning. 7939396Sandreas.hansson@arm.comif main['PROTOC'] and not main['HAVE_PROTOBUF']: 79412563Sgabeblack@google.com print(termcap.Yellow + termcap.Bold + 79512563Sgabeblack@google.com 'Warning: did not find protocol buffer library and/or headers.\n' + 79612563Sgabeblack@google.com ' Please install libprotobuf-dev for tracing support.' + 79712563Sgabeblack@google.com termcap.Normal) 7989396Sandreas.hansson@arm.com 7997840Snate@binkert.org# Check for librt. 8007865Sgblack@eecs.umich.eduhave_posix_clock = \ 8017865Sgblack@eecs.umich.edu conf.CheckLibWithHeader(None, 'time.h', 'C', 8027865Sgblack@eecs.umich.edu 'clock_nanosleep(0,0,NULL,NULL);') or \ 8037865Sgblack@eecs.umich.edu conf.CheckLibWithHeader('rt', 'time.h', 'C', 8047865Sgblack@eecs.umich.edu 'clock_nanosleep(0,0,NULL,NULL);') 8057840Snate@binkert.org 8069900Sandreas@sandberg.pp.sehave_posix_timers = \ 8079900Sandreas@sandberg.pp.se conf.CheckLibWithHeader([None, 'rt'], [ 'time.h', 'signal.h' ], 'C', 8089900Sandreas@sandberg.pp.se 'timer_create(CLOCK_MONOTONIC, NULL, NULL);') 8099900Sandreas@sandberg.pp.se 81010456SCurtis.Dunham@arm.comif not GetOption('without_tcmalloc'): 81110456SCurtis.Dunham@arm.com if conf.CheckLib('tcmalloc'): 81210456SCurtis.Dunham@arm.com main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS']) 81310456SCurtis.Dunham@arm.com elif conf.CheckLib('tcmalloc_minimal'): 81410456SCurtis.Dunham@arm.com main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS']) 81510456SCurtis.Dunham@arm.com else: 81612563Sgabeblack@google.com print(termcap.Yellow + termcap.Bold + 81712563Sgabeblack@google.com "You can get a 12% performance improvement by " 81812563Sgabeblack@google.com "installing tcmalloc (libgoogle-perftools-dev package " 81912563Sgabeblack@google.com "on Ubuntu or RedHat)." + termcap.Normal) 8209045SAli.Saidi@ARM.com 82111235Sandreas.sandberg@arm.com 82211235Sandreas.sandberg@arm.com# Detect back trace implementations. The last implementation in the 82311235Sandreas.sandberg@arm.com# list will be used by default. 82411235Sandreas.sandberg@arm.combacktrace_impls = [ "none" ] 82511235Sandreas.sandberg@arm.com 82612485Sjang.hanhwi@gmail.combacktrace_checker = 'char temp;' + \ 82712485Sjang.hanhwi@gmail.com ' backtrace_symbols_fd((void*)&temp, 0, 0);' 82812485Sjang.hanhwi@gmail.comif conf.CheckLibWithHeader(None, 'execinfo.h', 'C', backtrace_checker): 82911235Sandreas.sandberg@arm.com backtrace_impls.append("glibc") 83011811Sbaz21@cam.ac.ukelif conf.CheckLibWithHeader('execinfo', 'execinfo.h', 'C', 83112485Sjang.hanhwi@gmail.com backtrace_checker): 83211811Sbaz21@cam.ac.uk # NetBSD and FreeBSD need libexecinfo. 83311811Sbaz21@cam.ac.uk backtrace_impls.append("glibc") 83411811Sbaz21@cam.ac.uk main.Append(LIBS=['execinfo']) 83511235Sandreas.sandberg@arm.com 83611235Sandreas.sandberg@arm.comif backtrace_impls[-1] == "none": 83711235Sandreas.sandberg@arm.com default_backtrace_impl = "none" 83812563Sgabeblack@google.com print(termcap.Yellow + termcap.Bold + 83912563Sgabeblack@google.com "No suitable back trace implementation found." + 84012563Sgabeblack@google.com termcap.Normal) 84111235Sandreas.sandberg@arm.com 8427840Snate@binkert.orgif not have_posix_clock: 84312563Sgabeblack@google.com print("Can't find library for POSIX clocks.") 8447840Snate@binkert.org 8451858SN/A# Check for <fenv.h> (C99 FP environment control) 8461858SN/Ahave_fenv = conf.CheckHeader('fenv.h', '<>') 8471858SN/Aif not have_fenv: 84812563Sgabeblack@google.com print("Warning: Header file <fenv.h> not found.") 84912563Sgabeblack@google.com print(" This host has no IEEE FP rounding mode control.") 8501858SN/A 85112230Sgiacomo.travaglini@arm.com# Check for <png.h> (libpng library needed if wanting to dump 85212230Sgiacomo.travaglini@arm.com# frame buffer image in png format) 85312230Sgiacomo.travaglini@arm.comhave_png = conf.CheckHeader('png.h', '<>') 85412230Sgiacomo.travaglini@arm.comif not have_png: 85512563Sgabeblack@google.com print("Warning: Header file <png.h> not found.") 85612563Sgabeblack@google.com print(" This host has no libpng library.") 85712563Sgabeblack@google.com print(" Disabling support for PNG framebuffers.") 85812230Sgiacomo.travaglini@arm.com 8599903Sandreas.hansson@arm.com# Check if we should enable KVM-based hardware virtualization. The API 8609903Sandreas.hansson@arm.com# we rely on exists since version 2.6.36 of the kernel, but somehow 8619903Sandreas.hansson@arm.com# the KVM_API_VERSION does not reflect the change. We test for one of 8629903Sandreas.hansson@arm.com# the types as a fall back. 86310841Sandreas.sandberg@arm.comhave_kvm = conf.CheckHeader('linux/kvm.h', '<>') 8649651SAndreas.Sandberg@ARM.comif not have_kvm: 86512563Sgabeblack@google.com print("Info: Compatible header file <linux/kvm.h> not found, " 86612563Sgabeblack@google.com "disabling KVM support.") 8679651SAndreas.Sandberg@ARM.com 86812056Sgabeblack@google.com# Check if the TUN/TAP driver is available. 86912056Sgabeblack@google.comhave_tuntap = conf.CheckHeader('linux/if_tun.h', '<>') 87012056Sgabeblack@google.comif not have_tuntap: 87112563Sgabeblack@google.com print("Info: Compatible header file <linux/if_tun.h> not found.") 87212056Sgabeblack@google.com 87310841Sandreas.sandberg@arm.com# x86 needs support for xsave. We test for the structure here since we 87410841Sandreas.sandberg@arm.com# won't be able to run new tests by the time we know which ISA we're 87510841Sandreas.sandberg@arm.com# targeting. 87610841Sandreas.sandberg@arm.comhave_kvm_xsave = conf.CheckTypeSize('struct kvm_xsave', 87710841Sandreas.sandberg@arm.com '#include <linux/kvm.h>') != 0 87810841Sandreas.sandberg@arm.com 8799651SAndreas.Sandberg@ARM.com# Check if the requested target ISA is compatible with the host 8809651SAndreas.Sandberg@ARM.comdef is_isa_kvm_compatible(isa): 8819651SAndreas.Sandberg@ARM.com try: 8829651SAndreas.Sandberg@ARM.com import platform 8839651SAndreas.Sandberg@ARM.com host_isa = platform.machine() 8849651SAndreas.Sandberg@ARM.com except: 88512563Sgabeblack@google.com print("Warning: Failed to determine host ISA.") 8869651SAndreas.Sandberg@ARM.com return False 8879651SAndreas.Sandberg@ARM.com 88810841Sandreas.sandberg@arm.com if not have_posix_timers: 88912563Sgabeblack@google.com print("Warning: Can not enable KVM, host seems to lack support " 89012563Sgabeblack@google.com "for POSIX timers") 89110841Sandreas.sandberg@arm.com return False 89210841Sandreas.sandberg@arm.com 89310841Sandreas.sandberg@arm.com if isa == "arm": 89410860Sandreas.sandberg@arm.com return host_isa in ( "armv7l", "aarch64" ) 89510841Sandreas.sandberg@arm.com elif isa == "x86": 89610841Sandreas.sandberg@arm.com if host_isa != "x86_64": 89710841Sandreas.sandberg@arm.com return False 89810841Sandreas.sandberg@arm.com 89910841Sandreas.sandberg@arm.com if not have_kvm_xsave: 90012563Sgabeblack@google.com print("KVM on x86 requires xsave support in kernel headers.") 90110841Sandreas.sandberg@arm.com return False 90210841Sandreas.sandberg@arm.com 90310841Sandreas.sandberg@arm.com return True 90410841Sandreas.sandberg@arm.com else: 90510841Sandreas.sandberg@arm.com return False 9069651SAndreas.Sandberg@ARM.com 9079651SAndreas.Sandberg@ARM.com 9089986Sandreas@sandberg.pp.se# Check if the exclude_host attribute is available. We want this to 9099986Sandreas@sandberg.pp.se# get accurate instruction counts in KVM. 9109986Sandreas@sandberg.pp.semain['HAVE_PERF_ATTR_EXCLUDE_HOST'] = conf.CheckMember( 9119986Sandreas@sandberg.pp.se 'linux/perf_event.h', 'struct perf_event_attr', 'exclude_host') 9129986Sandreas@sandberg.pp.se 9139986Sandreas@sandberg.pp.se 9145863Snate@binkert.org###################################################################### 9155863Snate@binkert.org# 9165863Snate@binkert.org# Finish the configuration 9175863Snate@binkert.org# 9186121Snate@binkert.orgmain = conf.Finish() 9191858SN/A 9205863Snate@binkert.org###################################################################### 9215863Snate@binkert.org# 9225863Snate@binkert.org# Collect all non-global variables 9235863Snate@binkert.org# 9245863Snate@binkert.org 9252139SN/A# Define the universe of supported ISAs 9264202Sbinkertn@umich.eduall_isa_list = [ ] 92711308Santhony.gutierrez@amd.comall_gpu_isa_list = [ ] 9284202Sbinkertn@umich.eduExport('all_isa_list') 92911308Santhony.gutierrez@amd.comExport('all_gpu_isa_list') 9302139SN/A 9316994Snate@binkert.orgclass CpuModel(object): 9326994Snate@binkert.org '''The CpuModel class encapsulates everything the ISA parser needs to 9336994Snate@binkert.org know about a particular CPU model.''' 9346994Snate@binkert.org 9356994Snate@binkert.org # Dict of available CPU model objects. Accessible as CpuModel.dict. 9366994Snate@binkert.org dict = {} 9376994Snate@binkert.org 9386994Snate@binkert.org # Constructor. Automatically adds models to CpuModel.dict. 93910319SAndreas.Sandberg@ARM.com def __init__(self, name, default=False): 9406994Snate@binkert.org self.name = name # name of model 9416994Snate@binkert.org 9426994Snate@binkert.org # This cpu is enabled by default 9436994Snate@binkert.org self.default = default 9446994Snate@binkert.org 9456994Snate@binkert.org # Add self to dict 9466994Snate@binkert.org if name in CpuModel.dict: 9476994Snate@binkert.org raise AttributeError, "CpuModel '%s' already registered" % name 9486994Snate@binkert.org CpuModel.dict[name] = self 9496994Snate@binkert.org 9506994Snate@binkert.orgExport('CpuModel') 9512155SN/A 9525863Snate@binkert.org# Sticky variables get saved in the variables file so they persist from 9531869SN/A# one invocation to the next (unless overridden, in which case the new 9541869SN/A# value becomes sticky). 9555863Snate@binkert.orgsticky_vars = Variables(args=ARGUMENTS) 9565863Snate@binkert.orgExport('sticky_vars') 9574202Sbinkertn@umich.edu 9586108Snate@binkert.org# Sticky variables that should be exported 9596108Snate@binkert.orgexport_vars = [] 9606108Snate@binkert.orgExport('export_vars') 9616108Snate@binkert.org 9629219Spower.jg@gmail.com# For Ruby 9639219Spower.jg@gmail.comall_protocols = [] 9649219Spower.jg@gmail.comExport('all_protocols') 9659219Spower.jg@gmail.comprotocol_dirs = [] 9669219Spower.jg@gmail.comExport('protocol_dirs') 9679219Spower.jg@gmail.comslicc_includes = [] 9689219Spower.jg@gmail.comExport('slicc_includes') 9699219Spower.jg@gmail.com 9704202Sbinkertn@umich.edu# Walk the tree and execute all SConsopts scripts that wil add to the 9715863Snate@binkert.org# above variables 97210135SCurtis.Dunham@arm.comif GetOption('verbose'): 97312563Sgabeblack@google.com print("Reading SConsopts") 9745742Snate@binkert.orgfor bdir in [ base_dir ] + extras_dir_list: 9758268Ssteve.reinhardt@amd.com if not isdir(bdir): 97612563Sgabeblack@google.com print("Error: directory '%s' does not exist" % bdir) 9778268Ssteve.reinhardt@amd.com Exit(1) 9785742Snate@binkert.org for root, dirs, files in os.walk(bdir): 9795341Sstever@gmail.com if 'SConsopts' in files: 9808474Sgblack@eecs.umich.edu if GetOption('verbose'): 98112563Sgabeblack@google.com print("Reading", joinpath(root, 'SConsopts')) 9825342Sstever@gmail.com SConscript(joinpath(root, 'SConsopts')) 9834202Sbinkertn@umich.edu 9844202Sbinkertn@umich.eduall_isa_list.sort() 98511308Santhony.gutierrez@amd.comall_gpu_isa_list.sort() 9864202Sbinkertn@umich.edu 9875863Snate@binkert.orgsticky_vars.AddVariables( 9885863Snate@binkert.org EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list), 98911308Santhony.gutierrez@amd.com EnumVariable('TARGET_GPU_ISA', 'Target GPU ISA', 'hsail', all_gpu_isa_list), 9906994Snate@binkert.org ListVariable('CPU_MODELS', 'CPU models', 9916994Snate@binkert.org sorted(n for n,m in CpuModel.dict.iteritems() if m.default), 99210319SAndreas.Sandberg@ARM.com sorted(CpuModel.dict.keys())), 9935863Snate@binkert.org BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger', 9945863Snate@binkert.org False), 9955863Snate@binkert.org BoolVariable('SS_COMPATIBLE_FP', 9965863Snate@binkert.org 'Make floating-point results compatible with SimpleScalar', 9975863Snate@binkert.org False), 9985863Snate@binkert.org BoolVariable('USE_SSE2', 9995863Snate@binkert.org 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts', 10005863Snate@binkert.org False), 10017840Snate@binkert.org BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock), 10025863Snate@binkert.org BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv), 100312230Sgiacomo.travaglini@arm.com BoolVariable('USE_PNG', 'Enable support for PNG images', have_png), 100412230Sgiacomo.travaglini@arm.com BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', 100512230Sgiacomo.travaglini@arm.com False), 100612230Sgiacomo.travaglini@arm.com BoolVariable('USE_KVM', 'Enable hardware virtualized (KVM) CPU models', 100712230Sgiacomo.travaglini@arm.com have_kvm), 100812056Sgabeblack@google.com BoolVariable('USE_TUNTAP', 100912056Sgabeblack@google.com 'Enable using a tap device to bridge to the host network', 101012056Sgabeblack@google.com have_tuntap), 101111308Santhony.gutierrez@amd.com BoolVariable('BUILD_GPU', 'Build the compute-GPU model', False), 10129219Spower.jg@gmail.com EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None', 10139219Spower.jg@gmail.com all_protocols), 101411235Sandreas.sandberg@arm.com EnumVariable('BACKTRACE_IMPL', 'Post-mortem dump implementation', 101511235Sandreas.sandberg@arm.com backtrace_impls[-1], backtrace_impls) 10161869SN/A ) 10171858SN/A 10185863Snate@binkert.org# These variables get exported to #defines in config/*.hh (see src/SConscript). 101911308Santhony.gutierrez@amd.comexport_vars += ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'TARGET_GPU_ISA', 102012061Sjason@lowepower.com 'CP_ANNOTATE', 'USE_POSIX_CLOCK', 'USE_KVM', 'USE_TUNTAP', 102112920Sgabeblack@google.com 'PROTOCOL', 'HAVE_PROTOBUF', 'HAVE_VALGRIND', 102212920Sgabeblack@google.com 'HAVE_PERF_ATTR_EXCLUDE_HOST', 'USE_PNG'] 10231858SN/A 1024955SN/A################################################### 1025955SN/A# 10261869SN/A# Define a SCons builder for configuration flag headers. 10271869SN/A# 10281869SN/A################################################### 10291869SN/A 10301869SN/A# This function generates a config header file that #defines the 10315863Snate@binkert.org# variable symbol to the current variable setting (0 or 1). The source 10325863Snate@binkert.org# operands are the name of the variable and a Value node containing the 10335863Snate@binkert.org# value of the variable. 10341869SN/Adef build_config_file(target, source, env): 10355863Snate@binkert.org (variable, value) = [s.get_contents() for s in source] 10361869SN/A f = file(str(target[0]), 'w') 103712563Sgabeblack@google.com print('#define', variable, value, file=f) 10381869SN/A f.close() 10391869SN/A return None 10401869SN/A 10411869SN/A# Combine the two functions into a scons Action object. 10428483Sgblack@eecs.umich.educonfig_action = MakeAction(build_config_file, Transform("CONFIG H", 2)) 10431869SN/A 10441869SN/A# The emitter munges the source & target node lists to reflect what 10451869SN/A# we're really doing. 10461869SN/Adef config_emitter(target, source, env): 10475863Snate@binkert.org # extract variable name from Builder arg 10485863Snate@binkert.org variable = str(target[0]) 10491869SN/A # True target is config header file 10505863Snate@binkert.org target = joinpath('config', variable.lower() + '.hh') 10515863Snate@binkert.org val = env[variable] 10523356Sbinkertn@umich.edu if isinstance(val, bool): 10533356Sbinkertn@umich.edu # Force value to 0/1 10543356Sbinkertn@umich.edu val = int(val) 10553356Sbinkertn@umich.edu elif isinstance(val, str): 10563356Sbinkertn@umich.edu val = '"' + val + '"' 10574781Snate@binkert.org 10585863Snate@binkert.org # Sources are variable name & value (packaged in SCons Value nodes) 10595863Snate@binkert.org return ([target], [Value(variable), Value(val)]) 10601869SN/A 10611869SN/Aconfig_builder = Builder(emitter = config_emitter, action = config_action) 10621869SN/A 10636121Snate@binkert.orgmain.Append(BUILDERS = { 'ConfigFile' : config_builder }) 10641869SN/A 106511982Sgabeblack@google.com################################################### 106611982Sgabeblack@google.com# 106711982Sgabeblack@google.com# Builders for static and shared partially linked object files. 106811982Sgabeblack@google.com# 106911982Sgabeblack@google.com################################################### 107011982Sgabeblack@google.com 107111982Sgabeblack@google.compartial_static_builder = Builder(action=SCons.Defaults.LinkAction, 107211982Sgabeblack@google.com src_suffix='$OBJSUFFIX', 107311982Sgabeblack@google.com src_builder=['StaticObject', 'Object'], 107411982Sgabeblack@google.com LINKFLAGS='$PLINKFLAGS', 107511982Sgabeblack@google.com LIBS='') 107611982Sgabeblack@google.com 107711982Sgabeblack@google.comdef partial_shared_emitter(target, source, env): 107811982Sgabeblack@google.com for tgt in target: 107911982Sgabeblack@google.com tgt.attributes.shared = 1 108011982Sgabeblack@google.com return (target, source) 108111982Sgabeblack@google.compartial_shared_builder = Builder(action=SCons.Defaults.ShLinkAction, 108211982Sgabeblack@google.com emitter=partial_shared_emitter, 108311982Sgabeblack@google.com src_suffix='$SHOBJSUFFIX', 108411982Sgabeblack@google.com src_builder='SharedObject', 108511982Sgabeblack@google.com SHLINKFLAGS='$PSHLINKFLAGS', 108611982Sgabeblack@google.com LIBS='') 108711982Sgabeblack@google.com 108811982Sgabeblack@google.commain.Append(BUILDERS = { 'PartialShared' : partial_shared_builder, 108911982Sgabeblack@google.com 'PartialStatic' : partial_static_builder }) 109011982Sgabeblack@google.com 109113706Sgabeblack@google.comdef add_local_rpath(env, *targets): 109213706Sgabeblack@google.com '''Set up an RPATH for a library which lives in the build directory. 109313706Sgabeblack@google.com 109413706Sgabeblack@google.com The construction environment variable BIN_RPATH_PREFIX should be set to 109513706Sgabeblack@google.com the relative path of the build directory starting from the location of the 109613706Sgabeblack@google.com binary.''' 109713706Sgabeblack@google.com for target in targets: 109813706Sgabeblack@google.com target = env.Entry(target) 109913706Sgabeblack@google.com if not target.isdir(): 110013706Sgabeblack@google.com target = target.dir 110113706Sgabeblack@google.com relpath = os.path.relpath(target.abspath, env['BUILDDIR']) 110213706Sgabeblack@google.com components = [ 110313706Sgabeblack@google.com '\\$$ORIGIN', 110413706Sgabeblack@google.com '${BIN_RPATH_PREFIX}', 110513706Sgabeblack@google.com relpath 110613706Sgabeblack@google.com ] 110713706Sgabeblack@google.com env.Append(RPATH=[env.Literal(os.path.join(*components))]) 110813706Sgabeblack@google.com 110913713SAndrea.Mondelli@ucf.eduif sys.platform != "darwin": 111013713SAndrea.Mondelli@ucf.edu main.Append(LINKFLAGS=Split('-z origin')) 111113713SAndrea.Mondelli@ucf.edu 111213706Sgabeblack@google.commain.AddMethod(add_local_rpath, 'AddLocalRPATH') 111313706Sgabeblack@google.com 111411978Sgabeblack@google.com# builds in ext are shared across all configs in the build root. 111511978Sgabeblack@google.comext_dir = abspath(joinpath(str(main.root), 'ext')) 111612034Sgabeblack@google.comext_build_dirs = [] 111711978Sgabeblack@google.comfor root, dirs, files in os.walk(ext_dir): 111811978Sgabeblack@google.com if 'SConscript' in files: 111911978Sgabeblack@google.com build_dir = os.path.relpath(root, ext_dir) 112012034Sgabeblack@google.com ext_build_dirs.append(build_dir) 112111978Sgabeblack@google.com main.SConscript(joinpath(root, 'SConscript'), 112211978Sgabeblack@google.com variant_dir=joinpath(build_root, build_dir)) 112310915Sandreas.sandberg@arm.com 112413577Sciro.santilli@arm.comgdb_xml_dir = joinpath(ext_dir, 'gdb-xml') 112513577Sciro.santilli@arm.comExport('gdb_xml_dir') 112613577Sciro.santilli@arm.com 112711986Sandreas.sandberg@arm.commain.Prepend(CPPPATH=Dir('ext/pybind11/include/')) 112811986Sandreas.sandberg@arm.com 11291869SN/A################################################### 11301869SN/A# 113112015Sgabeblack@google.com# This builder and wrapper method are used to set up a directory with 113212015Sgabeblack@google.com# switching headers. Those are headers which are in a generic location and 113312015Sgabeblack@google.com# that include more specific headers from a directory chosen at build time 113412015Sgabeblack@google.com# based on the current build settings. 11353546Sgblack@eecs.umich.edu# 11363546Sgblack@eecs.umich.edu################################################### 11373546Sgblack@eecs.umich.edu 113812015Sgabeblack@google.comdef build_switching_header(target, source, env): 113912015Sgabeblack@google.com path = str(target[0]) 114012015Sgabeblack@google.com subdir = str(source[0]) 114112015Sgabeblack@google.com dp, fp = os.path.split(path) 114212015Sgabeblack@google.com dp = os.path.relpath(os.path.realpath(dp), 114312015Sgabeblack@google.com os.path.realpath(env['BUILDDIR'])) 114412015Sgabeblack@google.com with open(path, 'w') as hdr: 114512563Sgabeblack@google.com print('#include "%s/%s/%s"' % (dp, subdir, fp), file=hdr) 11463546Sgblack@eecs.umich.edu 114712015Sgabeblack@google.comswitching_header_action = MakeAction(build_switching_header, 114812015Sgabeblack@google.com Transform('GENERATE')) 114910196SCurtis.Dunham@arm.com 115012015Sgabeblack@google.comswitching_header_builder = Builder(action=switching_header_action, 115112015Sgabeblack@google.com source_factory=Value, 115212015Sgabeblack@google.com single_source=True) 115312015Sgabeblack@google.com 115412015Sgabeblack@google.commain.Append(BUILDERS = { 'SwitchingHeader': switching_header_builder }) 115512015Sgabeblack@google.com 115612015Sgabeblack@google.comdef switching_headers(self, headers, source): 115712015Sgabeblack@google.com for header in headers: 115812015Sgabeblack@google.com self.SwitchingHeader(header, source) 115912015Sgabeblack@google.com 116012015Sgabeblack@google.commain.AddMethod(switching_headers, 'SwitchingHeaders') 11613546Sgblack@eecs.umich.edu 11623546Sgblack@eecs.umich.edu################################################### 11633546Sgblack@eecs.umich.edu# 1164955SN/A# Define build environments for selected configurations. 1165955SN/A# 1166955SN/A################################################### 1167955SN/A 11685863Snate@binkert.orgfor variant_path in variant_paths: 116910135SCurtis.Dunham@arm.com if not GetOption('silent'): 117012563Sgabeblack@google.com print("Building in", variant_path) 11715343Sstever@gmail.com 11725343Sstever@gmail.com # Make a copy of the build-root environment to use for this config. 11736121Snate@binkert.org env = main.Clone() 11745863Snate@binkert.org env['BUILDDIR'] = variant_path 11754773Snate@binkert.org 11765863Snate@binkert.org # variant_dir is the tail component of build path, and is used to 11772632Sstever@eecs.umich.edu # determine the build parameters (e.g., 'ALPHA_SE') 11785863Snate@binkert.org (build_root, variant_dir) = splitpath(variant_path) 11792023SN/A 11805863Snate@binkert.org # Set env variables according to the build directory config. 11815863Snate@binkert.org sticky_vars.files = [] 11825863Snate@binkert.org # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in 11835863Snate@binkert.org # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke 11845863Snate@binkert.org # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings. 11855863Snate@binkert.org current_vars_file = joinpath(build_root, 'variables', variant_dir) 11865863Snate@binkert.org if isfile(current_vars_file): 11875863Snate@binkert.org sticky_vars.files.append(current_vars_file) 118810135SCurtis.Dunham@arm.com if not GetOption('silent'): 118912563Sgabeblack@google.com print("Using saved variables file %s" % current_vars_file) 119012034Sgabeblack@google.com elif variant_dir in ext_build_dirs: 119112034Sgabeblack@google.com # Things in ext are built without a variant directory. 119212034Sgabeblack@google.com continue 11932632Sstever@eecs.umich.edu else: 11945863Snate@binkert.org # Build dir-specific variables file doesn't exist. 11952023SN/A 11962632Sstever@eecs.umich.edu # Make sure the directory is there so we can create it later 11975863Snate@binkert.org opt_dir = dirname(current_vars_file) 11985342Sstever@gmail.com if not isdir(opt_dir): 11995863Snate@binkert.org mkdir(opt_dir) 12002632Sstever@eecs.umich.edu 12015863Snate@binkert.org # Get default build variables from source tree. Variables are 12025863Snate@binkert.org # normally determined by name of $VARIANT_DIR, but can be 12038267Ssteve.reinhardt@amd.com # overridden by '--default=' arg on command line. 12048120Sgblack@eecs.umich.edu default = GetOption('default') 12058267Ssteve.reinhardt@amd.com opts_dir = joinpath(main.root.abspath, 'build_opts') 12068267Ssteve.reinhardt@amd.com if default: 12078267Ssteve.reinhardt@amd.com default_vars_files = [joinpath(build_root, 'variables', default), 12088267Ssteve.reinhardt@amd.com joinpath(opts_dir, default)] 12098267Ssteve.reinhardt@amd.com else: 12108267Ssteve.reinhardt@amd.com default_vars_files = [joinpath(opts_dir, variant_dir)] 12118267Ssteve.reinhardt@amd.com existing_files = filter(isfile, default_vars_files) 12128267Ssteve.reinhardt@amd.com if existing_files: 12138267Ssteve.reinhardt@amd.com default_vars_file = existing_files[0] 12145863Snate@binkert.org sticky_vars.files.append(default_vars_file) 121512563Sgabeblack@google.com print("Variables file %s not found,\n using defaults in %s" 121612563Sgabeblack@google.com % (current_vars_file, default_vars_file)) 12172632Sstever@eecs.umich.edu else: 121812563Sgabeblack@google.com print("Error: cannot find variables file %s or " 121912563Sgabeblack@google.com "default file(s) %s" 122012563Sgabeblack@google.com % (current_vars_file, ' or '.join(default_vars_files))) 12212632Sstever@eecs.umich.edu Exit(1) 12221888SN/A 12235863Snate@binkert.org # Apply current variable settings to env 12245863Snate@binkert.org sticky_vars.Update(env) 12251858SN/A 12268120Sgblack@eecs.umich.edu help_texts["local_vars"] += \ 12278120Sgblack@eecs.umich.edu "Build variables for %s:\n" % variant_dir \ 12287756SAli.Saidi@ARM.com + sticky_vars.GenerateHelpText(env) 12292598SN/A 12305863Snate@binkert.org # Process variable settings. 12311858SN/A 12321858SN/A if not have_fenv and env['USE_FENV']: 123312563Sgabeblack@google.com print("Warning: <fenv.h> not available; " 123412563Sgabeblack@google.com "forcing USE_FENV to False in", variant_dir + ".") 12351858SN/A env['USE_FENV'] = False 12361858SN/A 12371858SN/A if not env['USE_FENV']: 123812563Sgabeblack@google.com print("Warning: No IEEE FP rounding mode control in", 123912563Sgabeblack@google.com variant_dir + ".") 124012563Sgabeblack@google.com print(" FP results may deviate slightly from other platforms.") 12411858SN/A 124212230Sgiacomo.travaglini@arm.com if not have_png and env['USE_PNG']: 124312563Sgabeblack@google.com print("Warning: <png.h> not available; " 124412563Sgabeblack@google.com "forcing USE_PNG to False in", variant_dir + ".") 124512230Sgiacomo.travaglini@arm.com env['USE_PNG'] = False 124612230Sgiacomo.travaglini@arm.com 124712230Sgiacomo.travaglini@arm.com if env['USE_PNG']: 124812230Sgiacomo.travaglini@arm.com env.Append(LIBS=['png']) 124912230Sgiacomo.travaglini@arm.com 12501858SN/A if env['EFENCE']: 12511858SN/A env.Append(LIBS=['efence']) 12521858SN/A 12539651SAndreas.Sandberg@ARM.com if env['USE_KVM']: 12549651SAndreas.Sandberg@ARM.com if not have_kvm: 125512563Sgabeblack@google.com print("Warning: Can not enable KVM, host seems to " 125612563Sgabeblack@google.com "lack KVM support") 12579651SAndreas.Sandberg@ARM.com env['USE_KVM'] = False 12589651SAndreas.Sandberg@ARM.com elif not is_isa_kvm_compatible(env['TARGET_ISA']): 125912563Sgabeblack@google.com print("Info: KVM support disabled due to unsupported host and " 126012563Sgabeblack@google.com "target ISA combination") 12619651SAndreas.Sandberg@ARM.com env['USE_KVM'] = False 12629651SAndreas.Sandberg@ARM.com 126312056Sgabeblack@google.com if env['USE_TUNTAP']: 126412056Sgabeblack@google.com if not have_tuntap: 126512563Sgabeblack@google.com print("Warning: Can't connect EtherTap with a tap device.") 126612056Sgabeblack@google.com env['USE_TUNTAP'] = False 126712056Sgabeblack@google.com 126811798Santhony.gutierrez@amd.com if env['BUILD_GPU']: 126911798Santhony.gutierrez@amd.com env.Append(CPPDEFINES=['BUILD_GPU']) 127011798Santhony.gutierrez@amd.com 12719986Sandreas@sandberg.pp.se # Warn about missing optional functionality 12729986Sandreas@sandberg.pp.se if env['USE_KVM']: 12739986Sandreas@sandberg.pp.se if not main['HAVE_PERF_ATTR_EXCLUDE_HOST']: 127412563Sgabeblack@google.com print("Warning: perf_event headers lack support for the " 127512563Sgabeblack@google.com "exclude_host attribute. KVM instruction counts will " 127612563Sgabeblack@google.com "be inaccurate.") 12779986Sandreas@sandberg.pp.se 12785863Snate@binkert.org # Save sticky variable settings back to current variables file 12795863Snate@binkert.org sticky_vars.Save(current_vars_file, env) 12801869SN/A 12811965SN/A if env['USE_SSE2']: 12827739Sgblack@eecs.umich.edu env.Append(CCFLAGS=['-msse2']) 12831965SN/A 12842761Sstever@eecs.umich.edu # The src/SConscript file sets up the build rules in 'env' according 12855863Snate@binkert.org # to the configured variables. It returns a list of environments, 12861869SN/A # one for each variant build (debug, opt, etc.) 128710196SCurtis.Dunham@arm.com SConscript('src/SConscript', variant_dir = variant_path, exports = 'env') 12881869SN/A 12898120Sgblack@eecs.umich.edu# base help text 12908120Sgblack@eecs.umich.eduHelp(''' 12918120Sgblack@eecs.umich.eduUsage: scons [scons options] [build variables] [target(s)] 12928120Sgblack@eecs.umich.edu 12938120Sgblack@eecs.umich.eduExtra scons options: 12948120Sgblack@eecs.umich.edu%(options)s 12958120Sgblack@eecs.umich.edu 12968120Sgblack@eecs.umich.eduGlobal build variables: 12978120Sgblack@eecs.umich.edu%(global_vars)s 12988120Sgblack@eecs.umich.edu 12998120Sgblack@eecs.umich.edu%(local_vars)s 13008120Sgblack@eecs.umich.edu''' % help_texts) 1301