SConstruct revision 13577
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
2182632Sstever@eecs.umich.edu# Each target must have 'build' in the interior of the path; the
2192632Sstever@eecs.umich.edu# directory below this will determine the build parameters.  For
2202632Sstever@eecs.umich.edu# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
2212632Sstever@eecs.umich.edu# recognize that ALPHA_SE specifies the configuration because it
2228268Ssteve.reinhardt@amd.com# follow 'build' in the build path.
2232632Sstever@eecs.umich.edu
2248268Ssteve.reinhardt@amd.com# The funky assignment to "[:]" is needed to replace the list contents
2258268Ssteve.reinhardt@amd.com# in place rather than reassign the symbol to a new list, which
2268268Ssteve.reinhardt@amd.com# doesn't work (obviously!).
2278268Ssteve.reinhardt@amd.comBUILD_TARGETS[:] = makePathListAbsolute(BUILD_TARGETS)
2283718Sstever@eecs.umich.edu
2292634Sstever@eecs.umich.edu# Generate a list of the unique build roots and configs that the
2302634Sstever@eecs.umich.edu# collected targets reference.
2315863Snate@binkert.orgvariant_paths = []
2322638Sstever@eecs.umich.edubuild_root = None
2338268Ssteve.reinhardt@amd.comfor t in BUILD_TARGETS:
2342632Sstever@eecs.umich.edu    path_dirs = t.split('/')
2352632Sstever@eecs.umich.edu    try:
2362632Sstever@eecs.umich.edu        build_top = rfind(path_dirs, 'build', -2)
2372632Sstever@eecs.umich.edu    except:
23812563Sgabeblack@google.com        print("Error: no non-leaf 'build' dir found on target path", t)
2391858SN/A        Exit(1)
2403716Sstever@eecs.umich.edu    this_build_root = joinpath('/',*path_dirs[:build_top+1])
2412638Sstever@eecs.umich.edu    if not build_root:
2422638Sstever@eecs.umich.edu        build_root = this_build_root
2432638Sstever@eecs.umich.edu    else:
2442638Sstever@eecs.umich.edu        if this_build_root != build_root:
24512563Sgabeblack@google.com            print("Error: build targets not under same build root\n"
24612563Sgabeblack@google.com                  "  %s\n  %s" % (build_root, this_build_root))
2472638Sstever@eecs.umich.edu            Exit(1)
2485863Snate@binkert.org    variant_path = joinpath('/',*path_dirs[:build_top+2])
2495863Snate@binkert.org    if variant_path not in variant_paths:
2505863Snate@binkert.org        variant_paths.append(variant_path)
251955SN/A
2525341Sstever@gmail.com# Make sure build_root exists (might not if this is the first build there)
2535341Sstever@gmail.comif not isdir(build_root):
2545863Snate@binkert.org    mkdir(build_root)
2557756SAli.Saidi@ARM.commain['BUILDROOT'] = build_root
2565341Sstever@gmail.com
2576121Snate@binkert.orgExport('main')
2584494Ssaidi@eecs.umich.edu
2596121Snate@binkert.orgmain.SConsignFile(joinpath(build_root, "sconsign"))
2601105SN/A
2612667Sstever@eecs.umich.edu# Default duplicate option is to use hard links, but this messes up
2622667Sstever@eecs.umich.edu# when you use emacs to edit a file in the target dir, as emacs moves
2632667Sstever@eecs.umich.edu# file to file~ then copies to file, breaking the link.  Symbolic
2642667Sstever@eecs.umich.edu# (soft) links work better.
2656121Snate@binkert.orgmain.SetOption('duplicate', 'soft-copy')
2662667Sstever@eecs.umich.edu
2675341Sstever@gmail.com#
2685863Snate@binkert.org# Set up global sticky variables... these are common to an entire build
2695341Sstever@gmail.com# tree (not specific to a particular build like ALPHA_SE)
2705341Sstever@gmail.com#
2715341Sstever@gmail.com
2728120Sgblack@eecs.umich.eduglobal_vars_file = joinpath(build_root, 'variables.global')
2735341Sstever@gmail.com
2748120Sgblack@eecs.umich.eduglobal_vars = Variables(global_vars_file, args=ARGUMENTS)
2755341Sstever@gmail.com
2768120Sgblack@eecs.umich.eduglobal_vars.AddVariables(
2776121Snate@binkert.org    ('CC', 'C compiler', environ.get('CC', main['CC'])),
2786121Snate@binkert.org    ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])),
2799396Sandreas.hansson@arm.com    ('PROTOC', 'protoc tool', environ.get('PROTOC', 'protoc')),
2805397Ssaidi@eecs.umich.edu    ('BATCH', 'Use batch pool for build and tests', False),
2815397Ssaidi@eecs.umich.edu    ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
2827727SAli.Saidi@ARM.com    ('M5_BUILD_CACHE', 'Cache built objects in this directory', False),
2838268Ssteve.reinhardt@amd.com    ('EXTRAS', 'Add extra directories to the compilation', '')
2846168Snate@binkert.org    )
2855341Sstever@gmail.com
2868120Sgblack@eecs.umich.edu# Update main environment with values from ARGUMENTS & global_vars_file
2878120Sgblack@eecs.umich.eduglobal_vars.Update(main)
2888120Sgblack@eecs.umich.eduhelp_texts["global_vars"] += global_vars.GenerateHelpText(main)
2896814Sgblack@eecs.umich.edu
2905863Snate@binkert.org# Save sticky variable settings back to current variables file
2918120Sgblack@eecs.umich.eduglobal_vars.Save(global_vars_file, main)
2925341Sstever@gmail.com
2935863Snate@binkert.org# Parse EXTRAS variable to build list of all directories where we're
2948268Ssteve.reinhardt@amd.com# look for sources etc.  This list is exported as extras_dir_list.
2956121Snate@binkert.orgbase_dir = main.srcdir.abspath
2966121Snate@binkert.orgif main['EXTRAS']:
2978268Ssteve.reinhardt@amd.com    extras_dir_list = makePathListAbsolute(main['EXTRAS'].split(':'))
2985742Snate@binkert.orgelse:
2995742Snate@binkert.org    extras_dir_list = []
3005341Sstever@gmail.com
3015742Snate@binkert.orgExport('base_dir')
3025742Snate@binkert.orgExport('extras_dir_list')
3035341Sstever@gmail.com
3046017Snate@binkert.org# the ext directory should be on the #includes path
3056121Snate@binkert.orgmain.Append(CPPPATH=[Dir('ext')])
3066017Snate@binkert.org
30712158Sandreas.sandberg@arm.com# Add shared top-level headers
30812158Sandreas.sandberg@arm.commain.Prepend(CPPPATH=Dir('include'))
30912158Sandreas.sandberg@arm.com
3108120Sgblack@eecs.umich.eduif GetOption('verbose'):
3117756SAli.Saidi@ARM.com    def MakeAction(action, string, *args, **kwargs):
3127756SAli.Saidi@ARM.com        return Action(action, *args, **kwargs)
3137756SAli.Saidi@ARM.comelse:
3147756SAli.Saidi@ARM.com    MakeAction = Action
3157816Ssteve.reinhardt@amd.com    main['CCCOMSTR']        = Transform("CC")
3167816Ssteve.reinhardt@amd.com    main['CXXCOMSTR']       = Transform("CXX")
3177816Ssteve.reinhardt@amd.com    main['ASCOMSTR']        = Transform("AS")
3187816Ssteve.reinhardt@amd.com    main['ARCOMSTR']        = Transform("AR", 0)
3197816Ssteve.reinhardt@amd.com    main['LINKCOMSTR']      = Transform("LINK", 0)
32011979Sgabeblack@google.com    main['SHLINKCOMSTR']    = Transform("SHLINK", 0)
3217816Ssteve.reinhardt@amd.com    main['RANLIBCOMSTR']    = Transform("RANLIB", 0)
3227816Ssteve.reinhardt@amd.com    main['M4COMSTR']        = Transform("M4")
3237816Ssteve.reinhardt@amd.com    main['SHCCCOMSTR']      = Transform("SHCC")
3247816Ssteve.reinhardt@amd.com    main['SHCXXCOMSTR']     = Transform("SHCXX")
3257756SAli.Saidi@ARM.comExport('MakeAction')
3267756SAli.Saidi@ARM.com
3279227Sandreas.hansson@arm.com# Initialize the Link-Time Optimization (LTO) flags
3289227Sandreas.hansson@arm.commain['LTO_CCFLAGS'] = []
3299227Sandreas.hansson@arm.commain['LTO_LDFLAGS'] = []
3309227Sandreas.hansson@arm.com
3319590Sandreas@sandberg.pp.se# According to the readme, tcmalloc works best if the compiler doesn't
3329590Sandreas@sandberg.pp.se# assume that we're using the builtin malloc and friends. These flags
3339590Sandreas@sandberg.pp.se# are compiler-specific, so we need to set them after we detect which
3349590Sandreas@sandberg.pp.se# compiler we're using.
3359590Sandreas@sandberg.pp.semain['TCMALLOC_CCFLAGS'] = []
3369590Sandreas@sandberg.pp.se
3376654Snate@binkert.orgCXX_version = readCommand([main['CXX'],'--version'], exception=False)
3386654Snate@binkert.orgCXX_V = readCommand([main['CXX'],'-V'], exception=False)
3395871Snate@binkert.org
3406121Snate@binkert.orgmain['GCC'] = CXX_version and CXX_version.find('g++') >= 0
3418946Sandreas.hansson@arm.commain['CLANG'] = CXX_version and CXX_version.find('clang') >= 0
3429419Sandreas.hansson@arm.comif main['GCC'] + main['CLANG'] > 1:
34312563Sgabeblack@google.com    print('Error: How can we have two at the same time?')
3443918Ssaidi@eecs.umich.edu    Exit(1)
3453918Ssaidi@eecs.umich.edu
3461858SN/A# Set up default C++ compiler flags
3479556Sandreas.hansson@arm.comif main['GCC'] or main['CLANG']:
3489556Sandreas.hansson@arm.com    # As gcc and clang share many flags, do the common parts here
3499556Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-pipe'])
3509556Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-fno-strict-aliasing'])
35111294Sandreas.hansson@arm.com    # Enable -Wall and -Wextra and then disable the few warnings that
35211294Sandreas.hansson@arm.com    # we consistently violate
35311294Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-Wall', '-Wundef', '-Wextra',
35411294Sandreas.hansson@arm.com                         '-Wno-sign-compare', '-Wno-unused-parameter'])
35510878Sandreas.hansson@arm.com    # We always compile using C++11
35610878Sandreas.hansson@arm.com    main.Append(CXXFLAGS=['-std=c++11'])
35711811Sbaz21@cam.ac.uk    if sys.platform.startswith('freebsd'):
35811811Sbaz21@cam.ac.uk        main.Append(CCFLAGS=['-I/usr/local/include'])
35911811Sbaz21@cam.ac.uk        main.Append(CXXFLAGS=['-I/usr/local/include'])
36011982Sgabeblack@google.com
36111982Sgabeblack@google.com    main['FILTER_PSHLINKFLAGS'] = lambda x: str(x).replace(' -shared', '')
36211982Sgabeblack@google.com    main['PSHLINKFLAGS'] = main.subst('${FILTER_PSHLINKFLAGS(SHLINKFLAGS)}')
36313421Sciro.santilli@arm.com    if GetOption('gold_linker'):
36413421Sciro.santilli@arm.com        main.Append(LINKFLAGS='-fuse-ld=gold')
36511982Sgabeblack@google.com    main['PLINKFLAGS'] = main.subst('${LINKFLAGS}')
36611992Sgabeblack@google.com    shared_partial_flags = ['-r', '-nostdlib']
36711982Sgabeblack@google.com    main.Append(PSHLINKFLAGS=shared_partial_flags)
36811982Sgabeblack@google.com    main.Append(PLINKFLAGS=shared_partial_flags)
36912305Sgabeblack@google.com
37012305Sgabeblack@google.com    # Treat warnings as errors but white list some warnings that we
37112305Sgabeblack@google.com    # want to allow (e.g., deprecation warnings).
37212305Sgabeblack@google.com    main.Append(CCFLAGS=['-Werror',
37312305Sgabeblack@google.com                         '-Wno-error=deprecated-declarations',
37412305Sgabeblack@google.com                         '-Wno-error=deprecated',
37512305Sgabeblack@google.com                        ])
3769556Sandreas.hansson@arm.comelse:
37712563Sgabeblack@google.com    print(termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal, end=' ')
37812563Sgabeblack@google.com    print("Don't know what compiler options to use for your compiler.")
37912563Sgabeblack@google.com    print(termcap.Yellow + '       compiler:' + termcap.Normal, main['CXX'])
38012563Sgabeblack@google.com    print(termcap.Yellow + '       version:' + termcap.Normal, end = ' ')
3819556Sandreas.hansson@arm.com    if not CXX_version:
38212563Sgabeblack@google.com        print(termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +
38312563Sgabeblack@google.com              termcap.Normal)
3849556Sandreas.hansson@arm.com    else:
38512563Sgabeblack@google.com        print(CXX_version.replace('\n', '<nl>'))
38612563Sgabeblack@google.com    print("       If you're trying to use a compiler other than GCC")
38712563Sgabeblack@google.com    print("       or clang, there appears to be something wrong with your")
38812563Sgabeblack@google.com    print("       environment.")
38912563Sgabeblack@google.com    print("       ")
39012563Sgabeblack@google.com    print("       If you are trying to use a compiler other than those listed")
39112563Sgabeblack@google.com    print("       above you will need to ease fix SConstruct and ")
39212563Sgabeblack@google.com    print("       src/SConscript to support that compiler.")
3939556Sandreas.hansson@arm.com    Exit(1)
3949556Sandreas.hansson@arm.com
3956121Snate@binkert.orgif main['GCC']:
39611500Sandreas.hansson@arm.com    # Check for a supported version of gcc. >= 4.8 is chosen for its
39710238Sandreas.hansson@arm.com    # level of c++11 support. See
39810878Sandreas.hansson@arm.com    # http://gcc.gnu.org/projects/cxx0x.html for details.
3999420Sandreas.hansson@arm.com    gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False)
40011500Sandreas.hansson@arm.com    if compareVersions(gcc_version, "4.8") < 0:
40112563Sgabeblack@google.com        print('Error: gcc version 4.8 or newer required.')
40212563Sgabeblack@google.com        print('       Installed version: ', gcc_version)
4039420Sandreas.hansson@arm.com        Exit(1)
4049420Sandreas.hansson@arm.com
4059420Sandreas.hansson@arm.com    main['GCC_VERSION'] = gcc_version
4069420Sandreas.hansson@arm.com
40712063Sgabeblack@google.com    if compareVersions(gcc_version, '4.9') >= 0:
40812063Sgabeblack@google.com        # Incremental linking with LTO is currently broken in gcc versions
40912063Sgabeblack@google.com        # 4.9 and above. A version where everything works completely hasn't
41012063Sgabeblack@google.com        # yet been identified.
41112063Sgabeblack@google.com        #
41212063Sgabeblack@google.com        # https://gcc.gnu.org/bugzilla/show_bug.cgi?id=67548
41312063Sgabeblack@google.com        main['BROKEN_INCREMENTAL_LTO'] = True
41412063Sgabeblack@google.com    if compareVersions(gcc_version, '6.0') >= 0:
41512063Sgabeblack@google.com        # gcc versions 6.0 and greater accept an -flinker-output flag which
41612063Sgabeblack@google.com        # selects what type of output the linker should generate. This is
41712063Sgabeblack@google.com        # necessary for incremental lto to work, but is also broken in
41812063Sgabeblack@google.com        # current versions of gcc. It may not be necessary in future
41912063Sgabeblack@google.com        # versions. We add it here since it might be, and as a reminder that
42012063Sgabeblack@google.com        # it exists. It's excluded if lto is being forced.
42112063Sgabeblack@google.com        #
42212063Sgabeblack@google.com        # https://gcc.gnu.org/gcc-6/changes.html
42312063Sgabeblack@google.com        # https://gcc.gnu.org/ml/gcc-patches/2015-11/msg03161.html
42412063Sgabeblack@google.com        # https://gcc.gnu.org/bugzilla/show_bug.cgi?id=69866
42512063Sgabeblack@google.com        if not GetOption('force_lto'):
42612063Sgabeblack@google.com            main.Append(PSHLINKFLAGS='-flinker-output=rel')
42712063Sgabeblack@google.com            main.Append(PLINKFLAGS='-flinker-output=rel')
42812063Sgabeblack@google.com
42910457Sandreas.hansson@arm.com    # Make sure we warn if the user has requested to compile with the
43010457Sandreas.hansson@arm.com    # Undefined Benahvior Sanitizer and this version of gcc does not
43110457Sandreas.hansson@arm.com    # support it.
43210457Sandreas.hansson@arm.com    if GetOption('with_ubsan') and \
43310457Sandreas.hansson@arm.com            compareVersions(gcc_version, '4.9') < 0:
43412563Sgabeblack@google.com        print(termcap.Yellow + termcap.Bold +
43512563Sgabeblack@google.com            'Warning: UBSan is only supported using gcc 4.9 and later.' +
43612563Sgabeblack@google.com            termcap.Normal)
43710457Sandreas.hansson@arm.com
43812063Sgabeblack@google.com    disable_lto = GetOption('no_lto')
43912063Sgabeblack@google.com    if not disable_lto and main.get('BROKEN_INCREMENTAL_LTO', False) and \
44012063Sgabeblack@google.com            not GetOption('force_lto'):
44112563Sgabeblack@google.com        print(termcap.Yellow + termcap.Bold +
44212563Sgabeblack@google.com            'Warning: Your compiler doesn\'t support incremental linking' +
44312563Sgabeblack@google.com            ' and lto at the same time, so lto is being disabled. To force' +
44412563Sgabeblack@google.com            ' lto on anyway, use the --force-lto option. That will disable' +
44512563Sgabeblack@google.com            ' partial linking.' +
44612563Sgabeblack@google.com            termcap.Normal)
44712063Sgabeblack@google.com        disable_lto = True
44812063Sgabeblack@google.com
44910238Sandreas.hansson@arm.com    # Add the appropriate Link-Time Optimization (LTO) flags
45010238Sandreas.hansson@arm.com    # unless LTO is explicitly turned off. Note that these flags
45110238Sandreas.hansson@arm.com    # are only used by the fast target.
45212063Sgabeblack@google.com    if not disable_lto:
45310238Sandreas.hansson@arm.com        # Pass the LTO flag when compiling to produce GIMPLE
45410238Sandreas.hansson@arm.com        # output, we merely create the flags here and only append
45510416Sandreas.hansson@arm.com        # them later
45610238Sandreas.hansson@arm.com        main['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
4579227Sandreas.hansson@arm.com
45810238Sandreas.hansson@arm.com        # Use the same amount of jobs for LTO as we are running
45910416Sandreas.hansson@arm.com        # scons with
46010416Sandreas.hansson@arm.com        main['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
4619227Sandreas.hansson@arm.com
4629590Sandreas@sandberg.pp.se    main.Append(TCMALLOC_CCFLAGS=['-fno-builtin-malloc', '-fno-builtin-calloc',
4639590Sandreas@sandberg.pp.se                                  '-fno-builtin-realloc', '-fno-builtin-free'])
4649590Sandreas@sandberg.pp.se
46512304Sgabeblack@google.com    # The address sanitizer is available for gcc >= 4.8
46612304Sgabeblack@google.com    if GetOption('with_asan'):
46712304Sgabeblack@google.com        if GetOption('with_ubsan') and \
46812688Sgiacomo.travaglini@arm.com                compareVersions(main['GCC_VERSION'], '4.9') >= 0:
46912688Sgiacomo.travaglini@arm.com            main.Append(CCFLAGS=['-fsanitize=address,undefined',
47012688Sgiacomo.travaglini@arm.com                                 '-fno-omit-frame-pointer'],
47113020Sshunhsingou@google.com                        LINKFLAGS='-fsanitize=address,undefined')
47212304Sgabeblack@google.com        else:
47312688Sgiacomo.travaglini@arm.com            main.Append(CCFLAGS=['-fsanitize=address',
47412688Sgiacomo.travaglini@arm.com                                 '-fno-omit-frame-pointer'],
47513020Sshunhsingou@google.com                        LINKFLAGS='-fsanitize=address')
47612304Sgabeblack@google.com    # Only gcc >= 4.9 supports UBSan, so check both the version
47712304Sgabeblack@google.com    # and the command-line option before adding the compiler and
47812304Sgabeblack@google.com    # linker flags.
47912304Sgabeblack@google.com    elif GetOption('with_ubsan') and \
48012688Sgiacomo.travaglini@arm.com            compareVersions(main['GCC_VERSION'], '4.9') >= 0:
48112688Sgiacomo.travaglini@arm.com        main.Append(CCFLAGS='-fsanitize=undefined')
48212688Sgiacomo.travaglini@arm.com        main.Append(LINKFLAGS='-fsanitize=undefined')
48312304Sgabeblack@google.com
4848737Skoansin.tan@gmail.comelif main['CLANG']:
48510878Sandreas.hansson@arm.com    # Check for a supported version of clang, >= 3.1 is needed to
48611500Sandreas.hansson@arm.com    # support similar features as gcc 4.8. See
4879420Sandreas.hansson@arm.com    # http://clang.llvm.org/cxx_status.html for details
4888737Skoansin.tan@gmail.com    clang_version_re = re.compile(".* version (\d+\.\d+)")
48910106SMitch.Hayenga@arm.com    clang_version_match = clang_version_re.search(CXX_version)
4908737Skoansin.tan@gmail.com    if (clang_version_match):
4918737Skoansin.tan@gmail.com        clang_version = clang_version_match.groups()[0]
49210878Sandreas.hansson@arm.com        if compareVersions(clang_version, "3.1") < 0:
49312563Sgabeblack@google.com            print('Error: clang version 3.1 or newer required.')
49412563Sgabeblack@google.com            print('       Installed version:', clang_version)
4958737Skoansin.tan@gmail.com            Exit(1)
4968737Skoansin.tan@gmail.com    else:
49712563Sgabeblack@google.com        print('Error: Unable to determine clang version.')
4988737Skoansin.tan@gmail.com        Exit(1)
4998737Skoansin.tan@gmail.com
50011294Sandreas.hansson@arm.com    # clang has a few additional warnings that we disable, extraneous
5019556Sandreas.hansson@arm.com    # parantheses are allowed due to Ruby's printing of the AST,
5029556Sandreas.hansson@arm.com    # finally self assignments are allowed as the generated CPU code
5039556Sandreas.hansson@arm.com    # is relying on this
50411294Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-Wno-parentheses',
50510278SAndreas.Sandberg@ARM.com                         '-Wno-self-assign',
50610278SAndreas.Sandberg@ARM.com                         # Some versions of libstdc++ (4.8?) seem to
50710278SAndreas.Sandberg@ARM.com                         # use struct hash and class hash
50810278SAndreas.Sandberg@ARM.com                         # interchangeably.
50910278SAndreas.Sandberg@ARM.com                         '-Wno-mismatched-tags',
51010278SAndreas.Sandberg@ARM.com                         ])
5119556Sandreas.hansson@arm.com
5129590Sandreas@sandberg.pp.se    main.Append(TCMALLOC_CCFLAGS=['-fno-builtin'])
5139590Sandreas@sandberg.pp.se
5149420Sandreas.hansson@arm.com    # On Mac OS X/Darwin we need to also use libc++ (part of XCode) as
5159846Sandreas.hansson@arm.com    # opposed to libstdc++, as the later is dated.
5169846Sandreas.hansson@arm.com    if sys.platform == "darwin":
5179846Sandreas.hansson@arm.com        main.Append(CXXFLAGS=['-stdlib=libc++'])
5189846Sandreas.hansson@arm.com        main.Append(LIBS=['c++'])
5198946Sandreas.hansson@arm.com
52011811Sbaz21@cam.ac.uk    # On FreeBSD we need libthr.
52111811Sbaz21@cam.ac.uk    if sys.platform.startswith('freebsd'):
52211811Sbaz21@cam.ac.uk        main.Append(LIBS=['thr'])
52311811Sbaz21@cam.ac.uk
52412304Sgabeblack@google.com    # We require clang >= 3.1, so there is no need to check any
52512304Sgabeblack@google.com    # versions here.
52612304Sgabeblack@google.com    if GetOption('with_ubsan'):
52712304Sgabeblack@google.com        if GetOption('with_asan'):
52813020Sshunhsingou@google.com            main.Append(CCFLAGS=['-fsanitize=address,undefined',
52913020Sshunhsingou@google.com                                 '-fno-omit-frame-pointer'],
53012304Sgabeblack@google.com                       LINKFLAGS='-fsanitize=address,undefined')
53112304Sgabeblack@google.com        else:
53213020Sshunhsingou@google.com            main.Append(CCFLAGS='-fsanitize=undefined',
53313020Sshunhsingou@google.com                        LINKFLAGS='-fsanitize=undefined')
53412304Sgabeblack@google.com
53512304Sgabeblack@google.com    elif GetOption('with_asan'):
53613020Sshunhsingou@google.com        main.Append(CCFLAGS=['-fsanitize=address',
53713020Sshunhsingou@google.com                             '-fno-omit-frame-pointer'],
53812304Sgabeblack@google.com                   LINKFLAGS='-fsanitize=address')
53912304Sgabeblack@google.com
5403918Ssaidi@eecs.umich.eduelse:
54112563Sgabeblack@google.com    print(termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal, end=' ')
54212563Sgabeblack@google.com    print("Don't know what compiler options to use for your compiler.")
54312563Sgabeblack@google.com    print(termcap.Yellow + '       compiler:' + termcap.Normal, main['CXX'])
54412563Sgabeblack@google.com    print(termcap.Yellow + '       version:' + termcap.Normal, end=' ')
5459068SAli.Saidi@ARM.com    if not CXX_version:
54612563Sgabeblack@google.com        print(termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +
54712563Sgabeblack@google.com              termcap.Normal)
5489068SAli.Saidi@ARM.com    else:
54912563Sgabeblack@google.com        print(CXX_version.replace('\n', '<nl>'))
55012563Sgabeblack@google.com    print("       If you're trying to use a compiler other than GCC")
55112563Sgabeblack@google.com    print("       or clang, there appears to be something wrong with your")
55212563Sgabeblack@google.com    print("       environment.")
55312563Sgabeblack@google.com    print("       ")
55412563Sgabeblack@google.com    print("       If you are trying to use a compiler other than those listed")
55512563Sgabeblack@google.com    print("       above you will need to ease fix SConstruct and ")
55612563Sgabeblack@google.com    print("       src/SConscript to support that compiler.")
5573918Ssaidi@eecs.umich.edu    Exit(1)
5583918Ssaidi@eecs.umich.edu
5596157Snate@binkert.org# Set up common yacc/bison flags (needed for Ruby)
5606157Snate@binkert.orgmain['YACCFLAGS'] = '-d'
5616157Snate@binkert.orgmain['YACCHXXFILESUFFIX'] = '.hh'
5626157Snate@binkert.org
5635397Ssaidi@eecs.umich.edu# Do this after we save setting back, or else we'll tack on an
5645397Ssaidi@eecs.umich.edu# extra 'qdo' every time we run scons.
5656121Snate@binkert.orgif main['BATCH']:
5666121Snate@binkert.org    main['CC']     = main['BATCH_CMD'] + ' ' + main['CC']
5676121Snate@binkert.org    main['CXX']    = main['BATCH_CMD'] + ' ' + main['CXX']
5686121Snate@binkert.org    main['AS']     = main['BATCH_CMD'] + ' ' + main['AS']
5696121Snate@binkert.org    main['AR']     = main['BATCH_CMD'] + ' ' + main['AR']
5706121Snate@binkert.org    main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB']
5715397Ssaidi@eecs.umich.edu
5721851SN/Aif sys.platform == 'cygwin':
5731851SN/A    # cygwin has some header file issues...
5747739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=["-Wno-uninitialized"])
575955SN/A
5769396Sandreas.hansson@arm.com# Check for the protobuf compiler
5779396Sandreas.hansson@arm.comprotoc_version = readCommand([main['PROTOC'], '--version'],
5789396Sandreas.hansson@arm.com                             exception='').split()
5799396Sandreas.hansson@arm.com
5809396Sandreas.hansson@arm.com# First two words should be "libprotoc x.y.z"
5819396Sandreas.hansson@arm.comif len(protoc_version) < 2 or protoc_version[0] != 'libprotoc':
58212563Sgabeblack@google.com    print(termcap.Yellow + termcap.Bold +
58312563Sgabeblack@google.com        'Warning: Protocol buffer compiler (protoc) not found.\n' +
58412563Sgabeblack@google.com        '         Please install protobuf-compiler for tracing support.' +
58512563Sgabeblack@google.com        termcap.Normal)
5869396Sandreas.hansson@arm.com    main['PROTOC'] = False
5879396Sandreas.hansson@arm.comelse:
5889396Sandreas.hansson@arm.com    # Based on the availability of the compress stream wrappers,
5899396Sandreas.hansson@arm.com    # require 2.1.0
5909396Sandreas.hansson@arm.com    min_protoc_version = '2.1.0'
5919396Sandreas.hansson@arm.com    if compareVersions(protoc_version[1], min_protoc_version) < 0:
59212563Sgabeblack@google.com        print(termcap.Yellow + termcap.Bold +
59312563Sgabeblack@google.com            'Warning: protoc version', min_protoc_version,
59412563Sgabeblack@google.com            'or newer required.\n' +
59512563Sgabeblack@google.com            '         Installed version:', protoc_version[1],
59612563Sgabeblack@google.com            termcap.Normal)
5979477Sandreas.hansson@arm.com        main['PROTOC'] = False
5989477Sandreas.hansson@arm.com    else:
5999477Sandreas.hansson@arm.com        # Attempt to determine the appropriate include path and
6009477Sandreas.hansson@arm.com        # library path using pkg-config, that means we also need to
6019477Sandreas.hansson@arm.com        # check for pkg-config. Note that it is possible to use
6029477Sandreas.hansson@arm.com        # protobuf without the involvement of pkg-config. Later on we
6039477Sandreas.hansson@arm.com        # check go a library config check and at that point the test
6049477Sandreas.hansson@arm.com        # will fail if libprotobuf cannot be found.
6059477Sandreas.hansson@arm.com        if readCommand(['pkg-config', '--version'], exception=''):
6069477Sandreas.hansson@arm.com            try:
6079477Sandreas.hansson@arm.com                # Attempt to establish what linking flags to add for protobuf
6089477Sandreas.hansson@arm.com                # using pkg-config
6099477Sandreas.hansson@arm.com                main.ParseConfig('pkg-config --cflags --libs-only-L protobuf')
6109477Sandreas.hansson@arm.com            except:
61112563Sgabeblack@google.com                print(termcap.Yellow + termcap.Bold +
61212563Sgabeblack@google.com                    'Warning: pkg-config could not get protobuf flags.' +
61312563Sgabeblack@google.com                    termcap.Normal)
6149396Sandreas.hansson@arm.com
6152667Sstever@eecs.umich.edu
61610710Sandreas.hansson@arm.com# Check for 'timeout' from GNU coreutils. If present, regressions will
61710710Sandreas.hansson@arm.com# be run with a time limit. We require version 8.13 since we rely on
61810710Sandreas.hansson@arm.com# support for the '--foreground' option.
61911811Sbaz21@cam.ac.ukif sys.platform.startswith('freebsd'):
62011811Sbaz21@cam.ac.uk    timeout_lines = readCommand(['gtimeout', '--version'],
62111811Sbaz21@cam.ac.uk                                exception='').splitlines()
62211811Sbaz21@cam.ac.ukelse:
62311811Sbaz21@cam.ac.uk    timeout_lines = readCommand(['timeout', '--version'],
62411811Sbaz21@cam.ac.uk                                exception='').splitlines()
62510710Sandreas.hansson@arm.com# Get the first line and tokenize it
62610710Sandreas.hansson@arm.comtimeout_version = timeout_lines[0].split() if timeout_lines else []
62710710Sandreas.hansson@arm.commain['TIMEOUT'] =  timeout_version and \
62810710Sandreas.hansson@arm.com    compareVersions(timeout_version[-1], '8.13') >= 0
62910384SCurtis.Dunham@arm.com
6309986Sandreas@sandberg.pp.se# Add a custom Check function to test for structure members.
6319986Sandreas@sandberg.pp.sedef CheckMember(context, include, decl, member, include_quotes="<>"):
6329986Sandreas@sandberg.pp.se    context.Message("Checking for member %s in %s..." %
6339986Sandreas@sandberg.pp.se                    (member, decl))
6349986Sandreas@sandberg.pp.se    text = """
6359986Sandreas@sandberg.pp.se#include %(header)s
6369986Sandreas@sandberg.pp.seint main(){
6379986Sandreas@sandberg.pp.se  %(decl)s test;
6389986Sandreas@sandberg.pp.se  (void)test.%(member)s;
6399986Sandreas@sandberg.pp.se  return 0;
6409986Sandreas@sandberg.pp.se};
6419986Sandreas@sandberg.pp.se""" % { "header" : include_quotes[0] + include + include_quotes[1],
6429986Sandreas@sandberg.pp.se        "decl" : decl,
6439986Sandreas@sandberg.pp.se        "member" : member,
6449986Sandreas@sandberg.pp.se        }
6459986Sandreas@sandberg.pp.se
6469986Sandreas@sandberg.pp.se    ret = context.TryCompile(text, extension=".cc")
6479986Sandreas@sandberg.pp.se    context.Result(ret)
6489986Sandreas@sandberg.pp.se    return ret
6499986Sandreas@sandberg.pp.se
6502638Sstever@eecs.umich.edu# Platform-specific configuration.  Note again that we assume that all
6512638Sstever@eecs.umich.edu# builds under a given build root run on the same host platform.
6526121Snate@binkert.orgconf = Configure(main,
6533716Sstever@eecs.umich.edu                 conf_dir = joinpath(build_root, '.scons_config'),
6545522Snate@binkert.org                 log_file = joinpath(build_root, 'scons_config.log'),
6559986Sandreas@sandberg.pp.se                 custom_tests = {
6569986Sandreas@sandberg.pp.se        'CheckMember' : CheckMember,
6579986Sandreas@sandberg.pp.se        })
6585522Snate@binkert.org
6595227Ssaidi@eecs.umich.edu# Check if we should compile a 64 bit binary on Mac OS X/Darwin
6605227Ssaidi@eecs.umich.edutry:
6615227Ssaidi@eecs.umich.edu    import platform
6625227Ssaidi@eecs.umich.edu    uname = platform.uname()
6636654Snate@binkert.org    if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0:
6646654Snate@binkert.org        if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
6657769SAli.Saidi@ARM.com            main.Append(CCFLAGS=['-arch', 'x86_64'])
6667769SAli.Saidi@ARM.com            main.Append(CFLAGS=['-arch', 'x86_64'])
6677769SAli.Saidi@ARM.com            main.Append(LINKFLAGS=['-arch', 'x86_64'])
6687769SAli.Saidi@ARM.com            main.Append(ASFLAGS=['-arch', 'x86_64'])
6695227Ssaidi@eecs.umich.eduexcept:
6705227Ssaidi@eecs.umich.edu    pass
6715227Ssaidi@eecs.umich.edu
6725204Sstever@gmail.com# Recent versions of scons substitute a "Null" object for Configure()
6735204Sstever@gmail.com# when configuration isn't necessary, e.g., if the "--help" option is
6745204Sstever@gmail.com# present.  Unfortuantely this Null object always returns false,
6755204Sstever@gmail.com# breaking all our configuration checks.  We replace it with our own
6765204Sstever@gmail.com# more optimistic null object that returns True instead.
6775204Sstever@gmail.comif not conf:
6785204Sstever@gmail.com    def NullCheck(*args, **kwargs):
6795204Sstever@gmail.com        return True
6805204Sstever@gmail.com
6815204Sstever@gmail.com    class NullConf:
6825204Sstever@gmail.com        def __init__(self, env):
6835204Sstever@gmail.com            self.env = env
6845204Sstever@gmail.com        def Finish(self):
6855204Sstever@gmail.com            return self.env
6865204Sstever@gmail.com        def __getattr__(self, mname):
6875204Sstever@gmail.com            return NullCheck
6885204Sstever@gmail.com
6896121Snate@binkert.org    conf = NullConf(main)
6905204Sstever@gmail.com
6917727SAli.Saidi@ARM.com# Cache build files in the supplied directory.
6927727SAli.Saidi@ARM.comif main['M5_BUILD_CACHE']:
69312563Sgabeblack@google.com    print('Using build cache located at', main['M5_BUILD_CACHE'])
6947727SAli.Saidi@ARM.com    CacheDir(main['M5_BUILD_CACHE'])
6957727SAli.Saidi@ARM.com
69611988Sandreas.sandberg@arm.commain['USE_PYTHON'] = not GetOption('without_python')
69711988Sandreas.sandberg@arm.comif main['USE_PYTHON']:
69810453SAndrew.Bardsley@arm.com    # Find Python include and library directories for embedding the
69910453SAndrew.Bardsley@arm.com    # interpreter. We rely on python-config to resolve the appropriate
70010453SAndrew.Bardsley@arm.com    # includes and linker flags. ParseConfig does not seem to understand
70110453SAndrew.Bardsley@arm.com    # the more exotic linker flags such as -Xlinker and -export-dynamic so
70210453SAndrew.Bardsley@arm.com    # we add them explicitly below. If you want to link in an alternate
70310453SAndrew.Bardsley@arm.com    # version of python, see above for instructions on how to invoke
70410453SAndrew.Bardsley@arm.com    # scons with the appropriate PATH set.
70510453SAndrew.Bardsley@arm.com    #
70610453SAndrew.Bardsley@arm.com    # First we check if python2-config exists, else we use python-config
70710453SAndrew.Bardsley@arm.com    python_config = readCommand(['which', 'python2-config'],
70810160Sandreas.hansson@arm.com                                exception='').strip()
70910453SAndrew.Bardsley@arm.com    if not os.path.exists(python_config):
71010453SAndrew.Bardsley@arm.com        python_config = readCommand(['which', 'python-config'],
71110453SAndrew.Bardsley@arm.com                                    exception='').strip()
71210453SAndrew.Bardsley@arm.com    py_includes = readCommand([python_config, '--includes'],
71310453SAndrew.Bardsley@arm.com                              exception='').split()
71413541Sandrea.mondelli@ucf.edu    py_includes = filter(lambda s: match(r'.*\/include\/.*',s), py_includes)
71510453SAndrew.Bardsley@arm.com    # Strip the -I from the include folders before adding them to the
71610453SAndrew.Bardsley@arm.com    # CPPPATH
71713541Sandrea.mondelli@ucf.edu    py_includes = map(lambda s: s[2:] if s.startswith('-I') else s, py_includes)
71813541Sandrea.mondelli@ucf.edu    main.Append(CPPPATH=py_includes)
7199812Sandreas.hansson@arm.com
72010453SAndrew.Bardsley@arm.com    # Read the linker flags and split them into libraries and other link
72110453SAndrew.Bardsley@arm.com    # flags. The libraries are added later through the call the CheckLib.
72210453SAndrew.Bardsley@arm.com    py_ld_flags = readCommand([python_config, '--ldflags'],
72310453SAndrew.Bardsley@arm.com        exception='').split()
72410453SAndrew.Bardsley@arm.com    py_libs = []
72510453SAndrew.Bardsley@arm.com    for lib in py_ld_flags:
72610453SAndrew.Bardsley@arm.com         if not lib.startswith('-l'):
72710453SAndrew.Bardsley@arm.com             main.Append(LINKFLAGS=[lib])
72810453SAndrew.Bardsley@arm.com         else:
72910453SAndrew.Bardsley@arm.com             lib = lib[2:]
73010453SAndrew.Bardsley@arm.com             if lib not in py_libs:
73110453SAndrew.Bardsley@arm.com                 py_libs.append(lib)
7327727SAli.Saidi@ARM.com
73310453SAndrew.Bardsley@arm.com    # verify that this stuff works
73410453SAndrew.Bardsley@arm.com    if not conf.CheckHeader('Python.h', '<>'):
73512790Smatteo.fusi@bsc.es        print("Error: Check failed for Python.h header in", py_includes)
73612790Smatteo.fusi@bsc.es        print("Two possible reasons:")
73712790Smatteo.fusi@bsc.es        print("1. Python headers are not installed (You can install the "
73812790Smatteo.fusi@bsc.es              "package python-dev on Ubuntu and RedHat)")
73912790Smatteo.fusi@bsc.es        print("2. SCons is using a wrong C compiler. This can happen if "
74012790Smatteo.fusi@bsc.es              "CC has the wrong value.")
74112790Smatteo.fusi@bsc.es        print("CC = %s" % main['CC'])
74210453SAndrew.Bardsley@arm.com        Exit(1)
7433118Sstever@eecs.umich.edu
74410453SAndrew.Bardsley@arm.com    for lib in py_libs:
74510453SAndrew.Bardsley@arm.com        if not conf.CheckLib(lib):
74612563Sgabeblack@google.com            print("Error: can't find library %s required by python" % lib)
74710453SAndrew.Bardsley@arm.com            Exit(1)
7483118Sstever@eecs.umich.edu
7493483Ssaidi@eecs.umich.edu# On Solaris you need to use libsocket for socket ops
7503494Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
7513494Ssaidi@eecs.umich.edu   if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
75212563Sgabeblack@google.com       print("Can't find library with socket calls (e.g. accept())")
7533483Ssaidi@eecs.umich.edu       Exit(1)
7543483Ssaidi@eecs.umich.edu
7553053Sstever@eecs.umich.edu# Check for zlib.  If the check passes, libz will be automatically
7563053Sstever@eecs.umich.edu# added to the LIBS environment variable.
7573918Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
75812563Sgabeblack@google.com    print('Error: did not find needed zlib compression library '
75912563Sgabeblack@google.com          'and/or zlib.h header file.')
76012563Sgabeblack@google.com    print('       Please install zlib and try again.')
7613053Sstever@eecs.umich.edu    Exit(1)
7623053Sstever@eecs.umich.edu
7639396Sandreas.hansson@arm.com# If we have the protobuf compiler, also make sure we have the
7649396Sandreas.hansson@arm.com# development libraries. If the check passes, libprotobuf will be
7659396Sandreas.hansson@arm.com# automatically added to the LIBS environment variable. After
7669396Sandreas.hansson@arm.com# this, we can use the HAVE_PROTOBUF flag to determine if we have
7679396Sandreas.hansson@arm.com# got both protoc and libprotobuf available.
7689396Sandreas.hansson@arm.commain['HAVE_PROTOBUF'] = main['PROTOC'] and \
7699396Sandreas.hansson@arm.com    conf.CheckLibWithHeader('protobuf', 'google/protobuf/message.h',
7709396Sandreas.hansson@arm.com                            'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;')
7719396Sandreas.hansson@arm.com
77212920Sgabeblack@google.com# Valgrind gets much less confused if you tell it when you're using
77312920Sgabeblack@google.com# alternative stacks.
77412920Sgabeblack@google.commain['HAVE_VALGRIND'] = conf.CheckCHeader('valgrind/valgrind.h')
77512920Sgabeblack@google.com
7769477Sandreas.hansson@arm.com# If we have the compiler but not the library, print another warning.
7779396Sandreas.hansson@arm.comif main['PROTOC'] and not main['HAVE_PROTOBUF']:
77812563Sgabeblack@google.com    print(termcap.Yellow + termcap.Bold +
77912563Sgabeblack@google.com        'Warning: did not find protocol buffer library and/or headers.\n' +
78012563Sgabeblack@google.com    '       Please install libprotobuf-dev for tracing support.' +
78112563Sgabeblack@google.com    termcap.Normal)
7829396Sandreas.hansson@arm.com
7837840Snate@binkert.org# Check for librt.
7847865Sgblack@eecs.umich.eduhave_posix_clock = \
7857865Sgblack@eecs.umich.edu    conf.CheckLibWithHeader(None, 'time.h', 'C',
7867865Sgblack@eecs.umich.edu                            'clock_nanosleep(0,0,NULL,NULL);') or \
7877865Sgblack@eecs.umich.edu    conf.CheckLibWithHeader('rt', 'time.h', 'C',
7887865Sgblack@eecs.umich.edu                            'clock_nanosleep(0,0,NULL,NULL);')
7897840Snate@binkert.org
7909900Sandreas@sandberg.pp.sehave_posix_timers = \
7919900Sandreas@sandberg.pp.se    conf.CheckLibWithHeader([None, 'rt'], [ 'time.h', 'signal.h' ], 'C',
7929900Sandreas@sandberg.pp.se                            'timer_create(CLOCK_MONOTONIC, NULL, NULL);')
7939900Sandreas@sandberg.pp.se
79410456SCurtis.Dunham@arm.comif not GetOption('without_tcmalloc'):
79510456SCurtis.Dunham@arm.com    if conf.CheckLib('tcmalloc'):
79610456SCurtis.Dunham@arm.com        main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS'])
79710456SCurtis.Dunham@arm.com    elif conf.CheckLib('tcmalloc_minimal'):
79810456SCurtis.Dunham@arm.com        main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS'])
79910456SCurtis.Dunham@arm.com    else:
80012563Sgabeblack@google.com        print(termcap.Yellow + termcap.Bold +
80112563Sgabeblack@google.com              "You can get a 12% performance improvement by "
80212563Sgabeblack@google.com              "installing tcmalloc (libgoogle-perftools-dev package "
80312563Sgabeblack@google.com              "on Ubuntu or RedHat)." + termcap.Normal)
8049045SAli.Saidi@ARM.com
80511235Sandreas.sandberg@arm.com
80611235Sandreas.sandberg@arm.com# Detect back trace implementations. The last implementation in the
80711235Sandreas.sandberg@arm.com# list will be used by default.
80811235Sandreas.sandberg@arm.combacktrace_impls = [ "none" ]
80911235Sandreas.sandberg@arm.com
81012485Sjang.hanhwi@gmail.combacktrace_checker = 'char temp;' + \
81112485Sjang.hanhwi@gmail.com    ' backtrace_symbols_fd((void*)&temp, 0, 0);'
81212485Sjang.hanhwi@gmail.comif conf.CheckLibWithHeader(None, 'execinfo.h', 'C', backtrace_checker):
81311235Sandreas.sandberg@arm.com    backtrace_impls.append("glibc")
81411811Sbaz21@cam.ac.ukelif conf.CheckLibWithHeader('execinfo', 'execinfo.h', 'C',
81512485Sjang.hanhwi@gmail.com                             backtrace_checker):
81611811Sbaz21@cam.ac.uk    # NetBSD and FreeBSD need libexecinfo.
81711811Sbaz21@cam.ac.uk    backtrace_impls.append("glibc")
81811811Sbaz21@cam.ac.uk    main.Append(LIBS=['execinfo'])
81911235Sandreas.sandberg@arm.com
82011235Sandreas.sandberg@arm.comif backtrace_impls[-1] == "none":
82111235Sandreas.sandberg@arm.com    default_backtrace_impl = "none"
82212563Sgabeblack@google.com    print(termcap.Yellow + termcap.Bold +
82312563Sgabeblack@google.com        "No suitable back trace implementation found." +
82412563Sgabeblack@google.com        termcap.Normal)
82511235Sandreas.sandberg@arm.com
8267840Snate@binkert.orgif not have_posix_clock:
82712563Sgabeblack@google.com    print("Can't find library for POSIX clocks.")
8287840Snate@binkert.org
8291858SN/A# Check for <fenv.h> (C99 FP environment control)
8301858SN/Ahave_fenv = conf.CheckHeader('fenv.h', '<>')
8311858SN/Aif not have_fenv:
83212563Sgabeblack@google.com    print("Warning: Header file <fenv.h> not found.")
83312563Sgabeblack@google.com    print("         This host has no IEEE FP rounding mode control.")
8341858SN/A
83512230Sgiacomo.travaglini@arm.com# Check for <png.h> (libpng library needed if wanting to dump
83612230Sgiacomo.travaglini@arm.com# frame buffer image in png format)
83712230Sgiacomo.travaglini@arm.comhave_png = conf.CheckHeader('png.h', '<>')
83812230Sgiacomo.travaglini@arm.comif not have_png:
83912563Sgabeblack@google.com    print("Warning: Header file <png.h> not found.")
84012563Sgabeblack@google.com    print("         This host has no libpng library.")
84112563Sgabeblack@google.com    print("         Disabling support for PNG framebuffers.")
84212230Sgiacomo.travaglini@arm.com
8439903Sandreas.hansson@arm.com# Check if we should enable KVM-based hardware virtualization. The API
8449903Sandreas.hansson@arm.com# we rely on exists since version 2.6.36 of the kernel, but somehow
8459903Sandreas.hansson@arm.com# the KVM_API_VERSION does not reflect the change. We test for one of
8469903Sandreas.hansson@arm.com# the types as a fall back.
84710841Sandreas.sandberg@arm.comhave_kvm = conf.CheckHeader('linux/kvm.h', '<>')
8489651SAndreas.Sandberg@ARM.comif not have_kvm:
84912563Sgabeblack@google.com    print("Info: Compatible header file <linux/kvm.h> not found, "
85012563Sgabeblack@google.com          "disabling KVM support.")
8519651SAndreas.Sandberg@ARM.com
85212056Sgabeblack@google.com# Check if the TUN/TAP driver is available.
85312056Sgabeblack@google.comhave_tuntap = conf.CheckHeader('linux/if_tun.h', '<>')
85412056Sgabeblack@google.comif not have_tuntap:
85512563Sgabeblack@google.com    print("Info: Compatible header file <linux/if_tun.h> not found.")
85612056Sgabeblack@google.com
85710841Sandreas.sandberg@arm.com# x86 needs support for xsave. We test for the structure here since we
85810841Sandreas.sandberg@arm.com# won't be able to run new tests by the time we know which ISA we're
85910841Sandreas.sandberg@arm.com# targeting.
86010841Sandreas.sandberg@arm.comhave_kvm_xsave = conf.CheckTypeSize('struct kvm_xsave',
86110841Sandreas.sandberg@arm.com                                    '#include <linux/kvm.h>') != 0
86210841Sandreas.sandberg@arm.com
8639651SAndreas.Sandberg@ARM.com# Check if the requested target ISA is compatible with the host
8649651SAndreas.Sandberg@ARM.comdef is_isa_kvm_compatible(isa):
8659651SAndreas.Sandberg@ARM.com    try:
8669651SAndreas.Sandberg@ARM.com        import platform
8679651SAndreas.Sandberg@ARM.com        host_isa = platform.machine()
8689651SAndreas.Sandberg@ARM.com    except:
86912563Sgabeblack@google.com        print("Warning: Failed to determine host ISA.")
8709651SAndreas.Sandberg@ARM.com        return False
8719651SAndreas.Sandberg@ARM.com
87210841Sandreas.sandberg@arm.com    if not have_posix_timers:
87312563Sgabeblack@google.com        print("Warning: Can not enable KVM, host seems to lack support "
87412563Sgabeblack@google.com              "for POSIX timers")
87510841Sandreas.sandberg@arm.com        return False
87610841Sandreas.sandberg@arm.com
87710841Sandreas.sandberg@arm.com    if isa == "arm":
87810860Sandreas.sandberg@arm.com        return host_isa in ( "armv7l", "aarch64" )
87910841Sandreas.sandberg@arm.com    elif isa == "x86":
88010841Sandreas.sandberg@arm.com        if host_isa != "x86_64":
88110841Sandreas.sandberg@arm.com            return False
88210841Sandreas.sandberg@arm.com
88310841Sandreas.sandberg@arm.com        if not have_kvm_xsave:
88412563Sgabeblack@google.com            print("KVM on x86 requires xsave support in kernel headers.")
88510841Sandreas.sandberg@arm.com            return False
88610841Sandreas.sandberg@arm.com
88710841Sandreas.sandberg@arm.com        return True
88810841Sandreas.sandberg@arm.com    else:
88910841Sandreas.sandberg@arm.com        return False
8909651SAndreas.Sandberg@ARM.com
8919651SAndreas.Sandberg@ARM.com
8929986Sandreas@sandberg.pp.se# Check if the exclude_host attribute is available. We want this to
8939986Sandreas@sandberg.pp.se# get accurate instruction counts in KVM.
8949986Sandreas@sandberg.pp.semain['HAVE_PERF_ATTR_EXCLUDE_HOST'] = conf.CheckMember(
8959986Sandreas@sandberg.pp.se    'linux/perf_event.h', 'struct perf_event_attr', 'exclude_host')
8969986Sandreas@sandberg.pp.se
8979986Sandreas@sandberg.pp.se
8985863Snate@binkert.org######################################################################
8995863Snate@binkert.org#
9005863Snate@binkert.org# Finish the configuration
9015863Snate@binkert.org#
9026121Snate@binkert.orgmain = conf.Finish()
9031858SN/A
9045863Snate@binkert.org######################################################################
9055863Snate@binkert.org#
9065863Snate@binkert.org# Collect all non-global variables
9075863Snate@binkert.org#
9085863Snate@binkert.org
9092139SN/A# Define the universe of supported ISAs
9104202Sbinkertn@umich.eduall_isa_list = [ ]
91111308Santhony.gutierrez@amd.comall_gpu_isa_list = [ ]
9124202Sbinkertn@umich.eduExport('all_isa_list')
91311308Santhony.gutierrez@amd.comExport('all_gpu_isa_list')
9142139SN/A
9156994Snate@binkert.orgclass CpuModel(object):
9166994Snate@binkert.org    '''The CpuModel class encapsulates everything the ISA parser needs to
9176994Snate@binkert.org    know about a particular CPU model.'''
9186994Snate@binkert.org
9196994Snate@binkert.org    # Dict of available CPU model objects.  Accessible as CpuModel.dict.
9206994Snate@binkert.org    dict = {}
9216994Snate@binkert.org
9226994Snate@binkert.org    # Constructor.  Automatically adds models to CpuModel.dict.
92310319SAndreas.Sandberg@ARM.com    def __init__(self, name, default=False):
9246994Snate@binkert.org        self.name = name           # name of model
9256994Snate@binkert.org
9266994Snate@binkert.org        # This cpu is enabled by default
9276994Snate@binkert.org        self.default = default
9286994Snate@binkert.org
9296994Snate@binkert.org        # Add self to dict
9306994Snate@binkert.org        if name in CpuModel.dict:
9316994Snate@binkert.org            raise AttributeError, "CpuModel '%s' already registered" % name
9326994Snate@binkert.org        CpuModel.dict[name] = self
9336994Snate@binkert.org
9346994Snate@binkert.orgExport('CpuModel')
9352155SN/A
9365863Snate@binkert.org# Sticky variables get saved in the variables file so they persist from
9371869SN/A# one invocation to the next (unless overridden, in which case the new
9381869SN/A# value becomes sticky).
9395863Snate@binkert.orgsticky_vars = Variables(args=ARGUMENTS)
9405863Snate@binkert.orgExport('sticky_vars')
9414202Sbinkertn@umich.edu
9426108Snate@binkert.org# Sticky variables that should be exported
9436108Snate@binkert.orgexport_vars = []
9446108Snate@binkert.orgExport('export_vars')
9456108Snate@binkert.org
9469219Spower.jg@gmail.com# For Ruby
9479219Spower.jg@gmail.comall_protocols = []
9489219Spower.jg@gmail.comExport('all_protocols')
9499219Spower.jg@gmail.comprotocol_dirs = []
9509219Spower.jg@gmail.comExport('protocol_dirs')
9519219Spower.jg@gmail.comslicc_includes = []
9529219Spower.jg@gmail.comExport('slicc_includes')
9539219Spower.jg@gmail.com
9544202Sbinkertn@umich.edu# Walk the tree and execute all SConsopts scripts that wil add to the
9555863Snate@binkert.org# above variables
95610135SCurtis.Dunham@arm.comif GetOption('verbose'):
95712563Sgabeblack@google.com    print("Reading SConsopts")
9585742Snate@binkert.orgfor bdir in [ base_dir ] + extras_dir_list:
9598268Ssteve.reinhardt@amd.com    if not isdir(bdir):
96012563Sgabeblack@google.com        print("Error: directory '%s' does not exist" % bdir)
9618268Ssteve.reinhardt@amd.com        Exit(1)
9625742Snate@binkert.org    for root, dirs, files in os.walk(bdir):
9635341Sstever@gmail.com        if 'SConsopts' in files:
9648474Sgblack@eecs.umich.edu            if GetOption('verbose'):
96512563Sgabeblack@google.com                print("Reading", joinpath(root, 'SConsopts'))
9665342Sstever@gmail.com            SConscript(joinpath(root, 'SConsopts'))
9674202Sbinkertn@umich.edu
9684202Sbinkertn@umich.eduall_isa_list.sort()
96911308Santhony.gutierrez@amd.comall_gpu_isa_list.sort()
9704202Sbinkertn@umich.edu
9715863Snate@binkert.orgsticky_vars.AddVariables(
9725863Snate@binkert.org    EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list),
97311308Santhony.gutierrez@amd.com    EnumVariable('TARGET_GPU_ISA', 'Target GPU ISA', 'hsail', all_gpu_isa_list),
9746994Snate@binkert.org    ListVariable('CPU_MODELS', 'CPU models',
9756994Snate@binkert.org                 sorted(n for n,m in CpuModel.dict.iteritems() if m.default),
97610319SAndreas.Sandberg@ARM.com                 sorted(CpuModel.dict.keys())),
9775863Snate@binkert.org    BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
9785863Snate@binkert.org                 False),
9795863Snate@binkert.org    BoolVariable('SS_COMPATIBLE_FP',
9805863Snate@binkert.org                 'Make floating-point results compatible with SimpleScalar',
9815863Snate@binkert.org                 False),
9825863Snate@binkert.org    BoolVariable('USE_SSE2',
9835863Snate@binkert.org                 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
9845863Snate@binkert.org                 False),
9857840Snate@binkert.org    BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock),
9865863Snate@binkert.org    BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
98712230Sgiacomo.travaglini@arm.com    BoolVariable('USE_PNG',  'Enable support for PNG images', have_png),
98812230Sgiacomo.travaglini@arm.com    BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability',
98912230Sgiacomo.travaglini@arm.com                 False),
99012230Sgiacomo.travaglini@arm.com    BoolVariable('USE_KVM', 'Enable hardware virtualized (KVM) CPU models',
99112230Sgiacomo.travaglini@arm.com                 have_kvm),
99212056Sgabeblack@google.com    BoolVariable('USE_TUNTAP',
99312056Sgabeblack@google.com                 'Enable using a tap device to bridge to the host network',
99412056Sgabeblack@google.com                 have_tuntap),
99511308Santhony.gutierrez@amd.com    BoolVariable('BUILD_GPU', 'Build the compute-GPU model', False),
9969219Spower.jg@gmail.com    EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None',
9979219Spower.jg@gmail.com                  all_protocols),
99811235Sandreas.sandberg@arm.com    EnumVariable('BACKTRACE_IMPL', 'Post-mortem dump implementation',
99911235Sandreas.sandberg@arm.com                 backtrace_impls[-1], backtrace_impls)
10001869SN/A    )
10011858SN/A
10025863Snate@binkert.org# These variables get exported to #defines in config/*.hh (see src/SConscript).
100311308Santhony.gutierrez@amd.comexport_vars += ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'TARGET_GPU_ISA',
100412061Sjason@lowepower.com                'CP_ANNOTATE', 'USE_POSIX_CLOCK', 'USE_KVM', 'USE_TUNTAP',
100512920Sgabeblack@google.com                'PROTOCOL', 'HAVE_PROTOBUF', 'HAVE_VALGRIND',
100612920Sgabeblack@google.com                'HAVE_PERF_ATTR_EXCLUDE_HOST', 'USE_PNG']
10071858SN/A
1008955SN/A###################################################
1009955SN/A#
10101869SN/A# Define a SCons builder for configuration flag headers.
10111869SN/A#
10121869SN/A###################################################
10131869SN/A
10141869SN/A# This function generates a config header file that #defines the
10155863Snate@binkert.org# variable symbol to the current variable setting (0 or 1).  The source
10165863Snate@binkert.org# operands are the name of the variable and a Value node containing the
10175863Snate@binkert.org# value of the variable.
10181869SN/Adef build_config_file(target, source, env):
10195863Snate@binkert.org    (variable, value) = [s.get_contents() for s in source]
10201869SN/A    f = file(str(target[0]), 'w')
102112563Sgabeblack@google.com    print('#define', variable, value, file=f)
10221869SN/A    f.close()
10231869SN/A    return None
10241869SN/A
10251869SN/A# Combine the two functions into a scons Action object.
10268483Sgblack@eecs.umich.educonfig_action = MakeAction(build_config_file, Transform("CONFIG H", 2))
10271869SN/A
10281869SN/A# The emitter munges the source & target node lists to reflect what
10291869SN/A# we're really doing.
10301869SN/Adef config_emitter(target, source, env):
10315863Snate@binkert.org    # extract variable name from Builder arg
10325863Snate@binkert.org    variable = str(target[0])
10331869SN/A    # True target is config header file
10345863Snate@binkert.org    target = joinpath('config', variable.lower() + '.hh')
10355863Snate@binkert.org    val = env[variable]
10363356Sbinkertn@umich.edu    if isinstance(val, bool):
10373356Sbinkertn@umich.edu        # Force value to 0/1
10383356Sbinkertn@umich.edu        val = int(val)
10393356Sbinkertn@umich.edu    elif isinstance(val, str):
10403356Sbinkertn@umich.edu        val = '"' + val + '"'
10414781Snate@binkert.org
10425863Snate@binkert.org    # Sources are variable name & value (packaged in SCons Value nodes)
10435863Snate@binkert.org    return ([target], [Value(variable), Value(val)])
10441869SN/A
10451869SN/Aconfig_builder = Builder(emitter = config_emitter, action = config_action)
10461869SN/A
10476121Snate@binkert.orgmain.Append(BUILDERS = { 'ConfigFile' : config_builder })
10481869SN/A
104911982Sgabeblack@google.com###################################################
105011982Sgabeblack@google.com#
105111982Sgabeblack@google.com# Builders for static and shared partially linked object files.
105211982Sgabeblack@google.com#
105311982Sgabeblack@google.com###################################################
105411982Sgabeblack@google.com
105511982Sgabeblack@google.compartial_static_builder = Builder(action=SCons.Defaults.LinkAction,
105611982Sgabeblack@google.com                                 src_suffix='$OBJSUFFIX',
105711982Sgabeblack@google.com                                 src_builder=['StaticObject', 'Object'],
105811982Sgabeblack@google.com                                 LINKFLAGS='$PLINKFLAGS',
105911982Sgabeblack@google.com                                 LIBS='')
106011982Sgabeblack@google.com
106111982Sgabeblack@google.comdef partial_shared_emitter(target, source, env):
106211982Sgabeblack@google.com    for tgt in target:
106311982Sgabeblack@google.com        tgt.attributes.shared = 1
106411982Sgabeblack@google.com    return (target, source)
106511982Sgabeblack@google.compartial_shared_builder = Builder(action=SCons.Defaults.ShLinkAction,
106611982Sgabeblack@google.com                                 emitter=partial_shared_emitter,
106711982Sgabeblack@google.com                                 src_suffix='$SHOBJSUFFIX',
106811982Sgabeblack@google.com                                 src_builder='SharedObject',
106911982Sgabeblack@google.com                                 SHLINKFLAGS='$PSHLINKFLAGS',
107011982Sgabeblack@google.com                                 LIBS='')
107111982Sgabeblack@google.com
107211982Sgabeblack@google.commain.Append(BUILDERS = { 'PartialShared' : partial_shared_builder,
107311982Sgabeblack@google.com                         'PartialStatic' : partial_static_builder })
107411982Sgabeblack@google.com
107511978Sgabeblack@google.com# builds in ext are shared across all configs in the build root.
107611978Sgabeblack@google.comext_dir = abspath(joinpath(str(main.root), 'ext'))
107712034Sgabeblack@google.comext_build_dirs = []
107811978Sgabeblack@google.comfor root, dirs, files in os.walk(ext_dir):
107911978Sgabeblack@google.com    if 'SConscript' in files:
108011978Sgabeblack@google.com        build_dir = os.path.relpath(root, ext_dir)
108112034Sgabeblack@google.com        ext_build_dirs.append(build_dir)
108211978Sgabeblack@google.com        main.SConscript(joinpath(root, 'SConscript'),
108311978Sgabeblack@google.com                        variant_dir=joinpath(build_root, build_dir))
108410915Sandreas.sandberg@arm.com
108513577Sciro.santilli@arm.comgdb_xml_dir = joinpath(ext_dir, 'gdb-xml')
108613577Sciro.santilli@arm.comExport('gdb_xml_dir')
108713577Sciro.santilli@arm.com
108811986Sandreas.sandberg@arm.commain.Prepend(CPPPATH=Dir('ext/pybind11/include/'))
108911986Sandreas.sandberg@arm.com
10901869SN/A###################################################
10911869SN/A#
109212015Sgabeblack@google.com# This builder and wrapper method are used to set up a directory with
109312015Sgabeblack@google.com# switching headers. Those are headers which are in a generic location and
109412015Sgabeblack@google.com# that include more specific headers from a directory chosen at build time
109512015Sgabeblack@google.com# based on the current build settings.
10963546Sgblack@eecs.umich.edu#
10973546Sgblack@eecs.umich.edu###################################################
10983546Sgblack@eecs.umich.edu
109912015Sgabeblack@google.comdef build_switching_header(target, source, env):
110012015Sgabeblack@google.com    path = str(target[0])
110112015Sgabeblack@google.com    subdir = str(source[0])
110212015Sgabeblack@google.com    dp, fp = os.path.split(path)
110312015Sgabeblack@google.com    dp = os.path.relpath(os.path.realpath(dp),
110412015Sgabeblack@google.com                         os.path.realpath(env['BUILDDIR']))
110512015Sgabeblack@google.com    with open(path, 'w') as hdr:
110612563Sgabeblack@google.com        print('#include "%s/%s/%s"' % (dp, subdir, fp), file=hdr)
11073546Sgblack@eecs.umich.edu
110812015Sgabeblack@google.comswitching_header_action = MakeAction(build_switching_header,
110912015Sgabeblack@google.com                                     Transform('GENERATE'))
111010196SCurtis.Dunham@arm.com
111112015Sgabeblack@google.comswitching_header_builder = Builder(action=switching_header_action,
111212015Sgabeblack@google.com                                   source_factory=Value,
111312015Sgabeblack@google.com                                   single_source=True)
111412015Sgabeblack@google.com
111512015Sgabeblack@google.commain.Append(BUILDERS = { 'SwitchingHeader': switching_header_builder })
111612015Sgabeblack@google.com
111712015Sgabeblack@google.comdef switching_headers(self, headers, source):
111812015Sgabeblack@google.com    for header in headers:
111912015Sgabeblack@google.com        self.SwitchingHeader(header, source)
112012015Sgabeblack@google.com
112112015Sgabeblack@google.commain.AddMethod(switching_headers, 'SwitchingHeaders')
11223546Sgblack@eecs.umich.edu
11233546Sgblack@eecs.umich.edu###################################################
11243546Sgblack@eecs.umich.edu#
1125955SN/A# Define build environments for selected configurations.
1126955SN/A#
1127955SN/A###################################################
1128955SN/A
11295863Snate@binkert.orgfor variant_path in variant_paths:
113010135SCurtis.Dunham@arm.com    if not GetOption('silent'):
113112563Sgabeblack@google.com        print("Building in", variant_path)
11325343Sstever@gmail.com
11335343Sstever@gmail.com    # Make a copy of the build-root environment to use for this config.
11346121Snate@binkert.org    env = main.Clone()
11355863Snate@binkert.org    env['BUILDDIR'] = variant_path
11364773Snate@binkert.org
11375863Snate@binkert.org    # variant_dir is the tail component of build path, and is used to
11382632Sstever@eecs.umich.edu    # determine the build parameters (e.g., 'ALPHA_SE')
11395863Snate@binkert.org    (build_root, variant_dir) = splitpath(variant_path)
11402023SN/A
11415863Snate@binkert.org    # Set env variables according to the build directory config.
11425863Snate@binkert.org    sticky_vars.files = []
11435863Snate@binkert.org    # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
11445863Snate@binkert.org    # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
11455863Snate@binkert.org    # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
11465863Snate@binkert.org    current_vars_file = joinpath(build_root, 'variables', variant_dir)
11475863Snate@binkert.org    if isfile(current_vars_file):
11485863Snate@binkert.org        sticky_vars.files.append(current_vars_file)
114910135SCurtis.Dunham@arm.com        if not GetOption('silent'):
115012563Sgabeblack@google.com            print("Using saved variables file %s" % current_vars_file)
115112034Sgabeblack@google.com    elif variant_dir in ext_build_dirs:
115212034Sgabeblack@google.com        # Things in ext are built without a variant directory.
115312034Sgabeblack@google.com        continue
11542632Sstever@eecs.umich.edu    else:
11555863Snate@binkert.org        # Build dir-specific variables file doesn't exist.
11562023SN/A
11572632Sstever@eecs.umich.edu        # Make sure the directory is there so we can create it later
11585863Snate@binkert.org        opt_dir = dirname(current_vars_file)
11595342Sstever@gmail.com        if not isdir(opt_dir):
11605863Snate@binkert.org            mkdir(opt_dir)
11612632Sstever@eecs.umich.edu
11625863Snate@binkert.org        # Get default build variables from source tree.  Variables are
11635863Snate@binkert.org        # normally determined by name of $VARIANT_DIR, but can be
11648267Ssteve.reinhardt@amd.com        # overridden by '--default=' arg on command line.
11658120Sgblack@eecs.umich.edu        default = GetOption('default')
11668267Ssteve.reinhardt@amd.com        opts_dir = joinpath(main.root.abspath, 'build_opts')
11678267Ssteve.reinhardt@amd.com        if default:
11688267Ssteve.reinhardt@amd.com            default_vars_files = [joinpath(build_root, 'variables', default),
11698267Ssteve.reinhardt@amd.com                                  joinpath(opts_dir, default)]
11708267Ssteve.reinhardt@amd.com        else:
11718267Ssteve.reinhardt@amd.com            default_vars_files = [joinpath(opts_dir, variant_dir)]
11728267Ssteve.reinhardt@amd.com        existing_files = filter(isfile, default_vars_files)
11738267Ssteve.reinhardt@amd.com        if existing_files:
11748267Ssteve.reinhardt@amd.com            default_vars_file = existing_files[0]
11755863Snate@binkert.org            sticky_vars.files.append(default_vars_file)
117612563Sgabeblack@google.com            print("Variables file %s not found,\n  using defaults in %s"
117712563Sgabeblack@google.com                  % (current_vars_file, default_vars_file))
11782632Sstever@eecs.umich.edu        else:
117912563Sgabeblack@google.com            print("Error: cannot find variables file %s or "
118012563Sgabeblack@google.com                  "default file(s) %s"
118112563Sgabeblack@google.com                  % (current_vars_file, ' or '.join(default_vars_files)))
11822632Sstever@eecs.umich.edu            Exit(1)
11831888SN/A
11845863Snate@binkert.org    # Apply current variable settings to env
11855863Snate@binkert.org    sticky_vars.Update(env)
11861858SN/A
11878120Sgblack@eecs.umich.edu    help_texts["local_vars"] += \
11888120Sgblack@eecs.umich.edu        "Build variables for %s:\n" % variant_dir \
11897756SAli.Saidi@ARM.com                 + sticky_vars.GenerateHelpText(env)
11902598SN/A
11915863Snate@binkert.org    # Process variable settings.
11921858SN/A
11931858SN/A    if not have_fenv and env['USE_FENV']:
119412563Sgabeblack@google.com        print("Warning: <fenv.h> not available; "
119512563Sgabeblack@google.com              "forcing USE_FENV to False in", variant_dir + ".")
11961858SN/A        env['USE_FENV'] = False
11971858SN/A
11981858SN/A    if not env['USE_FENV']:
119912563Sgabeblack@google.com        print("Warning: No IEEE FP rounding mode control in",
120012563Sgabeblack@google.com              variant_dir + ".")
120112563Sgabeblack@google.com        print("         FP results may deviate slightly from other platforms.")
12021858SN/A
120312230Sgiacomo.travaglini@arm.com    if not have_png and env['USE_PNG']:
120412563Sgabeblack@google.com        print("Warning: <png.h> not available; "
120512563Sgabeblack@google.com              "forcing USE_PNG to False in", variant_dir + ".")
120612230Sgiacomo.travaglini@arm.com        env['USE_PNG'] = False
120712230Sgiacomo.travaglini@arm.com
120812230Sgiacomo.travaglini@arm.com    if env['USE_PNG']:
120912230Sgiacomo.travaglini@arm.com        env.Append(LIBS=['png'])
121012230Sgiacomo.travaglini@arm.com
12111858SN/A    if env['EFENCE']:
12121858SN/A        env.Append(LIBS=['efence'])
12131858SN/A
12149651SAndreas.Sandberg@ARM.com    if env['USE_KVM']:
12159651SAndreas.Sandberg@ARM.com        if not have_kvm:
121612563Sgabeblack@google.com            print("Warning: Can not enable KVM, host seems to "
121712563Sgabeblack@google.com                  "lack KVM support")
12189651SAndreas.Sandberg@ARM.com            env['USE_KVM'] = False
12199651SAndreas.Sandberg@ARM.com        elif not is_isa_kvm_compatible(env['TARGET_ISA']):
122012563Sgabeblack@google.com            print("Info: KVM support disabled due to unsupported host and "
122112563Sgabeblack@google.com                  "target ISA combination")
12229651SAndreas.Sandberg@ARM.com            env['USE_KVM'] = False
12239651SAndreas.Sandberg@ARM.com
122412056Sgabeblack@google.com    if env['USE_TUNTAP']:
122512056Sgabeblack@google.com        if not have_tuntap:
122612563Sgabeblack@google.com            print("Warning: Can't connect EtherTap with a tap device.")
122712056Sgabeblack@google.com            env['USE_TUNTAP'] = False
122812056Sgabeblack@google.com
122911798Santhony.gutierrez@amd.com    if env['BUILD_GPU']:
123011798Santhony.gutierrez@amd.com        env.Append(CPPDEFINES=['BUILD_GPU'])
123111798Santhony.gutierrez@amd.com
12329986Sandreas@sandberg.pp.se    # Warn about missing optional functionality
12339986Sandreas@sandberg.pp.se    if env['USE_KVM']:
12349986Sandreas@sandberg.pp.se        if not main['HAVE_PERF_ATTR_EXCLUDE_HOST']:
123512563Sgabeblack@google.com            print("Warning: perf_event headers lack support for the "
123612563Sgabeblack@google.com                  "exclude_host attribute. KVM instruction counts will "
123712563Sgabeblack@google.com                  "be inaccurate.")
12389986Sandreas@sandberg.pp.se
12395863Snate@binkert.org    # Save sticky variable settings back to current variables file
12405863Snate@binkert.org    sticky_vars.Save(current_vars_file, env)
12411869SN/A
12421965SN/A    if env['USE_SSE2']:
12437739Sgblack@eecs.umich.edu        env.Append(CCFLAGS=['-msse2'])
12441965SN/A
12452761Sstever@eecs.umich.edu    # The src/SConscript file sets up the build rules in 'env' according
12465863Snate@binkert.org    # to the configured variables.  It returns a list of environments,
12471869SN/A    # one for each variant build (debug, opt, etc.)
124810196SCurtis.Dunham@arm.com    SConscript('src/SConscript', variant_dir = variant_path, exports = 'env')
12491869SN/A
12508120Sgblack@eecs.umich.edu# base help text
12518120Sgblack@eecs.umich.eduHelp('''
12528120Sgblack@eecs.umich.eduUsage: scons [scons options] [build variables] [target(s)]
12538120Sgblack@eecs.umich.edu
12548120Sgblack@eecs.umich.eduExtra scons options:
12558120Sgblack@eecs.umich.edu%(options)s
12568120Sgblack@eecs.umich.edu
12578120Sgblack@eecs.umich.eduGlobal build variables:
12588120Sgblack@eecs.umich.edu%(global_vars)s
12598120Sgblack@eecs.umich.edu
12608120Sgblack@eecs.umich.edu%(local_vars)s
12618120Sgblack@eecs.umich.edu''' % help_texts)
1262