SConstruct revision 12305
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
816654Snate@binkert.org# Global Python includes
8210196SCurtis.Dunham@arm.comimport itertools
83955SN/Aimport os
845396Ssaidi@eecs.umich.eduimport re
8511401Sandreas.sandberg@arm.comimport shutil
865863Snate@binkert.orgimport subprocess
875863Snate@binkert.orgimport sys
884202Sbinkertn@umich.edu
895863Snate@binkert.orgfrom os import mkdir, environ
905863Snate@binkert.orgfrom os.path import abspath, basename, dirname, expanduser, normpath
915863Snate@binkert.orgfrom os.path import exists,  isdir, isfile
925863Snate@binkert.orgfrom os.path import join as joinpath, split as splitpath
93955SN/A
946654Snate@binkert.org# SCons includes
955273Sstever@gmail.comimport SCons
965871Snate@binkert.orgimport SCons.Node
975273Sstever@gmail.com
986654Snate@binkert.orgfrom m5.util import compareVersions, readCommand
995396Ssaidi@eecs.umich.edu
1008120Sgblack@eecs.umich.eduhelp_texts = {
1018120Sgblack@eecs.umich.edu    "options" : "",
1028120Sgblack@eecs.umich.edu    "global_vars" : "",
1038120Sgblack@eecs.umich.edu    "local_vars" : ""
1048120Sgblack@eecs.umich.edu}
1058120Sgblack@eecs.umich.edu
1068120Sgblack@eecs.umich.eduExport("help_texts")
1078120Sgblack@eecs.umich.edu
1088879Ssteve.reinhardt@amd.com
1098879Ssteve.reinhardt@amd.com# There's a bug in scons in that (1) by default, the help texts from
1108879Ssteve.reinhardt@amd.com# AddOption() are supposed to be displayed when you type 'scons -h'
1118879Ssteve.reinhardt@amd.com# and (2) you can override the help displayed by 'scons -h' using the
1128879Ssteve.reinhardt@amd.com# Help() function, but these two features are incompatible: once
1138879Ssteve.reinhardt@amd.com# you've overridden the help text using Help(), there's no way to get
1148879Ssteve.reinhardt@amd.com# at the help texts from AddOptions.  See:
1158879Ssteve.reinhardt@amd.com#     http://scons.tigris.org/issues/show_bug.cgi?id=2356
1168879Ssteve.reinhardt@amd.com#     http://scons.tigris.org/issues/show_bug.cgi?id=2611
1178879Ssteve.reinhardt@amd.com# This hack lets us extract the help text from AddOptions and
1188879Ssteve.reinhardt@amd.com# re-inject it via Help().  Ideally someday this bug will be fixed and
1198879Ssteve.reinhardt@amd.com# we can just use AddOption directly.
1208879Ssteve.reinhardt@amd.comdef AddLocalOption(*args, **kwargs):
1218120Sgblack@eecs.umich.edu    col_width = 30
1228120Sgblack@eecs.umich.edu
1238120Sgblack@eecs.umich.edu    help = "  " + ", ".join(args)
1248120Sgblack@eecs.umich.edu    if "help" in kwargs:
1258120Sgblack@eecs.umich.edu        length = len(help)
1268120Sgblack@eecs.umich.edu        if length >= col_width:
1278120Sgblack@eecs.umich.edu            help += "\n" + " " * col_width
1288120Sgblack@eecs.umich.edu        else:
1298120Sgblack@eecs.umich.edu            help += " " * (col_width - length)
1308120Sgblack@eecs.umich.edu        help += kwargs["help"]
1318120Sgblack@eecs.umich.edu    help_texts["options"] += help + "\n"
1328120Sgblack@eecs.umich.edu
1338120Sgblack@eecs.umich.edu    AddOption(*args, **kwargs)
1348120Sgblack@eecs.umich.edu
1358879Ssteve.reinhardt@amd.comAddLocalOption('--colors', dest='use_colors', action='store_true',
1368879Ssteve.reinhardt@amd.com               help="Add color to abbreviated scons output")
1378879Ssteve.reinhardt@amd.comAddLocalOption('--no-colors', dest='use_colors', action='store_false',
1388879Ssteve.reinhardt@amd.com               help="Don't add color to abbreviated scons output")
13910458Sandreas.hansson@arm.comAddLocalOption('--with-cxx-config', dest='with_cxx_config',
14010458Sandreas.hansson@arm.com               action='store_true',
14110458Sandreas.hansson@arm.com               help="Build with support for C++-based configuration")
1428879Ssteve.reinhardt@amd.comAddLocalOption('--default', dest='default', type='string', action='store',
1438879Ssteve.reinhardt@amd.com               help='Override which build_opts file to use for defaults')
1448879Ssteve.reinhardt@amd.comAddLocalOption('--ignore-style', dest='ignore_style', action='store_true',
1458879Ssteve.reinhardt@amd.com               help='Disable style checking hooks')
1469227Sandreas.hansson@arm.comAddLocalOption('--no-lto', dest='no_lto', action='store_true',
1479227Sandreas.hansson@arm.com               help='Disable Link-Time Optimization for fast')
14812063Sgabeblack@google.comAddLocalOption('--force-lto', dest='force_lto', action='store_true',
14912063Sgabeblack@google.com               help='Use Link-Time Optimization instead of partial linking' +
15012063Sgabeblack@google.com                    ' when the compiler doesn\'t support using them together.')
1518879Ssteve.reinhardt@amd.comAddLocalOption('--update-ref', dest='update_ref', action='store_true',
1528879Ssteve.reinhardt@amd.com               help='Update test reference outputs')
1538879Ssteve.reinhardt@amd.comAddLocalOption('--verbose', dest='verbose', action='store_true',
1548879Ssteve.reinhardt@amd.com               help='Print full tool command lines')
15510453SAndrew.Bardsley@arm.comAddLocalOption('--without-python', dest='without_python',
15610453SAndrew.Bardsley@arm.com               action='store_true',
15710453SAndrew.Bardsley@arm.com               help='Build without Python configuration support')
15810456SCurtis.Dunham@arm.comAddLocalOption('--without-tcmalloc', dest='without_tcmalloc',
15910456SCurtis.Dunham@arm.com               action='store_true',
16010456SCurtis.Dunham@arm.com               help='Disable linking against tcmalloc')
16110457Sandreas.hansson@arm.comAddLocalOption('--with-ubsan', dest='with_ubsan', action='store_true',
16210457Sandreas.hansson@arm.com               help='Build with Undefined Behavior Sanitizer if available')
16311342Sandreas.hansson@arm.comAddLocalOption('--with-asan', dest='with_asan', action='store_true',
16411342Sandreas.hansson@arm.com               help='Build with Address Sanitizer if available')
1658120Sgblack@eecs.umich.edu
16612063Sgabeblack@google.comif GetOption('no_lto') and GetOption('force_lto'):
16712063Sgabeblack@google.com    print '--no-lto and --force-lto are mutually exclusive'
16812063Sgabeblack@google.com    Exit(1)
16912063Sgabeblack@google.com
1705871Snate@binkert.org########################################################################
1715871Snate@binkert.org#
1726121Snate@binkert.org# Set up the main build environment.
1735871Snate@binkert.org#
1745871Snate@binkert.org########################################################################
1759926Sstan.czerniawski@arm.com
17612243Sgabeblack@google.commain = Environment()
1771533SN/A
17812246Sgabeblack@google.comfrom gem5_scons import Transform
17912246Sgabeblack@google.comfrom gem5_scons.util import get_termcap
18012246Sgabeblack@google.comtermcap = get_termcap()
18112246Sgabeblack@google.com
1829239Sandreas.hansson@arm.commain_dict_keys = main.Dictionary().keys()
1839239Sandreas.hansson@arm.com
1849239Sandreas.hansson@arm.com# Check that we have a C/C++ compiler
1859239Sandreas.hansson@arm.comif not ('CC' in main_dict_keys and 'CXX' in main_dict_keys):
1869239Sandreas.hansson@arm.com    print "No C++ compiler installed (package g++ on Ubuntu and RedHat)"
1879239Sandreas.hansson@arm.com    Exit(1)
1889239Sandreas.hansson@arm.com
189955SN/A###################################################
190955SN/A#
1912632Sstever@eecs.umich.edu# Figure out which configurations to set up based on the path(s) of
1922632Sstever@eecs.umich.edu# the target(s).
193955SN/A#
194955SN/A###################################################
195955SN/A
196955SN/A# Find default configuration & binary.
1978878Ssteve.reinhardt@amd.comDefault(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug'))
198955SN/A
1992632Sstever@eecs.umich.edu# helper function: find last occurrence of element in list
2002632Sstever@eecs.umich.edudef rfind(l, elt, offs = -1):
2012632Sstever@eecs.umich.edu    for i in range(len(l)+offs, 0, -1):
2022632Sstever@eecs.umich.edu        if l[i] == elt:
2032632Sstever@eecs.umich.edu            return i
2042632Sstever@eecs.umich.edu    raise ValueError, "element not found"
2052632Sstever@eecs.umich.edu
2068268Ssteve.reinhardt@amd.com# Take a list of paths (or SCons Nodes) and return a list with all
2078268Ssteve.reinhardt@amd.com# paths made absolute and ~-expanded.  Paths will be interpreted
2088268Ssteve.reinhardt@amd.com# relative to the launch directory unless a different root is provided
2098268Ssteve.reinhardt@amd.comdef makePathListAbsolute(path_list, root=GetLaunchDir()):
2108268Ssteve.reinhardt@amd.com    return [abspath(joinpath(root, expanduser(str(p))))
2118268Ssteve.reinhardt@amd.com            for p in path_list]
2128268Ssteve.reinhardt@amd.com
2132632Sstever@eecs.umich.edu# Each target must have 'build' in the interior of the path; the
2142632Sstever@eecs.umich.edu# directory below this will determine the build parameters.  For
2152632Sstever@eecs.umich.edu# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
2162632Sstever@eecs.umich.edu# recognize that ALPHA_SE specifies the configuration because it
2178268Ssteve.reinhardt@amd.com# follow 'build' in the build path.
2182632Sstever@eecs.umich.edu
2198268Ssteve.reinhardt@amd.com# The funky assignment to "[:]" is needed to replace the list contents
2208268Ssteve.reinhardt@amd.com# in place rather than reassign the symbol to a new list, which
2218268Ssteve.reinhardt@amd.com# doesn't work (obviously!).
2228268Ssteve.reinhardt@amd.comBUILD_TARGETS[:] = makePathListAbsolute(BUILD_TARGETS)
2233718Sstever@eecs.umich.edu
2242634Sstever@eecs.umich.edu# Generate a list of the unique build roots and configs that the
2252634Sstever@eecs.umich.edu# collected targets reference.
2265863Snate@binkert.orgvariant_paths = []
2272638Sstever@eecs.umich.edubuild_root = None
2288268Ssteve.reinhardt@amd.comfor t in BUILD_TARGETS:
2292632Sstever@eecs.umich.edu    path_dirs = t.split('/')
2302632Sstever@eecs.umich.edu    try:
2312632Sstever@eecs.umich.edu        build_top = rfind(path_dirs, 'build', -2)
2322632Sstever@eecs.umich.edu    except:
2332632Sstever@eecs.umich.edu        print "Error: no non-leaf 'build' dir found on target path", t
2341858SN/A        Exit(1)
2353716Sstever@eecs.umich.edu    this_build_root = joinpath('/',*path_dirs[:build_top+1])
2362638Sstever@eecs.umich.edu    if not build_root:
2372638Sstever@eecs.umich.edu        build_root = this_build_root
2382638Sstever@eecs.umich.edu    else:
2392638Sstever@eecs.umich.edu        if this_build_root != build_root:
2402638Sstever@eecs.umich.edu            print "Error: build targets not under same build root\n"\
2412638Sstever@eecs.umich.edu                  "  %s\n  %s" % (build_root, this_build_root)
2422638Sstever@eecs.umich.edu            Exit(1)
2435863Snate@binkert.org    variant_path = joinpath('/',*path_dirs[:build_top+2])
2445863Snate@binkert.org    if variant_path not in variant_paths:
2455863Snate@binkert.org        variant_paths.append(variant_path)
246955SN/A
2475341Sstever@gmail.com# Make sure build_root exists (might not if this is the first build there)
2485341Sstever@gmail.comif not isdir(build_root):
2495863Snate@binkert.org    mkdir(build_root)
2507756SAli.Saidi@ARM.commain['BUILDROOT'] = build_root
2515341Sstever@gmail.com
2526121Snate@binkert.orgExport('main')
2534494Ssaidi@eecs.umich.edu
2546121Snate@binkert.orgmain.SConsignFile(joinpath(build_root, "sconsign"))
2551105SN/A
2562667Sstever@eecs.umich.edu# Default duplicate option is to use hard links, but this messes up
2572667Sstever@eecs.umich.edu# when you use emacs to edit a file in the target dir, as emacs moves
2582667Sstever@eecs.umich.edu# file to file~ then copies to file, breaking the link.  Symbolic
2592667Sstever@eecs.umich.edu# (soft) links work better.
2606121Snate@binkert.orgmain.SetOption('duplicate', 'soft-copy')
2612667Sstever@eecs.umich.edu
2625341Sstever@gmail.com#
2635863Snate@binkert.org# Set up global sticky variables... these are common to an entire build
2645341Sstever@gmail.com# tree (not specific to a particular build like ALPHA_SE)
2655341Sstever@gmail.com#
2665341Sstever@gmail.com
2678120Sgblack@eecs.umich.eduglobal_vars_file = joinpath(build_root, 'variables.global')
2685341Sstever@gmail.com
2698120Sgblack@eecs.umich.eduglobal_vars = Variables(global_vars_file, args=ARGUMENTS)
2705341Sstever@gmail.com
2718120Sgblack@eecs.umich.eduglobal_vars.AddVariables(
2726121Snate@binkert.org    ('CC', 'C compiler', environ.get('CC', main['CC'])),
2736121Snate@binkert.org    ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])),
2749396Sandreas.hansson@arm.com    ('PROTOC', 'protoc tool', environ.get('PROTOC', 'protoc')),
2755397Ssaidi@eecs.umich.edu    ('BATCH', 'Use batch pool for build and tests', False),
2765397Ssaidi@eecs.umich.edu    ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
2777727SAli.Saidi@ARM.com    ('M5_BUILD_CACHE', 'Cache built objects in this directory', False),
2788268Ssteve.reinhardt@amd.com    ('EXTRAS', 'Add extra directories to the compilation', '')
2796168Snate@binkert.org    )
2805341Sstever@gmail.com
2818120Sgblack@eecs.umich.edu# Update main environment with values from ARGUMENTS & global_vars_file
2828120Sgblack@eecs.umich.eduglobal_vars.Update(main)
2838120Sgblack@eecs.umich.eduhelp_texts["global_vars"] += global_vars.GenerateHelpText(main)
2846814Sgblack@eecs.umich.edu
2855863Snate@binkert.org# Save sticky variable settings back to current variables file
2868120Sgblack@eecs.umich.eduglobal_vars.Save(global_vars_file, main)
2875341Sstever@gmail.com
2885863Snate@binkert.org# Parse EXTRAS variable to build list of all directories where we're
2898268Ssteve.reinhardt@amd.com# look for sources etc.  This list is exported as extras_dir_list.
2906121Snate@binkert.orgbase_dir = main.srcdir.abspath
2916121Snate@binkert.orgif main['EXTRAS']:
2928268Ssteve.reinhardt@amd.com    extras_dir_list = makePathListAbsolute(main['EXTRAS'].split(':'))
2935742Snate@binkert.orgelse:
2945742Snate@binkert.org    extras_dir_list = []
2955341Sstever@gmail.com
2965742Snate@binkert.orgExport('base_dir')
2975742Snate@binkert.orgExport('extras_dir_list')
2985341Sstever@gmail.com
2996017Snate@binkert.org# the ext directory should be on the #includes path
3006121Snate@binkert.orgmain.Append(CPPPATH=[Dir('ext')])
3016017Snate@binkert.org
30212158Sandreas.sandberg@arm.com# Add shared top-level headers
30312158Sandreas.sandberg@arm.commain.Prepend(CPPPATH=Dir('include'))
30412158Sandreas.sandberg@arm.com
3058120Sgblack@eecs.umich.eduif GetOption('verbose'):
3067756SAli.Saidi@ARM.com    def MakeAction(action, string, *args, **kwargs):
3077756SAli.Saidi@ARM.com        return Action(action, *args, **kwargs)
3087756SAli.Saidi@ARM.comelse:
3097756SAli.Saidi@ARM.com    MakeAction = Action
3107816Ssteve.reinhardt@amd.com    main['CCCOMSTR']        = Transform("CC")
3117816Ssteve.reinhardt@amd.com    main['CXXCOMSTR']       = Transform("CXX")
3127816Ssteve.reinhardt@amd.com    main['ASCOMSTR']        = Transform("AS")
3137816Ssteve.reinhardt@amd.com    main['ARCOMSTR']        = Transform("AR", 0)
3147816Ssteve.reinhardt@amd.com    main['LINKCOMSTR']      = Transform("LINK", 0)
31511979Sgabeblack@google.com    main['SHLINKCOMSTR']    = Transform("SHLINK", 0)
3167816Ssteve.reinhardt@amd.com    main['RANLIBCOMSTR']    = Transform("RANLIB", 0)
3177816Ssteve.reinhardt@amd.com    main['M4COMSTR']        = Transform("M4")
3187816Ssteve.reinhardt@amd.com    main['SHCCCOMSTR']      = Transform("SHCC")
3197816Ssteve.reinhardt@amd.com    main['SHCXXCOMSTR']     = Transform("SHCXX")
3207756SAli.Saidi@ARM.comExport('MakeAction')
3217756SAli.Saidi@ARM.com
3229227Sandreas.hansson@arm.com# Initialize the Link-Time Optimization (LTO) flags
3239227Sandreas.hansson@arm.commain['LTO_CCFLAGS'] = []
3249227Sandreas.hansson@arm.commain['LTO_LDFLAGS'] = []
3259227Sandreas.hansson@arm.com
3269590Sandreas@sandberg.pp.se# According to the readme, tcmalloc works best if the compiler doesn't
3279590Sandreas@sandberg.pp.se# assume that we're using the builtin malloc and friends. These flags
3289590Sandreas@sandberg.pp.se# are compiler-specific, so we need to set them after we detect which
3299590Sandreas@sandberg.pp.se# compiler we're using.
3309590Sandreas@sandberg.pp.semain['TCMALLOC_CCFLAGS'] = []
3319590Sandreas@sandberg.pp.se
3326654Snate@binkert.orgCXX_version = readCommand([main['CXX'],'--version'], exception=False)
3336654Snate@binkert.orgCXX_V = readCommand([main['CXX'],'-V'], exception=False)
3345871Snate@binkert.org
3356121Snate@binkert.orgmain['GCC'] = CXX_version and CXX_version.find('g++') >= 0
3368946Sandreas.hansson@arm.commain['CLANG'] = CXX_version and CXX_version.find('clang') >= 0
3379419Sandreas.hansson@arm.comif main['GCC'] + main['CLANG'] > 1:
3383940Ssaidi@eecs.umich.edu    print 'Error: How can we have two at the same time?'
3393918Ssaidi@eecs.umich.edu    Exit(1)
3403918Ssaidi@eecs.umich.edu
3411858SN/A# Set up default C++ compiler flags
3429556Sandreas.hansson@arm.comif main['GCC'] or main['CLANG']:
3439556Sandreas.hansson@arm.com    # As gcc and clang share many flags, do the common parts here
3449556Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-pipe'])
3459556Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-fno-strict-aliasing'])
34611294Sandreas.hansson@arm.com    # Enable -Wall and -Wextra and then disable the few warnings that
34711294Sandreas.hansson@arm.com    # we consistently violate
34811294Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-Wall', '-Wundef', '-Wextra',
34911294Sandreas.hansson@arm.com                         '-Wno-sign-compare', '-Wno-unused-parameter'])
35010878Sandreas.hansson@arm.com    # We always compile using C++11
35110878Sandreas.hansson@arm.com    main.Append(CXXFLAGS=['-std=c++11'])
35211811Sbaz21@cam.ac.uk    if sys.platform.startswith('freebsd'):
35311811Sbaz21@cam.ac.uk        main.Append(CCFLAGS=['-I/usr/local/include'])
35411811Sbaz21@cam.ac.uk        main.Append(CXXFLAGS=['-I/usr/local/include'])
35511982Sgabeblack@google.com
35611982Sgabeblack@google.com    main['FILTER_PSHLINKFLAGS'] = lambda x: str(x).replace(' -shared', '')
35711982Sgabeblack@google.com    main['PSHLINKFLAGS'] = main.subst('${FILTER_PSHLINKFLAGS(SHLINKFLAGS)}')
35811982Sgabeblack@google.com    main['PLINKFLAGS'] = main.subst('${LINKFLAGS}')
35911992Sgabeblack@google.com    shared_partial_flags = ['-r', '-nostdlib']
36011982Sgabeblack@google.com    main.Append(PSHLINKFLAGS=shared_partial_flags)
36111982Sgabeblack@google.com    main.Append(PLINKFLAGS=shared_partial_flags)
36212305Sgabeblack@google.com
36312305Sgabeblack@google.com    # Treat warnings as errors but white list some warnings that we
36412305Sgabeblack@google.com    # want to allow (e.g., deprecation warnings).
36512305Sgabeblack@google.com    main.Append(CCFLAGS=['-Werror',
36612305Sgabeblack@google.com                         '-Wno-error=deprecated-declarations',
36712305Sgabeblack@google.com                         '-Wno-error=deprecated',
36812305Sgabeblack@google.com                        ])
3699556Sandreas.hansson@arm.comelse:
3709556Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal,
3719556Sandreas.hansson@arm.com    print "Don't know what compiler options to use for your compiler."
3729556Sandreas.hansson@arm.com    print termcap.Yellow + '       compiler:' + termcap.Normal, main['CXX']
3739556Sandreas.hansson@arm.com    print termcap.Yellow + '       version:' + termcap.Normal,
3749556Sandreas.hansson@arm.com    if not CXX_version:
3759556Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\
3769556Sandreas.hansson@arm.com               termcap.Normal
3779556Sandreas.hansson@arm.com    else:
3789556Sandreas.hansson@arm.com        print CXX_version.replace('\n', '<nl>')
3799556Sandreas.hansson@arm.com    print "       If you're trying to use a compiler other than GCC"
3809556Sandreas.hansson@arm.com    print "       or clang, there appears to be something wrong with your"
3819556Sandreas.hansson@arm.com    print "       environment."
3829556Sandreas.hansson@arm.com    print "       "
3839556Sandreas.hansson@arm.com    print "       If you are trying to use a compiler other than those listed"
3849556Sandreas.hansson@arm.com    print "       above you will need to ease fix SConstruct and "
3859556Sandreas.hansson@arm.com    print "       src/SConscript to support that compiler."
3869556Sandreas.hansson@arm.com    Exit(1)
3879556Sandreas.hansson@arm.com
3886121Snate@binkert.orgif main['GCC']:
38911500Sandreas.hansson@arm.com    # Check for a supported version of gcc. >= 4.8 is chosen for its
39010238Sandreas.hansson@arm.com    # level of c++11 support. See
39110878Sandreas.hansson@arm.com    # http://gcc.gnu.org/projects/cxx0x.html for details.
3929420Sandreas.hansson@arm.com    gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False)
39311500Sandreas.hansson@arm.com    if compareVersions(gcc_version, "4.8") < 0:
39411500Sandreas.hansson@arm.com        print 'Error: gcc version 4.8 or newer required.'
3959420Sandreas.hansson@arm.com        print '       Installed version:', gcc_version
3969420Sandreas.hansson@arm.com        Exit(1)
3979420Sandreas.hansson@arm.com
3989420Sandreas.hansson@arm.com    main['GCC_VERSION'] = gcc_version
3999420Sandreas.hansson@arm.com
40012063Sgabeblack@google.com    if compareVersions(gcc_version, '4.9') >= 0:
40112063Sgabeblack@google.com        # Incremental linking with LTO is currently broken in gcc versions
40212063Sgabeblack@google.com        # 4.9 and above. A version where everything works completely hasn't
40312063Sgabeblack@google.com        # yet been identified.
40412063Sgabeblack@google.com        #
40512063Sgabeblack@google.com        # https://gcc.gnu.org/bugzilla/show_bug.cgi?id=67548
40612063Sgabeblack@google.com        main['BROKEN_INCREMENTAL_LTO'] = True
40712063Sgabeblack@google.com    if compareVersions(gcc_version, '6.0') >= 0:
40812063Sgabeblack@google.com        # gcc versions 6.0 and greater accept an -flinker-output flag which
40912063Sgabeblack@google.com        # selects what type of output the linker should generate. This is
41012063Sgabeblack@google.com        # necessary for incremental lto to work, but is also broken in
41112063Sgabeblack@google.com        # current versions of gcc. It may not be necessary in future
41212063Sgabeblack@google.com        # versions. We add it here since it might be, and as a reminder that
41312063Sgabeblack@google.com        # it exists. It's excluded if lto is being forced.
41412063Sgabeblack@google.com        #
41512063Sgabeblack@google.com        # https://gcc.gnu.org/gcc-6/changes.html
41612063Sgabeblack@google.com        # https://gcc.gnu.org/ml/gcc-patches/2015-11/msg03161.html
41712063Sgabeblack@google.com        # https://gcc.gnu.org/bugzilla/show_bug.cgi?id=69866
41812063Sgabeblack@google.com        if not GetOption('force_lto'):
41912063Sgabeblack@google.com            main.Append(PSHLINKFLAGS='-flinker-output=rel')
42012063Sgabeblack@google.com            main.Append(PLINKFLAGS='-flinker-output=rel')
42112063Sgabeblack@google.com
42210264Sandreas.hansson@arm.com    # gcc from version 4.8 and above generates "rep; ret" instructions
42310264Sandreas.hansson@arm.com    # to avoid performance penalties on certain AMD chips. Older
42410264Sandreas.hansson@arm.com    # assemblers detect this as an error, "Error: expecting string
42510264Sandreas.hansson@arm.com    # instruction after `rep'"
42611925Sgabeblack@google.com    as_version_raw = readCommand([main['AS'], '-v', '/dev/null',
42711925Sgabeblack@google.com                                  '-o', '/dev/null'],
42811500Sandreas.hansson@arm.com                                 exception=False).split()
42910264Sandreas.hansson@arm.com
43011500Sandreas.hansson@arm.com    # version strings may contain extra distro-specific
43111500Sandreas.hansson@arm.com    # qualifiers, so play it safe and keep only what comes before
43211500Sandreas.hansson@arm.com    # the first hyphen
43311500Sandreas.hansson@arm.com    as_version = as_version_raw[-1].split('-')[0] if as_version_raw else None
43410866Sandreas.hansson@arm.com
43511500Sandreas.hansson@arm.com    if not as_version or compareVersions(as_version, "2.23") < 0:
43611500Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + \
43711500Sandreas.hansson@arm.com            'Warning: This combination of gcc and binutils have' + \
43811500Sandreas.hansson@arm.com            ' known incompatibilities.\n' + \
43911500Sandreas.hansson@arm.com            '         If you encounter build problems, please update ' + \
44011500Sandreas.hansson@arm.com            'binutils to 2.23.' + \
44111500Sandreas.hansson@arm.com            termcap.Normal
44210264Sandreas.hansson@arm.com
44310457Sandreas.hansson@arm.com    # Make sure we warn if the user has requested to compile with the
44410457Sandreas.hansson@arm.com    # Undefined Benahvior Sanitizer and this version of gcc does not
44510457Sandreas.hansson@arm.com    # support it.
44610457Sandreas.hansson@arm.com    if GetOption('with_ubsan') and \
44710457Sandreas.hansson@arm.com            compareVersions(gcc_version, '4.9') < 0:
44810457Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + \
44910457Sandreas.hansson@arm.com            'Warning: UBSan is only supported using gcc 4.9 and later.' + \
45010457Sandreas.hansson@arm.com            termcap.Normal
45110457Sandreas.hansson@arm.com
45212063Sgabeblack@google.com    disable_lto = GetOption('no_lto')
45312063Sgabeblack@google.com    if not disable_lto and main.get('BROKEN_INCREMENTAL_LTO', False) and \
45412063Sgabeblack@google.com            not GetOption('force_lto'):
45512063Sgabeblack@google.com        print termcap.Yellow + termcap.Bold + \
45612063Sgabeblack@google.com            'Warning: Your compiler doesn\'t support incremental linking' + \
45712063Sgabeblack@google.com            ' and lto at the same time, so lto is being disabled. To force' + \
45812063Sgabeblack@google.com            ' lto on anyway, use the --force-lto option. That will disable' + \
45912063Sgabeblack@google.com            ' partial linking.' + \
46012063Sgabeblack@google.com            termcap.Normal
46112063Sgabeblack@google.com        disable_lto = True
46212063Sgabeblack@google.com
46310238Sandreas.hansson@arm.com    # Add the appropriate Link-Time Optimization (LTO) flags
46410238Sandreas.hansson@arm.com    # unless LTO is explicitly turned off. Note that these flags
46510238Sandreas.hansson@arm.com    # are only used by the fast target.
46612063Sgabeblack@google.com    if not disable_lto:
46710238Sandreas.hansson@arm.com        # Pass the LTO flag when compiling to produce GIMPLE
46810238Sandreas.hansson@arm.com        # output, we merely create the flags here and only append
46910416Sandreas.hansson@arm.com        # them later
47010238Sandreas.hansson@arm.com        main['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
4719227Sandreas.hansson@arm.com
47210238Sandreas.hansson@arm.com        # Use the same amount of jobs for LTO as we are running
47310416Sandreas.hansson@arm.com        # scons with
47410416Sandreas.hansson@arm.com        main['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
4759227Sandreas.hansson@arm.com
4769590Sandreas@sandberg.pp.se    main.Append(TCMALLOC_CCFLAGS=['-fno-builtin-malloc', '-fno-builtin-calloc',
4779590Sandreas@sandberg.pp.se                                  '-fno-builtin-realloc', '-fno-builtin-free'])
4789590Sandreas@sandberg.pp.se
47911497SMatteo.Andreozzi@arm.com    # add option to check for undeclared overrides
48011497SMatteo.Andreozzi@arm.com    if compareVersions(gcc_version, "5.0") > 0:
48111497SMatteo.Andreozzi@arm.com        main.Append(CCFLAGS=['-Wno-error=suggest-override'])
48211497SMatteo.Andreozzi@arm.com
48312304Sgabeblack@google.com    # The address sanitizer is available for gcc >= 4.8
48412304Sgabeblack@google.com    if GetOption('with_asan'):
48512304Sgabeblack@google.com        if GetOption('with_ubsan') and \
48612304Sgabeblack@google.com                compareVersions(env['GCC_VERSION'], '4.9') >= 0:
48712304Sgabeblack@google.com            env.Append(CCFLAGS=['-fsanitize=address,undefined',
48812304Sgabeblack@google.com                                '-fno-omit-frame-pointer'],
48912304Sgabeblack@google.com                       LINKFLAGS='-fsanitize=address,undefined')
49012304Sgabeblack@google.com        else:
49112304Sgabeblack@google.com            env.Append(CCFLAGS=['-fsanitize=address',
49212304Sgabeblack@google.com                                '-fno-omit-frame-pointer'],
49312304Sgabeblack@google.com                       LINKFLAGS='-fsanitize=address')
49412304Sgabeblack@google.com    # Only gcc >= 4.9 supports UBSan, so check both the version
49512304Sgabeblack@google.com    # and the command-line option before adding the compiler and
49612304Sgabeblack@google.com    # linker flags.
49712304Sgabeblack@google.com    elif GetOption('with_ubsan') and \
49812304Sgabeblack@google.com            compareVersions(env['GCC_VERSION'], '4.9') >= 0:
49912304Sgabeblack@google.com        env.Append(CCFLAGS='-fsanitize=undefined')
50012304Sgabeblack@google.com        env.Append(LINKFLAGS='-fsanitize=undefined')
50112304Sgabeblack@google.com
5028737Skoansin.tan@gmail.comelif main['CLANG']:
50310878Sandreas.hansson@arm.com    # Check for a supported version of clang, >= 3.1 is needed to
50411500Sandreas.hansson@arm.com    # support similar features as gcc 4.8. See
5059420Sandreas.hansson@arm.com    # http://clang.llvm.org/cxx_status.html for details
5068737Skoansin.tan@gmail.com    clang_version_re = re.compile(".* version (\d+\.\d+)")
50710106SMitch.Hayenga@arm.com    clang_version_match = clang_version_re.search(CXX_version)
5088737Skoansin.tan@gmail.com    if (clang_version_match):
5098737Skoansin.tan@gmail.com        clang_version = clang_version_match.groups()[0]
51010878Sandreas.hansson@arm.com        if compareVersions(clang_version, "3.1") < 0:
51110878Sandreas.hansson@arm.com            print 'Error: clang version 3.1 or newer required.'
5128737Skoansin.tan@gmail.com            print '       Installed version:', clang_version
5138737Skoansin.tan@gmail.com            Exit(1)
5148737Skoansin.tan@gmail.com    else:
5158737Skoansin.tan@gmail.com        print 'Error: Unable to determine clang version.'
5168737Skoansin.tan@gmail.com        Exit(1)
5178737Skoansin.tan@gmail.com
51811294Sandreas.hansson@arm.com    # clang has a few additional warnings that we disable, extraneous
5199556Sandreas.hansson@arm.com    # parantheses are allowed due to Ruby's printing of the AST,
5209556Sandreas.hansson@arm.com    # finally self assignments are allowed as the generated CPU code
5219556Sandreas.hansson@arm.com    # is relying on this
52211294Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-Wno-parentheses',
52310278SAndreas.Sandberg@ARM.com                         '-Wno-self-assign',
52410278SAndreas.Sandberg@ARM.com                         # Some versions of libstdc++ (4.8?) seem to
52510278SAndreas.Sandberg@ARM.com                         # use struct hash and class hash
52610278SAndreas.Sandberg@ARM.com                         # interchangeably.
52710278SAndreas.Sandberg@ARM.com                         '-Wno-mismatched-tags',
52810278SAndreas.Sandberg@ARM.com                         ])
5299556Sandreas.hansson@arm.com
5309590Sandreas@sandberg.pp.se    main.Append(TCMALLOC_CCFLAGS=['-fno-builtin'])
5319590Sandreas@sandberg.pp.se
5329420Sandreas.hansson@arm.com    # On Mac OS X/Darwin we need to also use libc++ (part of XCode) as
5339846Sandreas.hansson@arm.com    # opposed to libstdc++, as the later is dated.
5349846Sandreas.hansson@arm.com    if sys.platform == "darwin":
5359846Sandreas.hansson@arm.com        main.Append(CXXFLAGS=['-stdlib=libc++'])
5369846Sandreas.hansson@arm.com        main.Append(LIBS=['c++'])
5378946Sandreas.hansson@arm.com
53811811Sbaz21@cam.ac.uk    # On FreeBSD we need libthr.
53911811Sbaz21@cam.ac.uk    if sys.platform.startswith('freebsd'):
54011811Sbaz21@cam.ac.uk        main.Append(LIBS=['thr'])
54111811Sbaz21@cam.ac.uk
54212304Sgabeblack@google.com    # We require clang >= 3.1, so there is no need to check any
54312304Sgabeblack@google.com    # versions here.
54412304Sgabeblack@google.com    if GetOption('with_ubsan'):
54512304Sgabeblack@google.com        if GetOption('with_asan'):
54612304Sgabeblack@google.com            env.Append(CCFLAGS=['-fsanitize=address,undefined',
54712304Sgabeblack@google.com                                '-fno-omit-frame-pointer'],
54812304Sgabeblack@google.com                       LINKFLAGS='-fsanitize=address,undefined')
54912304Sgabeblack@google.com        else:
55012304Sgabeblack@google.com            env.Append(CCFLAGS='-fsanitize=undefined',
55112304Sgabeblack@google.com                       LINKFLAGS='-fsanitize=undefined')
55212304Sgabeblack@google.com
55312304Sgabeblack@google.com    elif GetOption('with_asan'):
55412304Sgabeblack@google.com        env.Append(CCFLAGS=['-fsanitize=address',
55512304Sgabeblack@google.com                            '-fno-omit-frame-pointer'],
55612304Sgabeblack@google.com                   LINKFLAGS='-fsanitize=address')
55712304Sgabeblack@google.com
5583918Ssaidi@eecs.umich.eduelse:
5599068SAli.Saidi@ARM.com    print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal,
5609068SAli.Saidi@ARM.com    print "Don't know what compiler options to use for your compiler."
5619068SAli.Saidi@ARM.com    print termcap.Yellow + '       compiler:' + termcap.Normal, main['CXX']
5629068SAli.Saidi@ARM.com    print termcap.Yellow + '       version:' + termcap.Normal,
5639068SAli.Saidi@ARM.com    if not CXX_version:
5649068SAli.Saidi@ARM.com        print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\
5659068SAli.Saidi@ARM.com               termcap.Normal
5669068SAli.Saidi@ARM.com    else:
5679068SAli.Saidi@ARM.com        print CXX_version.replace('\n', '<nl>')
5689419Sandreas.hansson@arm.com    print "       If you're trying to use a compiler other than GCC"
5699068SAli.Saidi@ARM.com    print "       or clang, there appears to be something wrong with your"
5709068SAli.Saidi@ARM.com    print "       environment."
5719068SAli.Saidi@ARM.com    print "       "
5729068SAli.Saidi@ARM.com    print "       If you are trying to use a compiler other than those listed"
5739068SAli.Saidi@ARM.com    print "       above you will need to ease fix SConstruct and "
5749068SAli.Saidi@ARM.com    print "       src/SConscript to support that compiler."
5753918Ssaidi@eecs.umich.edu    Exit(1)
5763918Ssaidi@eecs.umich.edu
5776157Snate@binkert.org# Set up common yacc/bison flags (needed for Ruby)
5786157Snate@binkert.orgmain['YACCFLAGS'] = '-d'
5796157Snate@binkert.orgmain['YACCHXXFILESUFFIX'] = '.hh'
5806157Snate@binkert.org
5815397Ssaidi@eecs.umich.edu# Do this after we save setting back, or else we'll tack on an
5825397Ssaidi@eecs.umich.edu# extra 'qdo' every time we run scons.
5836121Snate@binkert.orgif main['BATCH']:
5846121Snate@binkert.org    main['CC']     = main['BATCH_CMD'] + ' ' + main['CC']
5856121Snate@binkert.org    main['CXX']    = main['BATCH_CMD'] + ' ' + main['CXX']
5866121Snate@binkert.org    main['AS']     = main['BATCH_CMD'] + ' ' + main['AS']
5876121Snate@binkert.org    main['AR']     = main['BATCH_CMD'] + ' ' + main['AR']
5886121Snate@binkert.org    main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB']
5895397Ssaidi@eecs.umich.edu
5901851SN/Aif sys.platform == 'cygwin':
5911851SN/A    # cygwin has some header file issues...
5927739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=["-Wno-uninitialized"])
593955SN/A
5949396Sandreas.hansson@arm.com# Check for the protobuf compiler
5959396Sandreas.hansson@arm.comprotoc_version = readCommand([main['PROTOC'], '--version'],
5969396Sandreas.hansson@arm.com                             exception='').split()
5979396Sandreas.hansson@arm.com
5989396Sandreas.hansson@arm.com# First two words should be "libprotoc x.y.z"
5999396Sandreas.hansson@arm.comif len(protoc_version) < 2 or protoc_version[0] != 'libprotoc':
6009396Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + \
6019396Sandreas.hansson@arm.com        'Warning: Protocol buffer compiler (protoc) not found.\n' + \
6029396Sandreas.hansson@arm.com        '         Please install protobuf-compiler for tracing support.' + \
6039396Sandreas.hansson@arm.com        termcap.Normal
6049396Sandreas.hansson@arm.com    main['PROTOC'] = False
6059396Sandreas.hansson@arm.comelse:
6069396Sandreas.hansson@arm.com    # Based on the availability of the compress stream wrappers,
6079396Sandreas.hansson@arm.com    # require 2.1.0
6089396Sandreas.hansson@arm.com    min_protoc_version = '2.1.0'
6099396Sandreas.hansson@arm.com    if compareVersions(protoc_version[1], min_protoc_version) < 0:
6109477Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + \
6119477Sandreas.hansson@arm.com            'Warning: protoc version', min_protoc_version, \
6129477Sandreas.hansson@arm.com            'or newer required.\n' + \
6139477Sandreas.hansson@arm.com            '         Installed version:', protoc_version[1], \
6149477Sandreas.hansson@arm.com            termcap.Normal
6159477Sandreas.hansson@arm.com        main['PROTOC'] = False
6169477Sandreas.hansson@arm.com    else:
6179477Sandreas.hansson@arm.com        # Attempt to determine the appropriate include path and
6189477Sandreas.hansson@arm.com        # library path using pkg-config, that means we also need to
6199477Sandreas.hansson@arm.com        # check for pkg-config. Note that it is possible to use
6209477Sandreas.hansson@arm.com        # protobuf without the involvement of pkg-config. Later on we
6219477Sandreas.hansson@arm.com        # check go a library config check and at that point the test
6229477Sandreas.hansson@arm.com        # will fail if libprotobuf cannot be found.
6239477Sandreas.hansson@arm.com        if readCommand(['pkg-config', '--version'], exception=''):
6249477Sandreas.hansson@arm.com            try:
6259477Sandreas.hansson@arm.com                # Attempt to establish what linking flags to add for protobuf
6269477Sandreas.hansson@arm.com                # using pkg-config
6279477Sandreas.hansson@arm.com                main.ParseConfig('pkg-config --cflags --libs-only-L protobuf')
6289477Sandreas.hansson@arm.com            except:
6299477Sandreas.hansson@arm.com                print termcap.Yellow + termcap.Bold + \
6309477Sandreas.hansson@arm.com                    'Warning: pkg-config could not get protobuf flags.' + \
6319477Sandreas.hansson@arm.com                    termcap.Normal
6329396Sandreas.hansson@arm.com
6332667Sstever@eecs.umich.edu
63410710Sandreas.hansson@arm.com# Check for 'timeout' from GNU coreutils. If present, regressions will
63510710Sandreas.hansson@arm.com# be run with a time limit. We require version 8.13 since we rely on
63610710Sandreas.hansson@arm.com# support for the '--foreground' option.
63711811Sbaz21@cam.ac.ukif sys.platform.startswith('freebsd'):
63811811Sbaz21@cam.ac.uk    timeout_lines = readCommand(['gtimeout', '--version'],
63911811Sbaz21@cam.ac.uk                                exception='').splitlines()
64011811Sbaz21@cam.ac.ukelse:
64111811Sbaz21@cam.ac.uk    timeout_lines = readCommand(['timeout', '--version'],
64211811Sbaz21@cam.ac.uk                                exception='').splitlines()
64310710Sandreas.hansson@arm.com# Get the first line and tokenize it
64410710Sandreas.hansson@arm.comtimeout_version = timeout_lines[0].split() if timeout_lines else []
64510710Sandreas.hansson@arm.commain['TIMEOUT'] =  timeout_version and \
64610710Sandreas.hansson@arm.com    compareVersions(timeout_version[-1], '8.13') >= 0
64710384SCurtis.Dunham@arm.com
6489986Sandreas@sandberg.pp.se# Add a custom Check function to test for structure members.
6499986Sandreas@sandberg.pp.sedef CheckMember(context, include, decl, member, include_quotes="<>"):
6509986Sandreas@sandberg.pp.se    context.Message("Checking for member %s in %s..." %
6519986Sandreas@sandberg.pp.se                    (member, decl))
6529986Sandreas@sandberg.pp.se    text = """
6539986Sandreas@sandberg.pp.se#include %(header)s
6549986Sandreas@sandberg.pp.seint main(){
6559986Sandreas@sandberg.pp.se  %(decl)s test;
6569986Sandreas@sandberg.pp.se  (void)test.%(member)s;
6579986Sandreas@sandberg.pp.se  return 0;
6589986Sandreas@sandberg.pp.se};
6599986Sandreas@sandberg.pp.se""" % { "header" : include_quotes[0] + include + include_quotes[1],
6609986Sandreas@sandberg.pp.se        "decl" : decl,
6619986Sandreas@sandberg.pp.se        "member" : member,
6629986Sandreas@sandberg.pp.se        }
6639986Sandreas@sandberg.pp.se
6649986Sandreas@sandberg.pp.se    ret = context.TryCompile(text, extension=".cc")
6659986Sandreas@sandberg.pp.se    context.Result(ret)
6669986Sandreas@sandberg.pp.se    return ret
6679986Sandreas@sandberg.pp.se
6682638Sstever@eecs.umich.edu# Platform-specific configuration.  Note again that we assume that all
6692638Sstever@eecs.umich.edu# builds under a given build root run on the same host platform.
6706121Snate@binkert.orgconf = Configure(main,
6713716Sstever@eecs.umich.edu                 conf_dir = joinpath(build_root, '.scons_config'),
6725522Snate@binkert.org                 log_file = joinpath(build_root, 'scons_config.log'),
6739986Sandreas@sandberg.pp.se                 custom_tests = {
6749986Sandreas@sandberg.pp.se        'CheckMember' : CheckMember,
6759986Sandreas@sandberg.pp.se        })
6765522Snate@binkert.org
6775227Ssaidi@eecs.umich.edu# Check if we should compile a 64 bit binary on Mac OS X/Darwin
6785227Ssaidi@eecs.umich.edutry:
6795227Ssaidi@eecs.umich.edu    import platform
6805227Ssaidi@eecs.umich.edu    uname = platform.uname()
6816654Snate@binkert.org    if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0:
6826654Snate@binkert.org        if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
6837769SAli.Saidi@ARM.com            main.Append(CCFLAGS=['-arch', 'x86_64'])
6847769SAli.Saidi@ARM.com            main.Append(CFLAGS=['-arch', 'x86_64'])
6857769SAli.Saidi@ARM.com            main.Append(LINKFLAGS=['-arch', 'x86_64'])
6867769SAli.Saidi@ARM.com            main.Append(ASFLAGS=['-arch', 'x86_64'])
6875227Ssaidi@eecs.umich.eduexcept:
6885227Ssaidi@eecs.umich.edu    pass
6895227Ssaidi@eecs.umich.edu
6905204Sstever@gmail.com# Recent versions of scons substitute a "Null" object for Configure()
6915204Sstever@gmail.com# when configuration isn't necessary, e.g., if the "--help" option is
6925204Sstever@gmail.com# present.  Unfortuantely this Null object always returns false,
6935204Sstever@gmail.com# breaking all our configuration checks.  We replace it with our own
6945204Sstever@gmail.com# more optimistic null object that returns True instead.
6955204Sstever@gmail.comif not conf:
6965204Sstever@gmail.com    def NullCheck(*args, **kwargs):
6975204Sstever@gmail.com        return True
6985204Sstever@gmail.com
6995204Sstever@gmail.com    class NullConf:
7005204Sstever@gmail.com        def __init__(self, env):
7015204Sstever@gmail.com            self.env = env
7025204Sstever@gmail.com        def Finish(self):
7035204Sstever@gmail.com            return self.env
7045204Sstever@gmail.com        def __getattr__(self, mname):
7055204Sstever@gmail.com            return NullCheck
7065204Sstever@gmail.com
7076121Snate@binkert.org    conf = NullConf(main)
7085204Sstever@gmail.com
7097727SAli.Saidi@ARM.com# Cache build files in the supplied directory.
7107727SAli.Saidi@ARM.comif main['M5_BUILD_CACHE']:
7117727SAli.Saidi@ARM.com    print 'Using build cache located at', main['M5_BUILD_CACHE']
7127727SAli.Saidi@ARM.com    CacheDir(main['M5_BUILD_CACHE'])
7137727SAli.Saidi@ARM.com
71411988Sandreas.sandberg@arm.commain['USE_PYTHON'] = not GetOption('without_python')
71511988Sandreas.sandberg@arm.comif main['USE_PYTHON']:
71610453SAndrew.Bardsley@arm.com    # Find Python include and library directories for embedding the
71710453SAndrew.Bardsley@arm.com    # interpreter. We rely on python-config to resolve the appropriate
71810453SAndrew.Bardsley@arm.com    # includes and linker flags. ParseConfig does not seem to understand
71910453SAndrew.Bardsley@arm.com    # the more exotic linker flags such as -Xlinker and -export-dynamic so
72010453SAndrew.Bardsley@arm.com    # we add them explicitly below. If you want to link in an alternate
72110453SAndrew.Bardsley@arm.com    # version of python, see above for instructions on how to invoke
72210453SAndrew.Bardsley@arm.com    # scons with the appropriate PATH set.
72310453SAndrew.Bardsley@arm.com    #
72410453SAndrew.Bardsley@arm.com    # First we check if python2-config exists, else we use python-config
72510453SAndrew.Bardsley@arm.com    python_config = readCommand(['which', 'python2-config'],
72610160Sandreas.hansson@arm.com                                exception='').strip()
72710453SAndrew.Bardsley@arm.com    if not os.path.exists(python_config):
72810453SAndrew.Bardsley@arm.com        python_config = readCommand(['which', 'python-config'],
72910453SAndrew.Bardsley@arm.com                                    exception='').strip()
73010453SAndrew.Bardsley@arm.com    py_includes = readCommand([python_config, '--includes'],
73110453SAndrew.Bardsley@arm.com                              exception='').split()
73210453SAndrew.Bardsley@arm.com    # Strip the -I from the include folders before adding them to the
73310453SAndrew.Bardsley@arm.com    # CPPPATH
73410453SAndrew.Bardsley@arm.com    main.Append(CPPPATH=map(lambda inc: inc[2:], py_includes))
7359812Sandreas.hansson@arm.com
73610453SAndrew.Bardsley@arm.com    # Read the linker flags and split them into libraries and other link
73710453SAndrew.Bardsley@arm.com    # flags. The libraries are added later through the call the CheckLib.
73810453SAndrew.Bardsley@arm.com    py_ld_flags = readCommand([python_config, '--ldflags'],
73910453SAndrew.Bardsley@arm.com        exception='').split()
74010453SAndrew.Bardsley@arm.com    py_libs = []
74110453SAndrew.Bardsley@arm.com    for lib in py_ld_flags:
74210453SAndrew.Bardsley@arm.com         if not lib.startswith('-l'):
74310453SAndrew.Bardsley@arm.com             main.Append(LINKFLAGS=[lib])
74410453SAndrew.Bardsley@arm.com         else:
74510453SAndrew.Bardsley@arm.com             lib = lib[2:]
74610453SAndrew.Bardsley@arm.com             if lib not in py_libs:
74710453SAndrew.Bardsley@arm.com                 py_libs.append(lib)
7487727SAli.Saidi@ARM.com
74910453SAndrew.Bardsley@arm.com    # verify that this stuff works
75010453SAndrew.Bardsley@arm.com    if not conf.CheckHeader('Python.h', '<>'):
75110453SAndrew.Bardsley@arm.com        print "Error: can't find Python.h header in", py_includes
75210453SAndrew.Bardsley@arm.com        print "Install Python headers (package python-dev on Ubuntu and RedHat)"
75310453SAndrew.Bardsley@arm.com        Exit(1)
7543118Sstever@eecs.umich.edu
75510453SAndrew.Bardsley@arm.com    for lib in py_libs:
75610453SAndrew.Bardsley@arm.com        if not conf.CheckLib(lib):
75710453SAndrew.Bardsley@arm.com            print "Error: can't find library %s required by python" % lib
75810453SAndrew.Bardsley@arm.com            Exit(1)
7593118Sstever@eecs.umich.edu
7603483Ssaidi@eecs.umich.edu# On Solaris you need to use libsocket for socket ops
7613494Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
7623494Ssaidi@eecs.umich.edu   if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
7633483Ssaidi@eecs.umich.edu       print "Can't find library with socket calls (e.g. accept())"
7643483Ssaidi@eecs.umich.edu       Exit(1)
7653483Ssaidi@eecs.umich.edu
7663053Sstever@eecs.umich.edu# Check for zlib.  If the check passes, libz will be automatically
7673053Sstever@eecs.umich.edu# added to the LIBS environment variable.
7683918Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
7693053Sstever@eecs.umich.edu    print 'Error: did not find needed zlib compression library '\
7703053Sstever@eecs.umich.edu          'and/or zlib.h header file.'
7713053Sstever@eecs.umich.edu    print '       Please install zlib and try again.'
7723053Sstever@eecs.umich.edu    Exit(1)
7733053Sstever@eecs.umich.edu
7749396Sandreas.hansson@arm.com# If we have the protobuf compiler, also make sure we have the
7759396Sandreas.hansson@arm.com# development libraries. If the check passes, libprotobuf will be
7769396Sandreas.hansson@arm.com# automatically added to the LIBS environment variable. After
7779396Sandreas.hansson@arm.com# this, we can use the HAVE_PROTOBUF flag to determine if we have
7789396Sandreas.hansson@arm.com# got both protoc and libprotobuf available.
7799396Sandreas.hansson@arm.commain['HAVE_PROTOBUF'] = main['PROTOC'] and \
7809396Sandreas.hansson@arm.com    conf.CheckLibWithHeader('protobuf', 'google/protobuf/message.h',
7819396Sandreas.hansson@arm.com                            'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;')
7829396Sandreas.hansson@arm.com
7839477Sandreas.hansson@arm.com# If we have the compiler but not the library, print another warning.
7849396Sandreas.hansson@arm.comif main['PROTOC'] and not main['HAVE_PROTOBUF']:
7859477Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + \
7869477Sandreas.hansson@arm.com        'Warning: did not find protocol buffer library and/or headers.\n' + \
7879477Sandreas.hansson@arm.com    '       Please install libprotobuf-dev for tracing support.' + \
7889477Sandreas.hansson@arm.com    termcap.Normal
7899396Sandreas.hansson@arm.com
7907840Snate@binkert.org# Check for librt.
7917865Sgblack@eecs.umich.eduhave_posix_clock = \
7927865Sgblack@eecs.umich.edu    conf.CheckLibWithHeader(None, 'time.h', 'C',
7937865Sgblack@eecs.umich.edu                            'clock_nanosleep(0,0,NULL,NULL);') or \
7947865Sgblack@eecs.umich.edu    conf.CheckLibWithHeader('rt', 'time.h', 'C',
7957865Sgblack@eecs.umich.edu                            'clock_nanosleep(0,0,NULL,NULL);')
7967840Snate@binkert.org
7979900Sandreas@sandberg.pp.sehave_posix_timers = \
7989900Sandreas@sandberg.pp.se    conf.CheckLibWithHeader([None, 'rt'], [ 'time.h', 'signal.h' ], 'C',
7999900Sandreas@sandberg.pp.se                            'timer_create(CLOCK_MONOTONIC, NULL, NULL);')
8009900Sandreas@sandberg.pp.se
80110456SCurtis.Dunham@arm.comif not GetOption('without_tcmalloc'):
80210456SCurtis.Dunham@arm.com    if conf.CheckLib('tcmalloc'):
80310456SCurtis.Dunham@arm.com        main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS'])
80410456SCurtis.Dunham@arm.com    elif conf.CheckLib('tcmalloc_minimal'):
80510456SCurtis.Dunham@arm.com        main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS'])
80610456SCurtis.Dunham@arm.com    else:
80710456SCurtis.Dunham@arm.com        print termcap.Yellow + termcap.Bold + \
80810456SCurtis.Dunham@arm.com              "You can get a 12% performance improvement by "\
80910456SCurtis.Dunham@arm.com              "installing tcmalloc (libgoogle-perftools-dev package "\
81010456SCurtis.Dunham@arm.com              "on Ubuntu or RedHat)." + termcap.Normal
8119045SAli.Saidi@ARM.com
81211235Sandreas.sandberg@arm.com
81311235Sandreas.sandberg@arm.com# Detect back trace implementations. The last implementation in the
81411235Sandreas.sandberg@arm.com# list will be used by default.
81511235Sandreas.sandberg@arm.combacktrace_impls = [ "none" ]
81611235Sandreas.sandberg@arm.com
81711235Sandreas.sandberg@arm.comif conf.CheckLibWithHeader(None, 'execinfo.h', 'C',
81811235Sandreas.sandberg@arm.com                           'backtrace_symbols_fd((void*)0, 0, 0);'):
81911235Sandreas.sandberg@arm.com    backtrace_impls.append("glibc")
82011811Sbaz21@cam.ac.ukelif conf.CheckLibWithHeader('execinfo', 'execinfo.h', 'C',
82111811Sbaz21@cam.ac.uk                           'backtrace_symbols_fd((void*)0, 0, 0);'):
82211811Sbaz21@cam.ac.uk    # NetBSD and FreeBSD need libexecinfo.
82311811Sbaz21@cam.ac.uk    backtrace_impls.append("glibc")
82411811Sbaz21@cam.ac.uk    main.Append(LIBS=['execinfo'])
82511235Sandreas.sandberg@arm.com
82611235Sandreas.sandberg@arm.comif backtrace_impls[-1] == "none":
82711235Sandreas.sandberg@arm.com    default_backtrace_impl = "none"
82811235Sandreas.sandberg@arm.com    print termcap.Yellow + termcap.Bold + \
82911235Sandreas.sandberg@arm.com        "No suitable back trace implementation found." + \
83011235Sandreas.sandberg@arm.com        termcap.Normal
83111235Sandreas.sandberg@arm.com
8327840Snate@binkert.orgif not have_posix_clock:
8337840Snate@binkert.org    print "Can't find library for POSIX clocks."
8347840Snate@binkert.org
8351858SN/A# Check for <fenv.h> (C99 FP environment control)
8361858SN/Ahave_fenv = conf.CheckHeader('fenv.h', '<>')
8371858SN/Aif not have_fenv:
8381858SN/A    print "Warning: Header file <fenv.h> not found."
8391858SN/A    print "         This host has no IEEE FP rounding mode control."
8401858SN/A
84112230Sgiacomo.travaglini@arm.com# Check for <png.h> (libpng library needed if wanting to dump
84212230Sgiacomo.travaglini@arm.com# frame buffer image in png format)
84312230Sgiacomo.travaglini@arm.comhave_png = conf.CheckHeader('png.h', '<>')
84412230Sgiacomo.travaglini@arm.comif not have_png:
84512230Sgiacomo.travaglini@arm.com    print "Warning: Header file <png.h> not found."
84612230Sgiacomo.travaglini@arm.com    print "         This host has no libpng library."
84712230Sgiacomo.travaglini@arm.com    print "         Disabling support for PNG framebuffers."
84812230Sgiacomo.travaglini@arm.com
8499903Sandreas.hansson@arm.com# Check if we should enable KVM-based hardware virtualization. The API
8509903Sandreas.hansson@arm.com# we rely on exists since version 2.6.36 of the kernel, but somehow
8519903Sandreas.hansson@arm.com# the KVM_API_VERSION does not reflect the change. We test for one of
8529903Sandreas.hansson@arm.com# the types as a fall back.
85310841Sandreas.sandberg@arm.comhave_kvm = conf.CheckHeader('linux/kvm.h', '<>')
8549651SAndreas.Sandberg@ARM.comif not have_kvm:
8559903Sandreas.hansson@arm.com    print "Info: Compatible header file <linux/kvm.h> not found, " \
8569651SAndreas.Sandberg@ARM.com        "disabling KVM support."
8579651SAndreas.Sandberg@ARM.com
85812056Sgabeblack@google.com# Check if the TUN/TAP driver is available.
85912056Sgabeblack@google.comhave_tuntap = conf.CheckHeader('linux/if_tun.h', '<>')
86012056Sgabeblack@google.comif not have_tuntap:
86112056Sgabeblack@google.com    print "Info: Compatible header file <linux/if_tun.h> not found."
86212056Sgabeblack@google.com
86310841Sandreas.sandberg@arm.com# x86 needs support for xsave. We test for the structure here since we
86410841Sandreas.sandberg@arm.com# won't be able to run new tests by the time we know which ISA we're
86510841Sandreas.sandberg@arm.com# targeting.
86610841Sandreas.sandberg@arm.comhave_kvm_xsave = conf.CheckTypeSize('struct kvm_xsave',
86710841Sandreas.sandberg@arm.com                                    '#include <linux/kvm.h>') != 0
86810841Sandreas.sandberg@arm.com
8699651SAndreas.Sandberg@ARM.com# Check if the requested target ISA is compatible with the host
8709651SAndreas.Sandberg@ARM.comdef is_isa_kvm_compatible(isa):
8719651SAndreas.Sandberg@ARM.com    try:
8729651SAndreas.Sandberg@ARM.com        import platform
8739651SAndreas.Sandberg@ARM.com        host_isa = platform.machine()
8749651SAndreas.Sandberg@ARM.com    except:
8759651SAndreas.Sandberg@ARM.com        print "Warning: Failed to determine host ISA."
8769651SAndreas.Sandberg@ARM.com        return False
8779651SAndreas.Sandberg@ARM.com
87810841Sandreas.sandberg@arm.com    if not have_posix_timers:
87910841Sandreas.sandberg@arm.com        print "Warning: Can not enable KVM, host seems to lack support " \
88010841Sandreas.sandberg@arm.com            "for POSIX timers"
88110841Sandreas.sandberg@arm.com        return False
88210841Sandreas.sandberg@arm.com
88310841Sandreas.sandberg@arm.com    if isa == "arm":
88410860Sandreas.sandberg@arm.com        return host_isa in ( "armv7l", "aarch64" )
88510841Sandreas.sandberg@arm.com    elif isa == "x86":
88610841Sandreas.sandberg@arm.com        if host_isa != "x86_64":
88710841Sandreas.sandberg@arm.com            return False
88810841Sandreas.sandberg@arm.com
88910841Sandreas.sandberg@arm.com        if not have_kvm_xsave:
89010841Sandreas.sandberg@arm.com            print "KVM on x86 requires xsave support in kernel headers."
89110841Sandreas.sandberg@arm.com            return False
89210841Sandreas.sandberg@arm.com
89310841Sandreas.sandberg@arm.com        return True
89410841Sandreas.sandberg@arm.com    else:
89510841Sandreas.sandberg@arm.com        return False
8969651SAndreas.Sandberg@ARM.com
8979651SAndreas.Sandberg@ARM.com
8989986Sandreas@sandberg.pp.se# Check if the exclude_host attribute is available. We want this to
8999986Sandreas@sandberg.pp.se# get accurate instruction counts in KVM.
9009986Sandreas@sandberg.pp.semain['HAVE_PERF_ATTR_EXCLUDE_HOST'] = conf.CheckMember(
9019986Sandreas@sandberg.pp.se    'linux/perf_event.h', 'struct perf_event_attr', 'exclude_host')
9029986Sandreas@sandberg.pp.se
9039986Sandreas@sandberg.pp.se
9045863Snate@binkert.org######################################################################
9055863Snate@binkert.org#
9065863Snate@binkert.org# Finish the configuration
9075863Snate@binkert.org#
9086121Snate@binkert.orgmain = conf.Finish()
9091858SN/A
9105863Snate@binkert.org######################################################################
9115863Snate@binkert.org#
9125863Snate@binkert.org# Collect all non-global variables
9135863Snate@binkert.org#
9145863Snate@binkert.org
9152139SN/A# Define the universe of supported ISAs
9164202Sbinkertn@umich.eduall_isa_list = [ ]
91711308Santhony.gutierrez@amd.comall_gpu_isa_list = [ ]
9184202Sbinkertn@umich.eduExport('all_isa_list')
91911308Santhony.gutierrez@amd.comExport('all_gpu_isa_list')
9202139SN/A
9216994Snate@binkert.orgclass CpuModel(object):
9226994Snate@binkert.org    '''The CpuModel class encapsulates everything the ISA parser needs to
9236994Snate@binkert.org    know about a particular CPU model.'''
9246994Snate@binkert.org
9256994Snate@binkert.org    # Dict of available CPU model objects.  Accessible as CpuModel.dict.
9266994Snate@binkert.org    dict = {}
9276994Snate@binkert.org
9286994Snate@binkert.org    # Constructor.  Automatically adds models to CpuModel.dict.
92910319SAndreas.Sandberg@ARM.com    def __init__(self, name, default=False):
9306994Snate@binkert.org        self.name = name           # name of model
9316994Snate@binkert.org
9326994Snate@binkert.org        # This cpu is enabled by default
9336994Snate@binkert.org        self.default = default
9346994Snate@binkert.org
9356994Snate@binkert.org        # Add self to dict
9366994Snate@binkert.org        if name in CpuModel.dict:
9376994Snate@binkert.org            raise AttributeError, "CpuModel '%s' already registered" % name
9386994Snate@binkert.org        CpuModel.dict[name] = self
9396994Snate@binkert.org
9406994Snate@binkert.orgExport('CpuModel')
9412155SN/A
9425863Snate@binkert.org# Sticky variables get saved in the variables file so they persist from
9431869SN/A# one invocation to the next (unless overridden, in which case the new
9441869SN/A# value becomes sticky).
9455863Snate@binkert.orgsticky_vars = Variables(args=ARGUMENTS)
9465863Snate@binkert.orgExport('sticky_vars')
9474202Sbinkertn@umich.edu
9486108Snate@binkert.org# Sticky variables that should be exported
9496108Snate@binkert.orgexport_vars = []
9506108Snate@binkert.orgExport('export_vars')
9516108Snate@binkert.org
9529219Spower.jg@gmail.com# For Ruby
9539219Spower.jg@gmail.comall_protocols = []
9549219Spower.jg@gmail.comExport('all_protocols')
9559219Spower.jg@gmail.comprotocol_dirs = []
9569219Spower.jg@gmail.comExport('protocol_dirs')
9579219Spower.jg@gmail.comslicc_includes = []
9589219Spower.jg@gmail.comExport('slicc_includes')
9599219Spower.jg@gmail.com
9604202Sbinkertn@umich.edu# Walk the tree and execute all SConsopts scripts that wil add to the
9615863Snate@binkert.org# above variables
96210135SCurtis.Dunham@arm.comif GetOption('verbose'):
9638474Sgblack@eecs.umich.edu    print "Reading SConsopts"
9645742Snate@binkert.orgfor bdir in [ base_dir ] + extras_dir_list:
9658268Ssteve.reinhardt@amd.com    if not isdir(bdir):
9668268Ssteve.reinhardt@amd.com        print "Error: directory '%s' does not exist" % bdir
9678268Ssteve.reinhardt@amd.com        Exit(1)
9685742Snate@binkert.org    for root, dirs, files in os.walk(bdir):
9695341Sstever@gmail.com        if 'SConsopts' in files:
9708474Sgblack@eecs.umich.edu            if GetOption('verbose'):
9718474Sgblack@eecs.umich.edu                print "Reading", joinpath(root, 'SConsopts')
9725342Sstever@gmail.com            SConscript(joinpath(root, 'SConsopts'))
9734202Sbinkertn@umich.edu
9744202Sbinkertn@umich.eduall_isa_list.sort()
97511308Santhony.gutierrez@amd.comall_gpu_isa_list.sort()
9764202Sbinkertn@umich.edu
9775863Snate@binkert.orgsticky_vars.AddVariables(
9785863Snate@binkert.org    EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list),
97911308Santhony.gutierrez@amd.com    EnumVariable('TARGET_GPU_ISA', 'Target GPU ISA', 'hsail', all_gpu_isa_list),
9806994Snate@binkert.org    ListVariable('CPU_MODELS', 'CPU models',
9816994Snate@binkert.org                 sorted(n for n,m in CpuModel.dict.iteritems() if m.default),
98210319SAndreas.Sandberg@ARM.com                 sorted(CpuModel.dict.keys())),
9835863Snate@binkert.org    BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
9845863Snate@binkert.org                 False),
9855863Snate@binkert.org    BoolVariable('SS_COMPATIBLE_FP',
9865863Snate@binkert.org                 'Make floating-point results compatible with SimpleScalar',
9875863Snate@binkert.org                 False),
9885863Snate@binkert.org    BoolVariable('USE_SSE2',
9895863Snate@binkert.org                 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
9905863Snate@binkert.org                 False),
9917840Snate@binkert.org    BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock),
9925863Snate@binkert.org    BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
99312230Sgiacomo.travaglini@arm.com    BoolVariable('USE_PNG',  'Enable support for PNG images', have_png),
99412230Sgiacomo.travaglini@arm.com    BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability',
99512230Sgiacomo.travaglini@arm.com                 False),
99612230Sgiacomo.travaglini@arm.com    BoolVariable('USE_KVM', 'Enable hardware virtualized (KVM) CPU models',
99712230Sgiacomo.travaglini@arm.com                 have_kvm),
99812056Sgabeblack@google.com    BoolVariable('USE_TUNTAP',
99912056Sgabeblack@google.com                 'Enable using a tap device to bridge to the host network',
100012056Sgabeblack@google.com                 have_tuntap),
100111308Santhony.gutierrez@amd.com    BoolVariable('BUILD_GPU', 'Build the compute-GPU model', False),
10029219Spower.jg@gmail.com    EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None',
10039219Spower.jg@gmail.com                  all_protocols),
100411235Sandreas.sandberg@arm.com    EnumVariable('BACKTRACE_IMPL', 'Post-mortem dump implementation',
100511235Sandreas.sandberg@arm.com                 backtrace_impls[-1], backtrace_impls)
10061869SN/A    )
10071858SN/A
10085863Snate@binkert.org# These variables get exported to #defines in config/*.hh (see src/SConscript).
100911308Santhony.gutierrez@amd.comexport_vars += ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'TARGET_GPU_ISA',
101012061Sjason@lowepower.com                'CP_ANNOTATE', 'USE_POSIX_CLOCK', 'USE_KVM', 'USE_TUNTAP',
101112230Sgiacomo.travaglini@arm.com                'PROTOCOL', 'HAVE_PROTOBUF', 'HAVE_PERF_ATTR_EXCLUDE_HOST',
101212230Sgiacomo.travaglini@arm.com                'USE_PNG']
10131858SN/A
1014955SN/A###################################################
1015955SN/A#
10161869SN/A# Define a SCons builder for configuration flag headers.
10171869SN/A#
10181869SN/A###################################################
10191869SN/A
10201869SN/A# This function generates a config header file that #defines the
10215863Snate@binkert.org# variable symbol to the current variable setting (0 or 1).  The source
10225863Snate@binkert.org# operands are the name of the variable and a Value node containing the
10235863Snate@binkert.org# value of the variable.
10241869SN/Adef build_config_file(target, source, env):
10255863Snate@binkert.org    (variable, value) = [s.get_contents() for s in source]
10261869SN/A    f = file(str(target[0]), 'w')
10275863Snate@binkert.org    print >> f, '#define', variable, value
10281869SN/A    f.close()
10291869SN/A    return None
10301869SN/A
10311869SN/A# Combine the two functions into a scons Action object.
10328483Sgblack@eecs.umich.educonfig_action = MakeAction(build_config_file, Transform("CONFIG H", 2))
10331869SN/A
10341869SN/A# The emitter munges the source & target node lists to reflect what
10351869SN/A# we're really doing.
10361869SN/Adef config_emitter(target, source, env):
10375863Snate@binkert.org    # extract variable name from Builder arg
10385863Snate@binkert.org    variable = str(target[0])
10391869SN/A    # True target is config header file
10405863Snate@binkert.org    target = joinpath('config', variable.lower() + '.hh')
10415863Snate@binkert.org    val = env[variable]
10423356Sbinkertn@umich.edu    if isinstance(val, bool):
10433356Sbinkertn@umich.edu        # Force value to 0/1
10443356Sbinkertn@umich.edu        val = int(val)
10453356Sbinkertn@umich.edu    elif isinstance(val, str):
10463356Sbinkertn@umich.edu        val = '"' + val + '"'
10474781Snate@binkert.org
10485863Snate@binkert.org    # Sources are variable name & value (packaged in SCons Value nodes)
10495863Snate@binkert.org    return ([target], [Value(variable), Value(val)])
10501869SN/A
10511869SN/Aconfig_builder = Builder(emitter = config_emitter, action = config_action)
10521869SN/A
10536121Snate@binkert.orgmain.Append(BUILDERS = { 'ConfigFile' : config_builder })
10541869SN/A
105511982Sgabeblack@google.com###################################################
105611982Sgabeblack@google.com#
105711982Sgabeblack@google.com# Builders for static and shared partially linked object files.
105811982Sgabeblack@google.com#
105911982Sgabeblack@google.com###################################################
106011982Sgabeblack@google.com
106111982Sgabeblack@google.compartial_static_builder = Builder(action=SCons.Defaults.LinkAction,
106211982Sgabeblack@google.com                                 src_suffix='$OBJSUFFIX',
106311982Sgabeblack@google.com                                 src_builder=['StaticObject', 'Object'],
106411982Sgabeblack@google.com                                 LINKFLAGS='$PLINKFLAGS',
106511982Sgabeblack@google.com                                 LIBS='')
106611982Sgabeblack@google.com
106711982Sgabeblack@google.comdef partial_shared_emitter(target, source, env):
106811982Sgabeblack@google.com    for tgt in target:
106911982Sgabeblack@google.com        tgt.attributes.shared = 1
107011982Sgabeblack@google.com    return (target, source)
107111982Sgabeblack@google.compartial_shared_builder = Builder(action=SCons.Defaults.ShLinkAction,
107211982Sgabeblack@google.com                                 emitter=partial_shared_emitter,
107311982Sgabeblack@google.com                                 src_suffix='$SHOBJSUFFIX',
107411982Sgabeblack@google.com                                 src_builder='SharedObject',
107511982Sgabeblack@google.com                                 SHLINKFLAGS='$PSHLINKFLAGS',
107611982Sgabeblack@google.com                                 LIBS='')
107711982Sgabeblack@google.com
107811982Sgabeblack@google.commain.Append(BUILDERS = { 'PartialShared' : partial_shared_builder,
107911982Sgabeblack@google.com                         'PartialStatic' : partial_static_builder })
108011982Sgabeblack@google.com
108111978Sgabeblack@google.com# builds in ext are shared across all configs in the build root.
108211978Sgabeblack@google.comext_dir = abspath(joinpath(str(main.root), 'ext'))
108312034Sgabeblack@google.comext_build_dirs = []
108411978Sgabeblack@google.comfor root, dirs, files in os.walk(ext_dir):
108511978Sgabeblack@google.com    if 'SConscript' in files:
108611978Sgabeblack@google.com        build_dir = os.path.relpath(root, ext_dir)
108712034Sgabeblack@google.com        ext_build_dirs.append(build_dir)
108811978Sgabeblack@google.com        main.SConscript(joinpath(root, 'SConscript'),
108911978Sgabeblack@google.com                        variant_dir=joinpath(build_root, build_dir))
109010915Sandreas.sandberg@arm.com
109111986Sandreas.sandberg@arm.commain.Prepend(CPPPATH=Dir('ext/pybind11/include/'))
109211986Sandreas.sandberg@arm.com
10931869SN/A###################################################
10941869SN/A#
109512015Sgabeblack@google.com# This builder and wrapper method are used to set up a directory with
109612015Sgabeblack@google.com# switching headers. Those are headers which are in a generic location and
109712015Sgabeblack@google.com# that include more specific headers from a directory chosen at build time
109812015Sgabeblack@google.com# based on the current build settings.
10993546Sgblack@eecs.umich.edu#
11003546Sgblack@eecs.umich.edu###################################################
11013546Sgblack@eecs.umich.edu
110212015Sgabeblack@google.comdef build_switching_header(target, source, env):
110312015Sgabeblack@google.com    path = str(target[0])
110412015Sgabeblack@google.com    subdir = str(source[0])
110512015Sgabeblack@google.com    dp, fp = os.path.split(path)
110612015Sgabeblack@google.com    dp = os.path.relpath(os.path.realpath(dp),
110712015Sgabeblack@google.com                         os.path.realpath(env['BUILDDIR']))
110812015Sgabeblack@google.com    with open(path, 'w') as hdr:
110912015Sgabeblack@google.com        print >>hdr, '#include "%s/%s/%s"' % (dp, subdir, fp)
11103546Sgblack@eecs.umich.edu
111112015Sgabeblack@google.comswitching_header_action = MakeAction(build_switching_header,
111212015Sgabeblack@google.com                                     Transform('GENERATE'))
111310196SCurtis.Dunham@arm.com
111412015Sgabeblack@google.comswitching_header_builder = Builder(action=switching_header_action,
111512015Sgabeblack@google.com                                   source_factory=Value,
111612015Sgabeblack@google.com                                   single_source=True)
111712015Sgabeblack@google.com
111812015Sgabeblack@google.commain.Append(BUILDERS = { 'SwitchingHeader': switching_header_builder })
111912015Sgabeblack@google.com
112012015Sgabeblack@google.comdef switching_headers(self, headers, source):
112112015Sgabeblack@google.com    for header in headers:
112212015Sgabeblack@google.com        self.SwitchingHeader(header, source)
112312015Sgabeblack@google.com
112412015Sgabeblack@google.commain.AddMethod(switching_headers, 'SwitchingHeaders')
11253546Sgblack@eecs.umich.edu
11263546Sgblack@eecs.umich.edu###################################################
11273546Sgblack@eecs.umich.edu#
1128955SN/A# Define build environments for selected configurations.
1129955SN/A#
1130955SN/A###################################################
1131955SN/A
11325863Snate@binkert.orgfor variant_path in variant_paths:
113310135SCurtis.Dunham@arm.com    if not GetOption('silent'):
113410135SCurtis.Dunham@arm.com        print "Building in", variant_path
11355343Sstever@gmail.com
11365343Sstever@gmail.com    # Make a copy of the build-root environment to use for this config.
11376121Snate@binkert.org    env = main.Clone()
11385863Snate@binkert.org    env['BUILDDIR'] = variant_path
11394773Snate@binkert.org
11405863Snate@binkert.org    # variant_dir is the tail component of build path, and is used to
11412632Sstever@eecs.umich.edu    # determine the build parameters (e.g., 'ALPHA_SE')
11425863Snate@binkert.org    (build_root, variant_dir) = splitpath(variant_path)
11432023SN/A
11445863Snate@binkert.org    # Set env variables according to the build directory config.
11455863Snate@binkert.org    sticky_vars.files = []
11465863Snate@binkert.org    # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
11475863Snate@binkert.org    # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
11485863Snate@binkert.org    # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
11495863Snate@binkert.org    current_vars_file = joinpath(build_root, 'variables', variant_dir)
11505863Snate@binkert.org    if isfile(current_vars_file):
11515863Snate@binkert.org        sticky_vars.files.append(current_vars_file)
115210135SCurtis.Dunham@arm.com        if not GetOption('silent'):
115310135SCurtis.Dunham@arm.com            print "Using saved variables file %s" % current_vars_file
115412034Sgabeblack@google.com    elif variant_dir in ext_build_dirs:
115512034Sgabeblack@google.com        # Things in ext are built without a variant directory.
115612034Sgabeblack@google.com        continue
11572632Sstever@eecs.umich.edu    else:
11585863Snate@binkert.org        # Build dir-specific variables file doesn't exist.
11592023SN/A
11602632Sstever@eecs.umich.edu        # Make sure the directory is there so we can create it later
11615863Snate@binkert.org        opt_dir = dirname(current_vars_file)
11625342Sstever@gmail.com        if not isdir(opt_dir):
11635863Snate@binkert.org            mkdir(opt_dir)
11642632Sstever@eecs.umich.edu
11655863Snate@binkert.org        # Get default build variables from source tree.  Variables are
11665863Snate@binkert.org        # normally determined by name of $VARIANT_DIR, but can be
11678267Ssteve.reinhardt@amd.com        # overridden by '--default=' arg on command line.
11688120Sgblack@eecs.umich.edu        default = GetOption('default')
11698267Ssteve.reinhardt@amd.com        opts_dir = joinpath(main.root.abspath, 'build_opts')
11708267Ssteve.reinhardt@amd.com        if default:
11718267Ssteve.reinhardt@amd.com            default_vars_files = [joinpath(build_root, 'variables', default),
11728267Ssteve.reinhardt@amd.com                                  joinpath(opts_dir, default)]
11738267Ssteve.reinhardt@amd.com        else:
11748267Ssteve.reinhardt@amd.com            default_vars_files = [joinpath(opts_dir, variant_dir)]
11758267Ssteve.reinhardt@amd.com        existing_files = filter(isfile, default_vars_files)
11768267Ssteve.reinhardt@amd.com        if existing_files:
11778267Ssteve.reinhardt@amd.com            default_vars_file = existing_files[0]
11785863Snate@binkert.org            sticky_vars.files.append(default_vars_file)
11795863Snate@binkert.org            print "Variables file %s not found,\n  using defaults in %s" \
11805863Snate@binkert.org                  % (current_vars_file, default_vars_file)
11812632Sstever@eecs.umich.edu        else:
11828267Ssteve.reinhardt@amd.com            print "Error: cannot find variables file %s or " \
11838267Ssteve.reinhardt@amd.com                  "default file(s) %s" \
11848267Ssteve.reinhardt@amd.com                  % (current_vars_file, ' or '.join(default_vars_files))
11852632Sstever@eecs.umich.edu            Exit(1)
11861888SN/A
11875863Snate@binkert.org    # Apply current variable settings to env
11885863Snate@binkert.org    sticky_vars.Update(env)
11891858SN/A
11908120Sgblack@eecs.umich.edu    help_texts["local_vars"] += \
11918120Sgblack@eecs.umich.edu        "Build variables for %s:\n" % variant_dir \
11927756SAli.Saidi@ARM.com                 + sticky_vars.GenerateHelpText(env)
11932598SN/A
11945863Snate@binkert.org    # Process variable settings.
11951858SN/A
11961858SN/A    if not have_fenv and env['USE_FENV']:
11971858SN/A        print "Warning: <fenv.h> not available; " \
11985863Snate@binkert.org              "forcing USE_FENV to False in", variant_dir + "."
11991858SN/A        env['USE_FENV'] = False
12001858SN/A
12011858SN/A    if not env['USE_FENV']:
12025863Snate@binkert.org        print "Warning: No IEEE FP rounding mode control in", variant_dir + "."
12031871SN/A        print "         FP results may deviate slightly from other platforms."
12041858SN/A
120512230Sgiacomo.travaglini@arm.com    if not have_png and env['USE_PNG']:
120612230Sgiacomo.travaglini@arm.com        print "Warning: <png.h> not available; " \
120712230Sgiacomo.travaglini@arm.com              "forcing USE_PNG to False in", variant_dir + "."
120812230Sgiacomo.travaglini@arm.com        env['USE_PNG'] = False
120912230Sgiacomo.travaglini@arm.com
121012230Sgiacomo.travaglini@arm.com    if env['USE_PNG']:
121112230Sgiacomo.travaglini@arm.com        env.Append(LIBS=['png'])
121212230Sgiacomo.travaglini@arm.com
12131858SN/A    if env['EFENCE']:
12141858SN/A        env.Append(LIBS=['efence'])
12151858SN/A
12169651SAndreas.Sandberg@ARM.com    if env['USE_KVM']:
12179651SAndreas.Sandberg@ARM.com        if not have_kvm:
12189651SAndreas.Sandberg@ARM.com            print "Warning: Can not enable KVM, host seems to lack KVM support"
12199651SAndreas.Sandberg@ARM.com            env['USE_KVM'] = False
12209651SAndreas.Sandberg@ARM.com        elif not is_isa_kvm_compatible(env['TARGET_ISA']):
12219651SAndreas.Sandberg@ARM.com            print "Info: KVM support disabled due to unsupported host and " \
12229651SAndreas.Sandberg@ARM.com                "target ISA combination"
12239651SAndreas.Sandberg@ARM.com            env['USE_KVM'] = False
12249651SAndreas.Sandberg@ARM.com
122512056Sgabeblack@google.com    if env['USE_TUNTAP']:
122612056Sgabeblack@google.com        if not have_tuntap:
122712056Sgabeblack@google.com            print "Warning: Can't connect EtherTap with a tap device."
122812056Sgabeblack@google.com            env['USE_TUNTAP'] = False
122912056Sgabeblack@google.com
123011798Santhony.gutierrez@amd.com    if env['BUILD_GPU']:
123111798Santhony.gutierrez@amd.com        env.Append(CPPDEFINES=['BUILD_GPU'])
123211798Santhony.gutierrez@amd.com
12339986Sandreas@sandberg.pp.se    # Warn about missing optional functionality
12349986Sandreas@sandberg.pp.se    if env['USE_KVM']:
12359986Sandreas@sandberg.pp.se        if not main['HAVE_PERF_ATTR_EXCLUDE_HOST']:
12369986Sandreas@sandberg.pp.se            print "Warning: perf_event headers lack support for the " \
12379986Sandreas@sandberg.pp.se                "exclude_host attribute. KVM instruction counts will " \
12389986Sandreas@sandberg.pp.se                "be inaccurate."
12399986Sandreas@sandberg.pp.se
12405863Snate@binkert.org    # Save sticky variable settings back to current variables file
12415863Snate@binkert.org    sticky_vars.Save(current_vars_file, env)
12421869SN/A
12431965SN/A    if env['USE_SSE2']:
12447739Sgblack@eecs.umich.edu        env.Append(CCFLAGS=['-msse2'])
12451965SN/A
12462761Sstever@eecs.umich.edu    # The src/SConscript file sets up the build rules in 'env' according
12475863Snate@binkert.org    # to the configured variables.  It returns a list of environments,
12481869SN/A    # one for each variant build (debug, opt, etc.)
124910196SCurtis.Dunham@arm.com    SConscript('src/SConscript', variant_dir = variant_path, exports = 'env')
12501869SN/A
12518120Sgblack@eecs.umich.edu# base help text
12528120Sgblack@eecs.umich.eduHelp('''
12538120Sgblack@eecs.umich.eduUsage: scons [scons options] [build variables] [target(s)]
12548120Sgblack@eecs.umich.edu
12558120Sgblack@eecs.umich.eduExtra scons options:
12568120Sgblack@eecs.umich.edu%(options)s
12578120Sgblack@eecs.umich.edu
12588120Sgblack@eecs.umich.eduGlobal build variables:
12598120Sgblack@eecs.umich.edu%(global_vars)s
12608120Sgblack@eecs.umich.edu
12618120Sgblack@eecs.umich.edu%(local_vars)s
12628120Sgblack@eecs.umich.edu''' % help_texts)
1263