SConstruct revision 11235
1955SN/A# -*- mode:python -*- 2955SN/A 31762SN/A# Copyright (c) 2013, 2015 ARM Limited 4955SN/A# All rights reserved. 5955SN/A# 6955SN/A# The license below extends only to copyright in the software and shall 7955SN/A# not be construed as granting a license to any other intellectual 8955SN/A# property including but not limited to intellectual property relating 9955SN/A# to a hardware implementation of the functionality of the software 10955SN/A# licensed hereunder. You may use the software subject to the license 11955SN/A# terms below provided that you ensure that this notice is replicated 12955SN/A# unmodified and in its entirety in all distributions of the software, 13955SN/A# modified or unmodified, in source code or in binary form. 14955SN/A# 15955SN/A# Copyright (c) 2011 Advanced Micro Devices, Inc. 16955SN/A# Copyright (c) 2009 The Hewlett-Packard Development Company 17955SN/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 282665Ssaidi@eecs.umich.edu# contributors may be used to endorse or promote products derived from 294762Snate@binkert.org# this software without specific prior written permission. 30955SN/A# 314762Snate@binkert.org# 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 344202Sbinkertn@umich.edu# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 354382Sbinkertn@umich.edu# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 364202Sbinkertn@umich.edu# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 374762Snate@binkert.org# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 384762Snate@binkert.org# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 394762Snate@binkert.org# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 40955SN/A# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 414381Sbinkertn@umich.edu# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 424381Sbinkertn@umich.edu# 43955SN/A# Authors: Steve Reinhardt 44955SN/A# Nathan Binkert 45955SN/A 464202Sbinkertn@umich.edu################################################### 47955SN/A# 484382Sbinkertn@umich.edu# SCons top-level build description (SConstruct) file. 494382Sbinkertn@umich.edu# 504382Sbinkertn@umich.edu# While in this directory ('gem5'), just type 'scons' to build the default 514762Snate@binkert.org# configuration (see below), or type 'scons build/<CONFIG>/<binary>' 524762Snate@binkert.org# to build some other configuration (e.g., 'build/ALPHA/gem5.opt' for 534762Snate@binkert.org# the optimized full-system version). 544762Snate@binkert.org# 554762Snate@binkert.org# You can build gem5 in a different directory as long as there is a 564762Snate@binkert.org# 'build/<CONFIG>' somewhere along the target path. The build system 574762Snate@binkert.org# expects that all configs under the same build directory are being 584762Snate@binkert.org# built for the same host system. 594762Snate@binkert.org# 604762Snate@binkert.org# Examples: 614762Snate@binkert.org# 624762Snate@binkert.org# The following two commands are equivalent. The '-u' option tells 634762Snate@binkert.org# scons to search up the directory tree for this SConstruct file. 644762Snate@binkert.org# % cd <path-to-src>/gem5 ; scons build/ALPHA/gem5.debug 654762Snate@binkert.org# % cd <path-to-src>/gem5/build/ALPHA; scons -u gem5.debug 664762Snate@binkert.org# 674762Snate@binkert.org# The following two commands are equivalent and demonstrate building 684762Snate@binkert.org# in a directory outside of the source tree. The '-C' option tells 694762Snate@binkert.org# scons to chdir to the specified directory to find this SConstruct 704762Snate@binkert.org# file. 714762Snate@binkert.org# % cd <path-to-src>/gem5 ; scons /local/foo/build/ALPHA/gem5.debug 724762Snate@binkert.org# % cd /local/foo/build/ALPHA; scons -C <path-to-src>/gem5 gem5.debug 734762Snate@binkert.org# 744762Snate@binkert.org# You can use 'scons -H' to print scons options. If you're in this 754762Snate@binkert.org# 'gem5' directory (or use -u or -C to tell scons where to find this 764762Snate@binkert.org# file), you can use 'scons -h' to print all the gem5-specific build 774762Snate@binkert.org# options as well. 784762Snate@binkert.org# 794762Snate@binkert.org################################################### 804762Snate@binkert.org 814762Snate@binkert.org# Check for recent-enough Python and SCons versions. 824762Snate@binkert.orgtry: 834762Snate@binkert.org # Really old versions of scons only take two options for the 844382Sbinkertn@umich.edu # function, so check once without the revision and once with the 854762Snate@binkert.org # revision, the first instance will fail for stuff other than 864382Sbinkertn@umich.edu # 0.98, and the second will fail for 0.98.0 874762Snate@binkert.org EnsureSConsVersion(0, 98) 884381Sbinkertn@umich.edu EnsureSConsVersion(0, 98, 1) 894762Snate@binkert.orgexcept SystemExit, e: 904762Snate@binkert.org print """ 914762Snate@binkert.orgFor more details, see: 924762Snate@binkert.org http://gem5.org/Dependencies 934762Snate@binkert.org""" 944762Snate@binkert.org raise 954762Snate@binkert.org 964762Snate@binkert.org# We ensure the python version early because because python-config 974762Snate@binkert.org# requires python 2.5 984762Snate@binkert.orgtry: 994762Snate@binkert.org EnsurePythonVersion(2, 5) 1004762Snate@binkert.orgexcept SystemExit, e: 1014762Snate@binkert.org print """ 1024762Snate@binkert.orgYou can use a non-default installation of the Python interpreter by 1034762Snate@binkert.orgrearranging your PATH so that scons finds the non-default 'python' and 1044762Snate@binkert.org'python-config' first. 1054762Snate@binkert.org 1064762Snate@binkert.orgFor more details, see: 1074762Snate@binkert.org http://gem5.org/wiki/index.php/Using_a_non-default_Python_installation 1084762Snate@binkert.org""" 1094762Snate@binkert.org raise 1104762Snate@binkert.org 1114762Snate@binkert.org# Global Python includes 1124762Snate@binkert.orgimport itertools 1134762Snate@binkert.orgimport os 1144762Snate@binkert.orgimport re 1154762Snate@binkert.orgimport subprocess 1164762Snate@binkert.orgimport sys 1174762Snate@binkert.org 1184762Snate@binkert.orgfrom os import mkdir, environ 1194762Snate@binkert.orgfrom os.path import abspath, basename, dirname, expanduser, normpath 1204762Snate@binkert.orgfrom os.path import exists, isdir, isfile 1214762Snate@binkert.orgfrom os.path import join as joinpath, split as splitpath 1224762Snate@binkert.org 1234762Snate@binkert.org# SCons includes 1244762Snate@binkert.orgimport SCons 1254762Snate@binkert.orgimport SCons.Node 1264762Snate@binkert.org 1274762Snate@binkert.orgextra_python_paths = [ 1284762Snate@binkert.org Dir('src/python').srcnode().abspath, # gem5 includes 129955SN/A Dir('ext/ply').srcnode().abspath, # ply is used by several files 1304382Sbinkertn@umich.edu ] 1314202Sbinkertn@umich.edu 1324382Sbinkertn@umich.edusys.path[1:1] = extra_python_paths 1334382Sbinkertn@umich.edu 1344382Sbinkertn@umich.edufrom m5.util import compareVersions, readCommand 1354382Sbinkertn@umich.edufrom m5.util.terminal import get_termcap 1364382Sbinkertn@umich.edu 1374382Sbinkertn@umich.eduhelp_texts = { 1385192Ssaidi@eecs.umich.edu "options" : "", 1395192Ssaidi@eecs.umich.edu "global_vars" : "", 1405192Ssaidi@eecs.umich.edu "local_vars" : "" 1415192Ssaidi@eecs.umich.edu} 1425192Ssaidi@eecs.umich.edu 1435192Ssaidi@eecs.umich.eduExport("help_texts") 1445192Ssaidi@eecs.umich.edu 1455192Ssaidi@eecs.umich.edu 1465192Ssaidi@eecs.umich.edu# There's a bug in scons in that (1) by default, the help texts from 1475192Ssaidi@eecs.umich.edu# AddOption() are supposed to be displayed when you type 'scons -h' 1485192Ssaidi@eecs.umich.edu# and (2) you can override the help displayed by 'scons -h' using the 1495192Ssaidi@eecs.umich.edu# Help() function, but these two features are incompatible: once 1505192Ssaidi@eecs.umich.edu# you've overridden the help text using Help(), there's no way to get 1515192Ssaidi@eecs.umich.edu# at the help texts from AddOptions. See: 1525192Ssaidi@eecs.umich.edu# http://scons.tigris.org/issues/show_bug.cgi?id=2356 1535192Ssaidi@eecs.umich.edu# http://scons.tigris.org/issues/show_bug.cgi?id=2611 1545192Ssaidi@eecs.umich.edu# This hack lets us extract the help text from AddOptions and 1555192Ssaidi@eecs.umich.edu# re-inject it via Help(). Ideally someday this bug will be fixed and 1565192Ssaidi@eecs.umich.edu# we can just use AddOption directly. 1575192Ssaidi@eecs.umich.edudef AddLocalOption(*args, **kwargs): 1585192Ssaidi@eecs.umich.edu col_width = 30 1595192Ssaidi@eecs.umich.edu 1605192Ssaidi@eecs.umich.edu help = " " + ", ".join(args) 1615192Ssaidi@eecs.umich.edu if "help" in kwargs: 1625192Ssaidi@eecs.umich.edu length = len(help) 1635192Ssaidi@eecs.umich.edu if length >= col_width: 1645192Ssaidi@eecs.umich.edu help += "\n" + " " * col_width 1655192Ssaidi@eecs.umich.edu else: 1665192Ssaidi@eecs.umich.edu help += " " * (col_width - length) 1675192Ssaidi@eecs.umich.edu help += kwargs["help"] 1685192Ssaidi@eecs.umich.edu help_texts["options"] += help + "\n" 1695192Ssaidi@eecs.umich.edu 1704382Sbinkertn@umich.edu AddOption(*args, **kwargs) 1714382Sbinkertn@umich.edu 1724382Sbinkertn@umich.eduAddLocalOption('--colors', dest='use_colors', action='store_true', 1732667Sstever@eecs.umich.edu help="Add color to abbreviated scons output") 1742667Sstever@eecs.umich.eduAddLocalOption('--no-colors', dest='use_colors', action='store_false', 1752667Sstever@eecs.umich.edu help="Don't add color to abbreviated scons output") 1762667Sstever@eecs.umich.eduAddLocalOption('--with-cxx-config', dest='with_cxx_config', 1772667Sstever@eecs.umich.edu action='store_true', 1782667Sstever@eecs.umich.edu help="Build with support for C++-based configuration") 1792037SN/AAddLocalOption('--default', dest='default', type='string', action='store', 1802037SN/A help='Override which build_opts file to use for defaults') 1812037SN/AAddLocalOption('--ignore-style', dest='ignore_style', action='store_true', 1824382Sbinkertn@umich.edu help='Disable style checking hooks') 1834762Snate@binkert.orgAddLocalOption('--no-lto', dest='no_lto', action='store_true', 1844202Sbinkertn@umich.edu help='Disable Link-Time Optimization for fast') 1854382Sbinkertn@umich.eduAddLocalOption('--update-ref', dest='update_ref', action='store_true', 1864202Sbinkertn@umich.edu help='Update test reference outputs') 1874202Sbinkertn@umich.eduAddLocalOption('--verbose', dest='verbose', action='store_true', 1884202Sbinkertn@umich.edu help='Print full tool command lines') 1894202Sbinkertn@umich.eduAddLocalOption('--without-python', dest='without_python', 1904202Sbinkertn@umich.edu action='store_true', 1914762Snate@binkert.org help='Build without Python configuration support') 1924202Sbinkertn@umich.eduAddLocalOption('--without-tcmalloc', dest='without_tcmalloc', 1934202Sbinkertn@umich.edu action='store_true', 1944202Sbinkertn@umich.edu help='Disable linking against tcmalloc') 1954202Sbinkertn@umich.eduAddLocalOption('--with-ubsan', dest='with_ubsan', action='store_true', 1964202Sbinkertn@umich.edu help='Build with Undefined Behavior Sanitizer if available') 1971858SN/A 1985068Sgblack@eecs.umich.edutermcap = get_termcap(GetOption('use_colors')) 1995068Sgblack@eecs.umich.edu 2005068Sgblack@eecs.umich.edu######################################################################## 2015068Sgblack@eecs.umich.edu# 2025068Sgblack@eecs.umich.edu# Set up the main build environment. 2035068Sgblack@eecs.umich.edu# 2045068Sgblack@eecs.umich.edu######################################################################## 2055068Sgblack@eecs.umich.edu 2065068Sgblack@eecs.umich.edu# export TERM so that clang reports errors in color 2075068Sgblack@eecs.umich.eduuse_vars = set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH', 2085068Sgblack@eecs.umich.edu 'LIBRARY_PATH', 'PATH', 'PKG_CONFIG_PATH', 'PROTOC', 2094773Snate@binkert.org 'PYTHONPATH', 'RANLIB', 'SWIG', 'TERM' ]) 2101858SN/A 2111858SN/Ause_prefixes = [ 2121085SN/A "CCACHE_", # ccache (caching compiler wrapper) configuration 2134382Sbinkertn@umich.edu "CCC_", # clang static analyzer configuration 2144382Sbinkertn@umich.edu "DISTCC_", # distcc (distributed compiler wrapper) configuration 2154762Snate@binkert.org "INCLUDE_SERVER_", # distcc pump server settings 2164762Snate@binkert.org "M5", # M5 configuration (e.g., path to kernels) 2174762Snate@binkert.org ] 2184762Snate@binkert.org 2194762Snate@binkert.orguse_env = {} 2204762Snate@binkert.orgfor key,val in sorted(os.environ.iteritems()): 2214762Snate@binkert.org if key in use_vars or \ 2224762Snate@binkert.org any([key.startswith(prefix) for prefix in use_prefixes]): 2234762Snate@binkert.org use_env[key] = val 2244762Snate@binkert.org 2254762Snate@binkert.org# Tell scons to avoid implicit command dependencies to avoid issues 2264762Snate@binkert.org# with the param wrappes being compiled twice (see 2274762Snate@binkert.org# http://scons.tigris.org/issues/show_bug.cgi?id=2811) 2284762Snate@binkert.orgmain = Environment(ENV=use_env, IMPLICIT_COMMAND_DEPENDENCIES=0) 2294762Snate@binkert.orgmain.Decider('MD5-timestamp') 2304762Snate@binkert.orgmain.root = Dir(".") # The current directory (where this file lives). 2314762Snate@binkert.orgmain.srcdir = Dir("src") # The source directory 2324762Snate@binkert.org 2334762Snate@binkert.orgmain_dict_keys = main.Dictionary().keys() 2344762Snate@binkert.org 2354762Snate@binkert.org# Check that we have a C/C++ compiler 2364762Snate@binkert.orgif not ('CC' in main_dict_keys and 'CXX' in main_dict_keys): 2374762Snate@binkert.org print "No C++ compiler installed (package g++ on Ubuntu and RedHat)" 2384762Snate@binkert.org Exit(1) 2394762Snate@binkert.org 2404762Snate@binkert.org# Check that swig is present 2414762Snate@binkert.orgif not 'SWIG' in main_dict_keys: 2424762Snate@binkert.org print "swig is not installed (package swig on Ubuntu and RedHat)" 2434762Snate@binkert.org Exit(1) 2444762Snate@binkert.org 2454762Snate@binkert.org# add useful python code PYTHONPATH so it can be used by subprocesses 2464762Snate@binkert.org# as well 2474762Snate@binkert.orgmain.AppendENVPath('PYTHONPATH', extra_python_paths) 2484762Snate@binkert.org 2494762Snate@binkert.org######################################################################## 2504382Sbinkertn@umich.edu# 2514382Sbinkertn@umich.edu# Mercurial Stuff. 2524762Snate@binkert.org# 2534762Snate@binkert.org# If the gem5 directory is a mercurial repository, we should do some 2544762Snate@binkert.org# extra things. 2554382Sbinkertn@umich.edu# 2564382Sbinkertn@umich.edu######################################################################## 2574762Snate@binkert.org 2584382Sbinkertn@umich.eduhgdir = main.root.Dir(".hg") 2594382Sbinkertn@umich.edu 2604762Snate@binkert.orgmercurial_style_message = """ 2614382Sbinkertn@umich.eduYou're missing the gem5 style hook, which automatically checks your code 2624382Sbinkertn@umich.eduagainst the gem5 style rules on hg commit and qrefresh commands. This 2634762Snate@binkert.orgscript will now install the hook in your .hg/hgrc file. 2644382Sbinkertn@umich.eduPress enter to continue, or ctrl-c to abort: """ 2654762Snate@binkert.org 2664762Snate@binkert.orgmercurial_style_hook = """ 2674382Sbinkertn@umich.edu# The following lines were automatically added by gem5/SConstruct 2684382Sbinkertn@umich.edu# to provide the gem5 style-checking hooks 2694762Snate@binkert.org[extensions] 2704762Snate@binkert.orgstyle = %s/util/style.py 2714762Snate@binkert.org 2724762Snate@binkert.org[hooks] 2734762Snate@binkert.orgpretxncommit.style = python:style.check_style 2744762Snate@binkert.orgpre-qrefresh.style = python:style.check_style 2754762Snate@binkert.org# End of SConstruct additions 2764762Snate@binkert.org 2774762Snate@binkert.org""" % (main.root.abspath) 2784762Snate@binkert.org 2794762Snate@binkert.orgmercurial_lib_not_found = """ 2804762Snate@binkert.orgMercurial libraries cannot be found, ignoring style hook. If 2814762Snate@binkert.orgyou are a gem5 developer, please fix this and run the style 2824762Snate@binkert.orghook. It is important. 2834762Snate@binkert.org""" 2844762Snate@binkert.org 2854762Snate@binkert.org# Check for style hook and prompt for installation if it's not there. 2864762Snate@binkert.org# Skip this if --ignore-style was specified, there's no .hg dir to 2874762Snate@binkert.org# install a hook in, or there's no interactive terminal to prompt. 2884762Snate@binkert.orgif not GetOption('ignore_style') and hgdir.exists() and sys.stdin.isatty(): 2894762Snate@binkert.org style_hook = True 2904762Snate@binkert.org try: 2914762Snate@binkert.org from mercurial import ui 2924762Snate@binkert.org ui = ui.ui() 2934762Snate@binkert.org ui.readconfig(hgdir.File('hgrc').abspath) 2944762Snate@binkert.org style_hook = ui.config('hooks', 'pretxncommit.style', None) and \ 2954762Snate@binkert.org ui.config('hooks', 'pre-qrefresh.style', None) 2964762Snate@binkert.org except ImportError: 2974762Snate@binkert.org print mercurial_lib_not_found 2984762Snate@binkert.org 2994762Snate@binkert.org if not style_hook: 3004762Snate@binkert.org print mercurial_style_message, 3014762Snate@binkert.org # continue unless user does ctrl-c/ctrl-d etc. 3024762Snate@binkert.org try: 3034762Snate@binkert.org raw_input() 3044762Snate@binkert.org except: 3054762Snate@binkert.org print "Input exception, exiting scons.\n" 3064762Snate@binkert.org sys.exit(1) 3074762Snate@binkert.org hgrc_path = '%s/.hg/hgrc' % main.root.abspath 3084762Snate@binkert.org print "Adding style hook to", hgrc_path, "\n" 3094762Snate@binkert.org try: 3104762Snate@binkert.org hgrc = open(hgrc_path, 'a') 3114762Snate@binkert.org hgrc.write(mercurial_style_hook) 3124762Snate@binkert.org hgrc.close() 3134762Snate@binkert.org except: 3144762Snate@binkert.org print "Error updating", hgrc_path 3154762Snate@binkert.org sys.exit(1) 3164762Snate@binkert.org 3174762Snate@binkert.org 3184382Sbinkertn@umich.edu################################################### 3194762Snate@binkert.org# 3204382Sbinkertn@umich.edu# Figure out which configurations to set up based on the path(s) of 3214762Snate@binkert.org# the target(s). 3224382Sbinkertn@umich.edu# 3234762Snate@binkert.org################################################### 3244762Snate@binkert.org 3254762Snate@binkert.org# Find default configuration & binary. 3264762Snate@binkert.orgDefault(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug')) 3274382Sbinkertn@umich.edu 3284382Sbinkertn@umich.edu# helper function: find last occurrence of element in list 3294382Sbinkertn@umich.edudef rfind(l, elt, offs = -1): 3304382Sbinkertn@umich.edu for i in range(len(l)+offs, 0, -1): 3314382Sbinkertn@umich.edu if l[i] == elt: 3324382Sbinkertn@umich.edu return i 3334762Snate@binkert.org raise ValueError, "element not found" 3344382Sbinkertn@umich.edu 3354382Sbinkertn@umich.edu# Take a list of paths (or SCons Nodes) and return a list with all 3364382Sbinkertn@umich.edu# paths made absolute and ~-expanded. Paths will be interpreted 3374382Sbinkertn@umich.edu# relative to the launch directory unless a different root is provided 3384762Snate@binkert.orgdef makePathListAbsolute(path_list, root=GetLaunchDir()): 3394762Snate@binkert.org return [abspath(joinpath(root, expanduser(str(p)))) 3404762Snate@binkert.org for p in path_list] 3414382Sbinkertn@umich.edu 3425192Ssaidi@eecs.umich.edu# Each target must have 'build' in the interior of the path; the 3435192Ssaidi@eecs.umich.edu# directory below this will determine the build parameters. For 3445192Ssaidi@eecs.umich.edu# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we 3455192Ssaidi@eecs.umich.edu# recognize that ALPHA_SE specifies the configuration because it 3465192Ssaidi@eecs.umich.edu# follow 'build' in the build path. 3475192Ssaidi@eecs.umich.edu 3485192Ssaidi@eecs.umich.edu# The funky assignment to "[:]" is needed to replace the list contents 3495192Ssaidi@eecs.umich.edu# in place rather than reassign the symbol to a new list, which 3505192Ssaidi@eecs.umich.edu# doesn't work (obviously!). 3514762Snate@binkert.orgBUILD_TARGETS[:] = makePathListAbsolute(BUILD_TARGETS) 3524382Sbinkertn@umich.edu 3534382Sbinkertn@umich.edu# Generate a list of the unique build roots and configs that the 3544382Sbinkertn@umich.edu# collected targets reference. 3554762Snate@binkert.orgvariant_paths = [] 3564762Snate@binkert.orgbuild_root = None 3574382Sbinkertn@umich.edufor t in BUILD_TARGETS: 3584382Sbinkertn@umich.edu path_dirs = t.split('/') 3594382Sbinkertn@umich.edu try: 3604762Snate@binkert.org build_top = rfind(path_dirs, 'build', -2) 3614382Sbinkertn@umich.edu except: 3624382Sbinkertn@umich.edu print "Error: no non-leaf 'build' dir found on target path", t 3634762Snate@binkert.org Exit(1) 3644762Snate@binkert.org this_build_root = joinpath('/',*path_dirs[:build_top+1]) 3654762Snate@binkert.org if not build_root: 3664382Sbinkertn@umich.edu build_root = this_build_root 3674382Sbinkertn@umich.edu else: 3684382Sbinkertn@umich.edu if this_build_root != build_root: 3694382Sbinkertn@umich.edu print "Error: build targets not under same build root\n"\ 3704382Sbinkertn@umich.edu " %s\n %s" % (build_root, this_build_root) 3714382Sbinkertn@umich.edu Exit(1) 3724382Sbinkertn@umich.edu variant_path = joinpath('/',*path_dirs[:build_top+2]) 3734382Sbinkertn@umich.edu if variant_path not in variant_paths: 3744382Sbinkertn@umich.edu variant_paths.append(variant_path) 3754382Sbinkertn@umich.edu 376955SN/A# Make sure build_root exists (might not if this is the first build there) 377955SN/Aif not isdir(build_root): 378955SN/A mkdir(build_root) 379955SN/Amain['BUILDROOT'] = build_root 3801108SN/A 381955SN/AExport('main') 382955SN/A 383955SN/Amain.SConsignFile(joinpath(build_root, "sconsign")) 384955SN/A 385955SN/A# Default duplicate option is to use hard links, but this messes up 386955SN/A# when you use emacs to edit a file in the target dir, as emacs moves 387955SN/A# file to file~ then copies to file, breaking the link. Symbolic 388955SN/A# (soft) links work better. 389955SN/Amain.SetOption('duplicate', 'soft-copy') 3902655Sstever@eecs.umich.edu 3912655Sstever@eecs.umich.edu# 3922655Sstever@eecs.umich.edu# Set up global sticky variables... these are common to an entire build 3932655Sstever@eecs.umich.edu# tree (not specific to a particular build like ALPHA_SE) 3942655Sstever@eecs.umich.edu# 3952655Sstever@eecs.umich.edu 3962655Sstever@eecs.umich.eduglobal_vars_file = joinpath(build_root, 'variables.global') 3972655Sstever@eecs.umich.edu 3982655Sstever@eecs.umich.eduglobal_vars = Variables(global_vars_file, args=ARGUMENTS) 3992655Sstever@eecs.umich.edu 4004762Snate@binkert.orgglobal_vars.AddVariables( 4012655Sstever@eecs.umich.edu ('CC', 'C compiler', environ.get('CC', main['CC'])), 4022655Sstever@eecs.umich.edu ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])), 4034007Ssaidi@eecs.umich.edu ('SWIG', 'SWIG tool', environ.get('SWIG', main['SWIG'])), 4044596Sbinkertn@umich.edu ('PROTOC', 'protoc tool', environ.get('PROTOC', 'protoc')), 4054007Ssaidi@eecs.umich.edu ('BATCH', 'Use batch pool for build and tests', False), 4064596Sbinkertn@umich.edu ('BATCH_CMD', 'Batch pool submission command name', 'qdo'), 4074596Sbinkertn@umich.edu ('M5_BUILD_CACHE', 'Cache built objects in this directory', False), 4082655Sstever@eecs.umich.edu ('EXTRAS', 'Add extra directories to the compilation', '') 4094382Sbinkertn@umich.edu ) 4102655Sstever@eecs.umich.edu 4112655Sstever@eecs.umich.edu# Update main environment with values from ARGUMENTS & global_vars_file 4122655Sstever@eecs.umich.eduglobal_vars.Update(main) 413955SN/Ahelp_texts["global_vars"] += global_vars.GenerateHelpText(main) 4143918Ssaidi@eecs.umich.edu 4153918Ssaidi@eecs.umich.edu# Save sticky variable settings back to current variables file 4163918Ssaidi@eecs.umich.eduglobal_vars.Save(global_vars_file, main) 4173918Ssaidi@eecs.umich.edu 4183918Ssaidi@eecs.umich.edu# Parse EXTRAS variable to build list of all directories where we're 4193918Ssaidi@eecs.umich.edu# look for sources etc. This list is exported as extras_dir_list. 4203918Ssaidi@eecs.umich.edubase_dir = main.srcdir.abspath 4213918Ssaidi@eecs.umich.eduif main['EXTRAS']: 4223918Ssaidi@eecs.umich.edu extras_dir_list = makePathListAbsolute(main['EXTRAS'].split(':')) 4233918Ssaidi@eecs.umich.eduelse: 4243918Ssaidi@eecs.umich.edu extras_dir_list = [] 4253918Ssaidi@eecs.umich.edu 4263918Ssaidi@eecs.umich.eduExport('base_dir') 4273918Ssaidi@eecs.umich.eduExport('extras_dir_list') 4283940Ssaidi@eecs.umich.edu 4293940Ssaidi@eecs.umich.edu# the ext directory should be on the #includes path 4303940Ssaidi@eecs.umich.edumain.Append(CPPPATH=[Dir('ext')]) 4313942Ssaidi@eecs.umich.edu 4323940Ssaidi@eecs.umich.edudef strip_build_path(path, env): 4333515Ssaidi@eecs.umich.edu path = str(path) 4343918Ssaidi@eecs.umich.edu variant_base = env['BUILDROOT'] + os.path.sep 4354762Snate@binkert.org if path.startswith(variant_base): 4363515Ssaidi@eecs.umich.edu path = path[len(variant_base):] 4372655Sstever@eecs.umich.edu elif path.startswith('build/'): 4383918Ssaidi@eecs.umich.edu path = path[6:] 4393619Sbinkertn@umich.edu return path 440955SN/A 441955SN/A# Generate a string of the form: 4422655Sstever@eecs.umich.edu# common/path/prefix/src1, src2 -> tgt1, tgt2 4433918Ssaidi@eecs.umich.edu# to print while building. 4443619Sbinkertn@umich.educlass Transform(object): 445955SN/A # all specific color settings should be here and nowhere else 446955SN/A tool_color = termcap.Normal 4472655Sstever@eecs.umich.edu pfx_color = termcap.Yellow 4483918Ssaidi@eecs.umich.edu srcs_color = termcap.Yellow + termcap.Bold 4493619Sbinkertn@umich.edu arrow_color = termcap.Blue + termcap.Bold 450955SN/A tgts_color = termcap.Yellow + termcap.Bold 451955SN/A 4522655Sstever@eecs.umich.edu def __init__(self, tool, max_sources=99): 4533918Ssaidi@eecs.umich.edu self.format = self.tool_color + (" [%8s] " % tool) \ 4543683Sstever@eecs.umich.edu + self.pfx_color + "%s" \ 4552655Sstever@eecs.umich.edu + self.srcs_color + "%s" \ 4561869SN/A + self.arrow_color + " -> " \ 4571869SN/A + self.tgts_color + "%s" \ 458 + termcap.Normal 459 self.max_sources = max_sources 460 461 def __call__(self, target, source, env, for_signature=None): 462 # truncate source list according to max_sources param 463 source = source[0:self.max_sources] 464 def strip(f): 465 return strip_build_path(str(f), env) 466 if len(source) > 0: 467 srcs = map(strip, source) 468 else: 469 srcs = [''] 470 tgts = map(strip, target) 471 # surprisingly, os.path.commonprefix is a dumb char-by-char string 472 # operation that has nothing to do with paths. 473 com_pfx = os.path.commonprefix(srcs + tgts) 474 com_pfx_len = len(com_pfx) 475 if com_pfx: 476 # do some cleanup and sanity checking on common prefix 477 if com_pfx[-1] == ".": 478 # prefix matches all but file extension: ok 479 # back up one to change 'foo.cc -> o' to 'foo.cc -> .o' 480 com_pfx = com_pfx[0:-1] 481 elif com_pfx[-1] == "/": 482 # common prefix is directory path: OK 483 pass 484 else: 485 src0_len = len(srcs[0]) 486 tgt0_len = len(tgts[0]) 487 if src0_len == com_pfx_len: 488 # source is a substring of target, OK 489 pass 490 elif tgt0_len == com_pfx_len: 491 # target is a substring of source, need to back up to 492 # avoid empty string on RHS of arrow 493 sep_idx = com_pfx.rfind(".") 494 if sep_idx != -1: 495 com_pfx = com_pfx[0:sep_idx] 496 else: 497 com_pfx = '' 498 elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".": 499 # still splitting at file extension: ok 500 pass 501 else: 502 # probably a fluke; ignore it 503 com_pfx = '' 504 # recalculate length in case com_pfx was modified 505 com_pfx_len = len(com_pfx) 506 def fmt(files): 507 f = map(lambda s: s[com_pfx_len:], files) 508 return ', '.join(f) 509 return self.format % (com_pfx, fmt(srcs), fmt(tgts)) 510 511Export('Transform') 512 513# enable the regression script to use the termcap 514main['TERMCAP'] = termcap 515 516if GetOption('verbose'): 517 def MakeAction(action, string, *args, **kwargs): 518 return Action(action, *args, **kwargs) 519else: 520 MakeAction = Action 521 main['CCCOMSTR'] = Transform("CC") 522 main['CXXCOMSTR'] = Transform("CXX") 523 main['ASCOMSTR'] = Transform("AS") 524 main['SWIGCOMSTR'] = Transform("SWIG") 525 main['ARCOMSTR'] = Transform("AR", 0) 526 main['LINKCOMSTR'] = Transform("LINK", 0) 527 main['RANLIBCOMSTR'] = Transform("RANLIB", 0) 528 main['M4COMSTR'] = Transform("M4") 529 main['SHCCCOMSTR'] = Transform("SHCC") 530 main['SHCXXCOMSTR'] = Transform("SHCXX") 531Export('MakeAction') 532 533# Initialize the Link-Time Optimization (LTO) flags 534main['LTO_CCFLAGS'] = [] 535main['LTO_LDFLAGS'] = [] 536 537# According to the readme, tcmalloc works best if the compiler doesn't 538# assume that we're using the builtin malloc and friends. These flags 539# are compiler-specific, so we need to set them after we detect which 540# compiler we're using. 541main['TCMALLOC_CCFLAGS'] = [] 542 543CXX_version = readCommand([main['CXX'],'--version'], exception=False) 544CXX_V = readCommand([main['CXX'],'-V'], exception=False) 545 546main['GCC'] = CXX_version and CXX_version.find('g++') >= 0 547main['CLANG'] = CXX_version and CXX_version.find('clang') >= 0 548if main['GCC'] + main['CLANG'] > 1: 549 print 'Error: How can we have two at the same time?' 550 Exit(1) 551 552# Set up default C++ compiler flags 553if main['GCC'] or main['CLANG']: 554 # As gcc and clang share many flags, do the common parts here 555 main.Append(CCFLAGS=['-pipe']) 556 main.Append(CCFLAGS=['-fno-strict-aliasing']) 557 # Enable -Wall and then disable the few warnings that we 558 # consistently violate 559 main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef']) 560 # We always compile using C++11 561 main.Append(CXXFLAGS=['-std=c++11']) 562 # Add selected sanity checks from -Wextra 563 main.Append(CXXFLAGS=['-Wmissing-field-initializers', 564 '-Woverloaded-virtual']) 565else: 566 print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal, 567 print "Don't know what compiler options to use for your compiler." 568 print termcap.Yellow + ' compiler:' + termcap.Normal, main['CXX'] 569 print termcap.Yellow + ' version:' + termcap.Normal, 570 if not CXX_version: 571 print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\ 572 termcap.Normal 573 else: 574 print CXX_version.replace('\n', '<nl>') 575 print " If you're trying to use a compiler other than GCC" 576 print " or clang, there appears to be something wrong with your" 577 print " environment." 578 print " " 579 print " If you are trying to use a compiler other than those listed" 580 print " above you will need to ease fix SConstruct and " 581 print " src/SConscript to support that compiler." 582 Exit(1) 583 584if main['GCC']: 585 # Check for a supported version of gcc. >= 4.7 is chosen for its 586 # level of c++11 support. See 587 # http://gcc.gnu.org/projects/cxx0x.html for details. 588 gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False) 589 if compareVersions(gcc_version, "4.7") < 0: 590 print 'Error: gcc version 4.7 or newer required.' 591 print ' Installed version:', gcc_version 592 Exit(1) 593 594 main['GCC_VERSION'] = gcc_version 595 596 # gcc from version 4.8 and above generates "rep; ret" instructions 597 # to avoid performance penalties on certain AMD chips. Older 598 # assemblers detect this as an error, "Error: expecting string 599 # instruction after `rep'" 600 if compareVersions(gcc_version, "4.8") > 0: 601 as_version_raw = readCommand([main['AS'], '-v', '/dev/null'], 602 exception=False).split() 603 604 # version strings may contain extra distro-specific 605 # qualifiers, so play it safe and keep only what comes before 606 # the first hyphen 607 as_version = as_version_raw[-1].split('-')[0] if as_version_raw \ 608 else None 609 610 if not as_version or compareVersions(as_version, "2.23") < 0: 611 print termcap.Yellow + termcap.Bold + \ 612 'Warning: This combination of gcc and binutils have' + \ 613 ' known incompatibilities.\n' + \ 614 ' If you encounter build problems, please update ' + \ 615 'binutils to 2.23.' + \ 616 termcap.Normal 617 618 # Make sure we warn if the user has requested to compile with the 619 # Undefined Benahvior Sanitizer and this version of gcc does not 620 # support it. 621 if GetOption('with_ubsan') and \ 622 compareVersions(gcc_version, '4.9') < 0: 623 print termcap.Yellow + termcap.Bold + \ 624 'Warning: UBSan is only supported using gcc 4.9 and later.' + \ 625 termcap.Normal 626 627 # Add the appropriate Link-Time Optimization (LTO) flags 628 # unless LTO is explicitly turned off. Note that these flags 629 # are only used by the fast target. 630 if not GetOption('no_lto'): 631 # Pass the LTO flag when compiling to produce GIMPLE 632 # output, we merely create the flags here and only append 633 # them later 634 main['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')] 635 636 # Use the same amount of jobs for LTO as we are running 637 # scons with 638 main['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs')] 639 640 main.Append(TCMALLOC_CCFLAGS=['-fno-builtin-malloc', '-fno-builtin-calloc', 641 '-fno-builtin-realloc', '-fno-builtin-free']) 642 643elif main['CLANG']: 644 # Check for a supported version of clang, >= 3.1 is needed to 645 # support similar features as gcc 4.7. See 646 # http://clang.llvm.org/cxx_status.html for details 647 clang_version_re = re.compile(".* version (\d+\.\d+)") 648 clang_version_match = clang_version_re.search(CXX_version) 649 if (clang_version_match): 650 clang_version = clang_version_match.groups()[0] 651 if compareVersions(clang_version, "3.1") < 0: 652 print 'Error: clang version 3.1 or newer required.' 653 print ' Installed version:', clang_version 654 Exit(1) 655 else: 656 print 'Error: Unable to determine clang version.' 657 Exit(1) 658 659 # clang has a few additional warnings that we disable, 660 # tautological comparisons are allowed due to unsigned integers 661 # being compared to constants that happen to be 0, and extraneous 662 # parantheses are allowed due to Ruby's printing of the AST, 663 # finally self assignments are allowed as the generated CPU code 664 # is relying on this 665 main.Append(CCFLAGS=['-Wno-tautological-compare', 666 '-Wno-parentheses', 667 '-Wno-self-assign', 668 # Some versions of libstdc++ (4.8?) seem to 669 # use struct hash and class hash 670 # interchangeably. 671 '-Wno-mismatched-tags', 672 ]) 673 674 main.Append(TCMALLOC_CCFLAGS=['-fno-builtin']) 675 676 # On Mac OS X/Darwin we need to also use libc++ (part of XCode) as 677 # opposed to libstdc++, as the later is dated. 678 if sys.platform == "darwin": 679 main.Append(CXXFLAGS=['-stdlib=libc++']) 680 main.Append(LIBS=['c++']) 681 682else: 683 print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal, 684 print "Don't know what compiler options to use for your compiler." 685 print termcap.Yellow + ' compiler:' + termcap.Normal, main['CXX'] 686 print termcap.Yellow + ' version:' + termcap.Normal, 687 if not CXX_version: 688 print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\ 689 termcap.Normal 690 else: 691 print CXX_version.replace('\n', '<nl>') 692 print " If you're trying to use a compiler other than GCC" 693 print " or clang, there appears to be something wrong with your" 694 print " environment." 695 print " " 696 print " If you are trying to use a compiler other than those listed" 697 print " above you will need to ease fix SConstruct and " 698 print " src/SConscript to support that compiler." 699 Exit(1) 700 701# Set up common yacc/bison flags (needed for Ruby) 702main['YACCFLAGS'] = '-d' 703main['YACCHXXFILESUFFIX'] = '.hh' 704 705# Do this after we save setting back, or else we'll tack on an 706# extra 'qdo' every time we run scons. 707if main['BATCH']: 708 main['CC'] = main['BATCH_CMD'] + ' ' + main['CC'] 709 main['CXX'] = main['BATCH_CMD'] + ' ' + main['CXX'] 710 main['AS'] = main['BATCH_CMD'] + ' ' + main['AS'] 711 main['AR'] = main['BATCH_CMD'] + ' ' + main['AR'] 712 main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB'] 713 714if sys.platform == 'cygwin': 715 # cygwin has some header file issues... 716 main.Append(CCFLAGS=["-Wno-uninitialized"]) 717 718# Check for the protobuf compiler 719protoc_version = readCommand([main['PROTOC'], '--version'], 720 exception='').split() 721 722# First two words should be "libprotoc x.y.z" 723if len(protoc_version) < 2 or protoc_version[0] != 'libprotoc': 724 print termcap.Yellow + termcap.Bold + \ 725 'Warning: Protocol buffer compiler (protoc) not found.\n' + \ 726 ' Please install protobuf-compiler for tracing support.' + \ 727 termcap.Normal 728 main['PROTOC'] = False 729else: 730 # Based on the availability of the compress stream wrappers, 731 # require 2.1.0 732 min_protoc_version = '2.1.0' 733 if compareVersions(protoc_version[1], min_protoc_version) < 0: 734 print termcap.Yellow + termcap.Bold + \ 735 'Warning: protoc version', min_protoc_version, \ 736 'or newer required.\n' + \ 737 ' Installed version:', protoc_version[1], \ 738 termcap.Normal 739 main['PROTOC'] = False 740 else: 741 # Attempt to determine the appropriate include path and 742 # library path using pkg-config, that means we also need to 743 # check for pkg-config. Note that it is possible to use 744 # protobuf without the involvement of pkg-config. Later on we 745 # check go a library config check and at that point the test 746 # will fail if libprotobuf cannot be found. 747 if readCommand(['pkg-config', '--version'], exception=''): 748 try: 749 # Attempt to establish what linking flags to add for protobuf 750 # using pkg-config 751 main.ParseConfig('pkg-config --cflags --libs-only-L protobuf') 752 except: 753 print termcap.Yellow + termcap.Bold + \ 754 'Warning: pkg-config could not get protobuf flags.' + \ 755 termcap.Normal 756 757# Check for SWIG 758if not main.has_key('SWIG'): 759 print 'Error: SWIG utility not found.' 760 print ' Please install (see http://www.swig.org) and retry.' 761 Exit(1) 762 763# Check for appropriate SWIG version 764swig_version = readCommand([main['SWIG'], '-version'], exception='').split() 765# First 3 words should be "SWIG Version x.y.z" 766if len(swig_version) < 3 or \ 767 swig_version[0] != 'SWIG' or swig_version[1] != 'Version': 768 print 'Error determining SWIG version.' 769 Exit(1) 770 771min_swig_version = '2.0.4' 772if compareVersions(swig_version[2], min_swig_version) < 0: 773 print 'Error: SWIG version', min_swig_version, 'or newer required.' 774 print ' Installed version:', swig_version[2] 775 Exit(1) 776 777# Check for known incompatibilities. The standard library shipped with 778# gcc >= 4.9 does not play well with swig versions prior to 3.0 779if main['GCC'] and compareVersions(gcc_version, '4.9') >= 0 and \ 780 compareVersions(swig_version[2], '3.0') < 0: 781 print termcap.Yellow + termcap.Bold + \ 782 'Warning: This combination of gcc and swig have' + \ 783 ' known incompatibilities.\n' + \ 784 ' If you encounter build problems, please update ' + \ 785 'swig to 3.0 or later.' + \ 786 termcap.Normal 787 788# Set up SWIG flags & scanner 789swig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS') 790main.Append(SWIGFLAGS=swig_flags) 791 792# Check for 'timeout' from GNU coreutils. If present, regressions will 793# be run with a time limit. We require version 8.13 since we rely on 794# support for the '--foreground' option. 795timeout_lines = readCommand(['timeout', '--version'], 796 exception='').splitlines() 797# Get the first line and tokenize it 798timeout_version = timeout_lines[0].split() if timeout_lines else [] 799main['TIMEOUT'] = timeout_version and \ 800 compareVersions(timeout_version[-1], '8.13') >= 0 801 802# filter out all existing swig scanners, they mess up the dependency 803# stuff for some reason 804scanners = [] 805for scanner in main['SCANNERS']: 806 skeys = scanner.skeys 807 if skeys == '.i': 808 continue 809 810 if isinstance(skeys, (list, tuple)) and '.i' in skeys: 811 continue 812 813 scanners.append(scanner) 814 815# add the new swig scanner that we like better 816from SCons.Scanner import ClassicCPP as CPPScanner 817swig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")' 818scanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re)) 819 820# replace the scanners list that has what we want 821main['SCANNERS'] = scanners 822 823# Add a custom Check function to test for structure members. 824def CheckMember(context, include, decl, member, include_quotes="<>"): 825 context.Message("Checking for member %s in %s..." % 826 (member, decl)) 827 text = """ 828#include %(header)s 829int main(){ 830 %(decl)s test; 831 (void)test.%(member)s; 832 return 0; 833}; 834""" % { "header" : include_quotes[0] + include + include_quotes[1], 835 "decl" : decl, 836 "member" : member, 837 } 838 839 ret = context.TryCompile(text, extension=".cc") 840 context.Result(ret) 841 return ret 842 843# Platform-specific configuration. Note again that we assume that all 844# builds under a given build root run on the same host platform. 845conf = Configure(main, 846 conf_dir = joinpath(build_root, '.scons_config'), 847 log_file = joinpath(build_root, 'scons_config.log'), 848 custom_tests = { 849 'CheckMember' : CheckMember, 850 }) 851 852# Check if we should compile a 64 bit binary on Mac OS X/Darwin 853try: 854 import platform 855 uname = platform.uname() 856 if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0: 857 if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]): 858 main.Append(CCFLAGS=['-arch', 'x86_64']) 859 main.Append(CFLAGS=['-arch', 'x86_64']) 860 main.Append(LINKFLAGS=['-arch', 'x86_64']) 861 main.Append(ASFLAGS=['-arch', 'x86_64']) 862except: 863 pass 864 865# Recent versions of scons substitute a "Null" object for Configure() 866# when configuration isn't necessary, e.g., if the "--help" option is 867# present. Unfortuantely this Null object always returns false, 868# breaking all our configuration checks. We replace it with our own 869# more optimistic null object that returns True instead. 870if not conf: 871 def NullCheck(*args, **kwargs): 872 return True 873 874 class NullConf: 875 def __init__(self, env): 876 self.env = env 877 def Finish(self): 878 return self.env 879 def __getattr__(self, mname): 880 return NullCheck 881 882 conf = NullConf(main) 883 884# Cache build files in the supplied directory. 885if main['M5_BUILD_CACHE']: 886 print 'Using build cache located at', main['M5_BUILD_CACHE'] 887 CacheDir(main['M5_BUILD_CACHE']) 888 889if not GetOption('without_python'): 890 # Find Python include and library directories for embedding the 891 # interpreter. We rely on python-config to resolve the appropriate 892 # includes and linker flags. ParseConfig does not seem to understand 893 # the more exotic linker flags such as -Xlinker and -export-dynamic so 894 # we add them explicitly below. If you want to link in an alternate 895 # version of python, see above for instructions on how to invoke 896 # scons with the appropriate PATH set. 897 # 898 # First we check if python2-config exists, else we use python-config 899 python_config = readCommand(['which', 'python2-config'], 900 exception='').strip() 901 if not os.path.exists(python_config): 902 python_config = readCommand(['which', 'python-config'], 903 exception='').strip() 904 py_includes = readCommand([python_config, '--includes'], 905 exception='').split() 906 # Strip the -I from the include folders before adding them to the 907 # CPPPATH 908 main.Append(CPPPATH=map(lambda inc: inc[2:], py_includes)) 909 910 # Read the linker flags and split them into libraries and other link 911 # flags. The libraries are added later through the call the CheckLib. 912 py_ld_flags = readCommand([python_config, '--ldflags'], 913 exception='').split() 914 py_libs = [] 915 for lib in py_ld_flags: 916 if not lib.startswith('-l'): 917 main.Append(LINKFLAGS=[lib]) 918 else: 919 lib = lib[2:] 920 if lib not in py_libs: 921 py_libs.append(lib) 922 923 # verify that this stuff works 924 if not conf.CheckHeader('Python.h', '<>'): 925 print "Error: can't find Python.h header in", py_includes 926 print "Install Python headers (package python-dev on Ubuntu and RedHat)" 927 Exit(1) 928 929 for lib in py_libs: 930 if not conf.CheckLib(lib): 931 print "Error: can't find library %s required by python" % lib 932 Exit(1) 933 934# On Solaris you need to use libsocket for socket ops 935if not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'): 936 if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'): 937 print "Can't find library with socket calls (e.g. accept())" 938 Exit(1) 939 940# Check for zlib. If the check passes, libz will be automatically 941# added to the LIBS environment variable. 942if not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'): 943 print 'Error: did not find needed zlib compression library '\ 944 'and/or zlib.h header file.' 945 print ' Please install zlib and try again.' 946 Exit(1) 947 948# If we have the protobuf compiler, also make sure we have the 949# development libraries. If the check passes, libprotobuf will be 950# automatically added to the LIBS environment variable. After 951# this, we can use the HAVE_PROTOBUF flag to determine if we have 952# got both protoc and libprotobuf available. 953main['HAVE_PROTOBUF'] = main['PROTOC'] and \ 954 conf.CheckLibWithHeader('protobuf', 'google/protobuf/message.h', 955 'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;') 956 957# If we have the compiler but not the library, print another warning. 958if main['PROTOC'] and not main['HAVE_PROTOBUF']: 959 print termcap.Yellow + termcap.Bold + \ 960 'Warning: did not find protocol buffer library and/or headers.\n' + \ 961 ' Please install libprotobuf-dev for tracing support.' + \ 962 termcap.Normal 963 964# Check for librt. 965have_posix_clock = \ 966 conf.CheckLibWithHeader(None, 'time.h', 'C', 967 'clock_nanosleep(0,0,NULL,NULL);') or \ 968 conf.CheckLibWithHeader('rt', 'time.h', 'C', 969 'clock_nanosleep(0,0,NULL,NULL);') 970 971have_posix_timers = \ 972 conf.CheckLibWithHeader([None, 'rt'], [ 'time.h', 'signal.h' ], 'C', 973 'timer_create(CLOCK_MONOTONIC, NULL, NULL);') 974 975if not GetOption('without_tcmalloc'): 976 if conf.CheckLib('tcmalloc'): 977 main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS']) 978 elif conf.CheckLib('tcmalloc_minimal'): 979 main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS']) 980 else: 981 print termcap.Yellow + termcap.Bold + \ 982 "You can get a 12% performance improvement by "\ 983 "installing tcmalloc (libgoogle-perftools-dev package "\ 984 "on Ubuntu or RedHat)." + termcap.Normal 985 986 987# Detect back trace implementations. The last implementation in the 988# list will be used by default. 989backtrace_impls = [ "none" ] 990 991if conf.CheckLibWithHeader(None, 'execinfo.h', 'C', 992 'backtrace_symbols_fd((void*)0, 0, 0);'): 993 backtrace_impls.append("glibc") 994 995if backtrace_impls[-1] == "none": 996 default_backtrace_impl = "none" 997 print termcap.Yellow + termcap.Bold + \ 998 "No suitable back trace implementation found." + \ 999 termcap.Normal 1000 1001if not have_posix_clock: 1002 print "Can't find library for POSIX clocks." 1003 1004# Check for <fenv.h> (C99 FP environment control) 1005have_fenv = conf.CheckHeader('fenv.h', '<>') 1006if not have_fenv: 1007 print "Warning: Header file <fenv.h> not found." 1008 print " This host has no IEEE FP rounding mode control." 1009 1010# Check if we should enable KVM-based hardware virtualization. The API 1011# we rely on exists since version 2.6.36 of the kernel, but somehow 1012# the KVM_API_VERSION does not reflect the change. We test for one of 1013# the types as a fall back. 1014have_kvm = conf.CheckHeader('linux/kvm.h', '<>') 1015if not have_kvm: 1016 print "Info: Compatible header file <linux/kvm.h> not found, " \ 1017 "disabling KVM support." 1018 1019# x86 needs support for xsave. We test for the structure here since we 1020# won't be able to run new tests by the time we know which ISA we're 1021# targeting. 1022have_kvm_xsave = conf.CheckTypeSize('struct kvm_xsave', 1023 '#include <linux/kvm.h>') != 0 1024 1025# Check if the requested target ISA is compatible with the host 1026def is_isa_kvm_compatible(isa): 1027 try: 1028 import platform 1029 host_isa = platform.machine() 1030 except: 1031 print "Warning: Failed to determine host ISA." 1032 return False 1033 1034 if not have_posix_timers: 1035 print "Warning: Can not enable KVM, host seems to lack support " \ 1036 "for POSIX timers" 1037 return False 1038 1039 if isa == "arm": 1040 return host_isa in ( "armv7l", "aarch64" ) 1041 elif isa == "x86": 1042 if host_isa != "x86_64": 1043 return False 1044 1045 if not have_kvm_xsave: 1046 print "KVM on x86 requires xsave support in kernel headers." 1047 return False 1048 1049 return True 1050 else: 1051 return False 1052 1053 1054# Check if the exclude_host attribute is available. We want this to 1055# get accurate instruction counts in KVM. 1056main['HAVE_PERF_ATTR_EXCLUDE_HOST'] = conf.CheckMember( 1057 'linux/perf_event.h', 'struct perf_event_attr', 'exclude_host') 1058 1059 1060###################################################################### 1061# 1062# Finish the configuration 1063# 1064main = conf.Finish() 1065 1066###################################################################### 1067# 1068# Collect all non-global variables 1069# 1070 1071# Define the universe of supported ISAs 1072all_isa_list = [ ] 1073Export('all_isa_list') 1074 1075class CpuModel(object): 1076 '''The CpuModel class encapsulates everything the ISA parser needs to 1077 know about a particular CPU model.''' 1078 1079 # Dict of available CPU model objects. Accessible as CpuModel.dict. 1080 dict = {} 1081 1082 # Constructor. Automatically adds models to CpuModel.dict. 1083 def __init__(self, name, default=False): 1084 self.name = name # name of model 1085 1086 # This cpu is enabled by default 1087 self.default = default 1088 1089 # Add self to dict 1090 if name in CpuModel.dict: 1091 raise AttributeError, "CpuModel '%s' already registered" % name 1092 CpuModel.dict[name] = self 1093 1094Export('CpuModel') 1095 1096# Sticky variables get saved in the variables file so they persist from 1097# one invocation to the next (unless overridden, in which case the new 1098# value becomes sticky). 1099sticky_vars = Variables(args=ARGUMENTS) 1100Export('sticky_vars') 1101 1102# Sticky variables that should be exported 1103export_vars = [] 1104Export('export_vars') 1105 1106# For Ruby 1107all_protocols = [] 1108Export('all_protocols') 1109protocol_dirs = [] 1110Export('protocol_dirs') 1111slicc_includes = [] 1112Export('slicc_includes') 1113 1114# Walk the tree and execute all SConsopts scripts that wil add to the 1115# above variables 1116if GetOption('verbose'): 1117 print "Reading SConsopts" 1118for bdir in [ base_dir ] + extras_dir_list: 1119 if not isdir(bdir): 1120 print "Error: directory '%s' does not exist" % bdir 1121 Exit(1) 1122 for root, dirs, files in os.walk(bdir): 1123 if 'SConsopts' in files: 1124 if GetOption('verbose'): 1125 print "Reading", joinpath(root, 'SConsopts') 1126 SConscript(joinpath(root, 'SConsopts')) 1127 1128all_isa_list.sort() 1129 1130sticky_vars.AddVariables( 1131 EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list), 1132 ListVariable('CPU_MODELS', 'CPU models', 1133 sorted(n for n,m in CpuModel.dict.iteritems() if m.default), 1134 sorted(CpuModel.dict.keys())), 1135 BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger', 1136 False), 1137 BoolVariable('SS_COMPATIBLE_FP', 1138 'Make floating-point results compatible with SimpleScalar', 1139 False), 1140 BoolVariable('USE_SSE2', 1141 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts', 1142 False), 1143 BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock), 1144 BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv), 1145 BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False), 1146 BoolVariable('USE_KVM', 'Enable hardware virtualized (KVM) CPU models', have_kvm), 1147 EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None', 1148 all_protocols), 1149 EnumVariable('BACKTRACE_IMPL', 'Post-mortem dump implementation', 1150 backtrace_impls[-1], backtrace_impls) 1151 ) 1152 1153# These variables get exported to #defines in config/*.hh (see src/SConscript). 1154export_vars += ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'CP_ANNOTATE', 1155 'USE_POSIX_CLOCK', 'USE_KVM', 'PROTOCOL', 'HAVE_PROTOBUF', 1156 'HAVE_PERF_ATTR_EXCLUDE_HOST'] 1157 1158################################################### 1159# 1160# Define a SCons builder for configuration flag headers. 1161# 1162################################################### 1163 1164# This function generates a config header file that #defines the 1165# variable symbol to the current variable setting (0 or 1). The source 1166# operands are the name of the variable and a Value node containing the 1167# value of the variable. 1168def build_config_file(target, source, env): 1169 (variable, value) = [s.get_contents() for s in source] 1170 f = file(str(target[0]), 'w') 1171 print >> f, '#define', variable, value 1172 f.close() 1173 return None 1174 1175# Combine the two functions into a scons Action object. 1176config_action = MakeAction(build_config_file, Transform("CONFIG H", 2)) 1177 1178# The emitter munges the source & target node lists to reflect what 1179# we're really doing. 1180def config_emitter(target, source, env): 1181 # extract variable name from Builder arg 1182 variable = str(target[0]) 1183 # True target is config header file 1184 target = joinpath('config', variable.lower() + '.hh') 1185 val = env[variable] 1186 if isinstance(val, bool): 1187 # Force value to 0/1 1188 val = int(val) 1189 elif isinstance(val, str): 1190 val = '"' + val + '"' 1191 1192 # Sources are variable name & value (packaged in SCons Value nodes) 1193 return ([target], [Value(variable), Value(val)]) 1194 1195config_builder = Builder(emitter = config_emitter, action = config_action) 1196 1197main.Append(BUILDERS = { 'ConfigFile' : config_builder }) 1198 1199# libelf build is shared across all configs in the build root. 1200main.SConscript('ext/libelf/SConscript', 1201 variant_dir = joinpath(build_root, 'libelf')) 1202 1203# gzstream build is shared across all configs in the build root. 1204main.SConscript('ext/gzstream/SConscript', 1205 variant_dir = joinpath(build_root, 'gzstream')) 1206 1207# libfdt build is shared across all configs in the build root. 1208main.SConscript('ext/libfdt/SConscript', 1209 variant_dir = joinpath(build_root, 'libfdt')) 1210 1211# fputils build is shared across all configs in the build root. 1212main.SConscript('ext/fputils/SConscript', 1213 variant_dir = joinpath(build_root, 'fputils')) 1214 1215# DRAMSim2 build is shared across all configs in the build root. 1216main.SConscript('ext/dramsim2/SConscript', 1217 variant_dir = joinpath(build_root, 'dramsim2')) 1218 1219# DRAMPower build is shared across all configs in the build root. 1220main.SConscript('ext/drampower/SConscript', 1221 variant_dir = joinpath(build_root, 'drampower')) 1222 1223# nomali build is shared across all configs in the build root. 1224main.SConscript('ext/nomali/SConscript', 1225 variant_dir = joinpath(build_root, 'nomali')) 1226 1227################################################### 1228# 1229# This function is used to set up a directory with switching headers 1230# 1231################################################### 1232 1233main['ALL_ISA_LIST'] = all_isa_list 1234all_isa_deps = {} 1235def make_switching_dir(dname, switch_headers, env): 1236 # Generate the header. target[0] is the full path of the output 1237 # header to generate. 'source' is a dummy variable, since we get the 1238 # list of ISAs from env['ALL_ISA_LIST']. 1239 def gen_switch_hdr(target, source, env): 1240 fname = str(target[0]) 1241 isa = env['TARGET_ISA'].lower() 1242 try: 1243 f = open(fname, 'w') 1244 print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname)) 1245 f.close() 1246 except IOError: 1247 print "Failed to create %s" % fname 1248 raise 1249 1250 # Build SCons Action object. 'varlist' specifies env vars that this 1251 # action depends on; when env['ALL_ISA_LIST'] changes these actions 1252 # should get re-executed. 1253 switch_hdr_action = MakeAction(gen_switch_hdr, 1254 Transform("GENERATE"), varlist=['ALL_ISA_LIST']) 1255 1256 # Instantiate actions for each header 1257 for hdr in switch_headers: 1258 env.Command(hdr, [], switch_hdr_action) 1259 1260 isa_target = Dir('.').up().name.lower().replace('_', '-') 1261 env['PHONY_BASE'] = '#'+isa_target 1262 all_isa_deps[isa_target] = None 1263 1264Export('make_switching_dir') 1265 1266# all-isas -> all-deps -> all-environs -> all_targets 1267main.Alias('#all-isas', []) 1268main.Alias('#all-deps', '#all-isas') 1269 1270# Dummy target to ensure all environments are created before telling 1271# SCons what to actually make (the command line arguments). We attach 1272# them to the dependence graph after the environments are complete. 1273ORIG_BUILD_TARGETS = list(BUILD_TARGETS) # force a copy; gets closure to work. 1274def environsComplete(target, source, env): 1275 for t in ORIG_BUILD_TARGETS: 1276 main.Depends('#all-targets', t) 1277 1278# Each build/* switching_dir attaches its *-environs target to #all-environs. 1279main.Append(BUILDERS = {'CompleteEnvirons' : 1280 Builder(action=MakeAction(environsComplete, None))}) 1281main.CompleteEnvirons('#all-environs', []) 1282 1283def doNothing(**ignored): pass 1284main.Append(BUILDERS = {'Dummy': Builder(action=MakeAction(doNothing, None))}) 1285 1286# The final target to which all the original targets ultimately get attached. 1287main.Dummy('#all-targets', '#all-environs') 1288BUILD_TARGETS[:] = ['#all-targets'] 1289 1290################################################### 1291# 1292# Define build environments for selected configurations. 1293# 1294################################################### 1295 1296for variant_path in variant_paths: 1297 if not GetOption('silent'): 1298 print "Building in", variant_path 1299 1300 # Make a copy of the build-root environment to use for this config. 1301 env = main.Clone() 1302 env['BUILDDIR'] = variant_path 1303 1304 # variant_dir is the tail component of build path, and is used to 1305 # determine the build parameters (e.g., 'ALPHA_SE') 1306 (build_root, variant_dir) = splitpath(variant_path) 1307 1308 # Set env variables according to the build directory config. 1309 sticky_vars.files = [] 1310 # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in 1311 # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke 1312 # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings. 1313 current_vars_file = joinpath(build_root, 'variables', variant_dir) 1314 if isfile(current_vars_file): 1315 sticky_vars.files.append(current_vars_file) 1316 if not GetOption('silent'): 1317 print "Using saved variables file %s" % current_vars_file 1318 else: 1319 # Build dir-specific variables file doesn't exist. 1320 1321 # Make sure the directory is there so we can create it later 1322 opt_dir = dirname(current_vars_file) 1323 if not isdir(opt_dir): 1324 mkdir(opt_dir) 1325 1326 # Get default build variables from source tree. Variables are 1327 # normally determined by name of $VARIANT_DIR, but can be 1328 # overridden by '--default=' arg on command line. 1329 default = GetOption('default') 1330 opts_dir = joinpath(main.root.abspath, 'build_opts') 1331 if default: 1332 default_vars_files = [joinpath(build_root, 'variables', default), 1333 joinpath(opts_dir, default)] 1334 else: 1335 default_vars_files = [joinpath(opts_dir, variant_dir)] 1336 existing_files = filter(isfile, default_vars_files) 1337 if existing_files: 1338 default_vars_file = existing_files[0] 1339 sticky_vars.files.append(default_vars_file) 1340 print "Variables file %s not found,\n using defaults in %s" \ 1341 % (current_vars_file, default_vars_file) 1342 else: 1343 print "Error: cannot find variables file %s or " \ 1344 "default file(s) %s" \ 1345 % (current_vars_file, ' or '.join(default_vars_files)) 1346 Exit(1) 1347 1348 # Apply current variable settings to env 1349 sticky_vars.Update(env) 1350 1351 help_texts["local_vars"] += \ 1352 "Build variables for %s:\n" % variant_dir \ 1353 + sticky_vars.GenerateHelpText(env) 1354 1355 # Process variable settings. 1356 1357 if not have_fenv and env['USE_FENV']: 1358 print "Warning: <fenv.h> not available; " \ 1359 "forcing USE_FENV to False in", variant_dir + "." 1360 env['USE_FENV'] = False 1361 1362 if not env['USE_FENV']: 1363 print "Warning: No IEEE FP rounding mode control in", variant_dir + "." 1364 print " FP results may deviate slightly from other platforms." 1365 1366 if env['EFENCE']: 1367 env.Append(LIBS=['efence']) 1368 1369 if env['USE_KVM']: 1370 if not have_kvm: 1371 print "Warning: Can not enable KVM, host seems to lack KVM support" 1372 env['USE_KVM'] = False 1373 elif not is_isa_kvm_compatible(env['TARGET_ISA']): 1374 print "Info: KVM support disabled due to unsupported host and " \ 1375 "target ISA combination" 1376 env['USE_KVM'] = False 1377 1378 # Warn about missing optional functionality 1379 if env['USE_KVM']: 1380 if not main['HAVE_PERF_ATTR_EXCLUDE_HOST']: 1381 print "Warning: perf_event headers lack support for the " \ 1382 "exclude_host attribute. KVM instruction counts will " \ 1383 "be inaccurate." 1384 1385 # Save sticky variable settings back to current variables file 1386 sticky_vars.Save(current_vars_file, env) 1387 1388 if env['USE_SSE2']: 1389 env.Append(CCFLAGS=['-msse2']) 1390 1391 # The src/SConscript file sets up the build rules in 'env' according 1392 # to the configured variables. It returns a list of environments, 1393 # one for each variant build (debug, opt, etc.) 1394 SConscript('src/SConscript', variant_dir = variant_path, exports = 'env') 1395 1396def pairwise(iterable): 1397 "s -> (s0,s1), (s1,s2), (s2, s3), ..." 1398 a, b = itertools.tee(iterable) 1399 b.next() 1400 return itertools.izip(a, b) 1401 1402# Create false dependencies so SCons will parse ISAs, establish 1403# dependencies, and setup the build Environments serially. Either 1404# SCons (likely) and/or our SConscripts (possibly) cannot cope with -j 1405# greater than 1. It appears to be standard race condition stuff; it 1406# doesn't always fail, but usually, and the behaviors are different. 1407# Every time I tried to remove this, builds would fail in some 1408# creative new way. So, don't do that. You'll want to, though, because 1409# tests/SConscript takes a long time to make its Environments. 1410for t1, t2 in pairwise(sorted(all_isa_deps.iterkeys())): 1411 main.Depends('#%s-deps' % t2, '#%s-deps' % t1) 1412 main.Depends('#%s-environs' % t2, '#%s-environs' % t1) 1413 1414# base help text 1415Help(''' 1416Usage: scons [scons options] [build variables] [target(s)] 1417 1418Extra scons options: 1419%(options)s 1420 1421Global build variables: 1422%(global_vars)s 1423 1424%(local_vars)s 1425''' % help_texts) 1426