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