SConstruct revision 9477
12391SN/A# -*- mode:python -*- 28931Sandreas.hansson@arm.com 37733SN/A# Copyright (c) 2011 Advanced Micro Devices, Inc. 47733SN/A# Copyright (c) 2009 The Hewlett-Packard Development Company 57733SN/A# Copyright (c) 2004-2005 The Regents of The University of Michigan 67733SN/A# All rights reserved. 77733SN/A# 87733SN/A# Redistribution and use in source and binary forms, with or without 97733SN/A# modification, are permitted provided that the following conditions are 107733SN/A# met: redistributions of source code must retain the above copyright 117733SN/A# notice, this list of conditions and the following disclaimer; 127733SN/A# redistributions in binary form must reproduce the above copyright 137733SN/A# notice, this list of conditions and the following disclaimer in the 142391SN/A# documentation and/or other materials provided with the distribution; 152391SN/A# neither the name of the copyright holders nor the names of its 162391SN/A# contributors may be used to endorse or promote products derived from 172391SN/A# this software without specific prior written permission. 182391SN/A# 192391SN/A# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 202391SN/A# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 212391SN/A# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 222391SN/A# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 232391SN/A# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 242391SN/A# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 252391SN/A# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 262391SN/A# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 272391SN/A# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 282391SN/A# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 292391SN/A# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 302391SN/A# 312391SN/A# Authors: Steve Reinhardt 322391SN/A# Nathan Binkert 332391SN/A 342391SN/A################################################### 352391SN/A# 362391SN/A# SCons top-level build description (SConstruct) file. 372391SN/A# 382391SN/A# While in this directory ('gem5'), just type 'scons' to build the default 392665SN/A# configuration (see below), or type 'scons build/<CONFIG>/<binary>' 402665SN/A# to build some other configuration (e.g., 'build/ALPHA/gem5.opt' for 412914SN/A# the optimized full-system version). 428931Sandreas.hansson@arm.com# 432391SN/A# You can build gem5 in a different directory as long as there is a 442391SN/A# 'build/<CONFIG>' somewhere along the target path. The build system 456329SN/A# expects that all configs under the same build directory are being 466658SN/A# built for the same host system. 478232SN/A# 488232SN/A# Examples: 498931Sandreas.hansson@arm.com# 503879SN/A# The following two commands are equivalent. The '-u' option tells 519053Sdam.sunwoo@arm.com# scons to search up the directory tree for this SConstruct file. 522394SN/A# % cd <path-to-src>/gem5 ; scons build/ALPHA/gem5.debug 532391SN/A# % cd <path-to-src>/gem5/build/ALPHA; scons -u gem5.debug 542391SN/A# 558931Sandreas.hansson@arm.com# The following two commands are equivalent and demonstrate building 568931Sandreas.hansson@arm.com# in a directory outside of the source tree. The '-C' option tells 579053Sdam.sunwoo@arm.com# scons to chdir to the specified directory to find this SConstruct 589053Sdam.sunwoo@arm.com# file. 592391SN/A# % cd <path-to-src>/gem5 ; scons /local/foo/build/ALPHA/gem5.debug 607730SN/A# % cd /local/foo/build/ALPHA; scons -C <path-to-src>/gem5 gem5.debug 612391SN/A# 622391SN/A# You can use 'scons -H' to print scons options. If you're in this 632391SN/A# 'gem5' directory (or use -u or -C to tell scons where to find this 649293Sandreas.hansson@arm.com# file), you can use 'scons -h' to print all the gem5-specific build 659293Sandreas.hansson@arm.com# options as well. 662391SN/A# 679293Sandreas.hansson@arm.com################################################### 682391SN/A 692391SN/A# Check for recent-enough Python and SCons versions. 708719SN/Atry: 718931Sandreas.hansson@arm.com # Really old versions of scons only take two options for the 728719SN/A # function, so check once without the revision and once with the 738719SN/A # revision, the first instance will fail for stuff other than 748719SN/A # 0.98, and the second will fail for 0.98.0 759053Sdam.sunwoo@arm.com EnsureSConsVersion(0, 98) 769053Sdam.sunwoo@arm.com EnsureSConsVersion(0, 98, 1) 778719SN/Aexcept SystemExit, e: 789053Sdam.sunwoo@arm.com print """ 798719SN/AFor more details, see: 808719SN/A http://gem5.org/Dependencies 819053Sdam.sunwoo@arm.com""" 828719SN/A raise 839053Sdam.sunwoo@arm.com 849053Sdam.sunwoo@arm.com# We ensure the python version early because we have stuff that 859053Sdam.sunwoo@arm.com# requires python 2.4 868719SN/Atry: 879053Sdam.sunwoo@arm.com EnsurePythonVersion(2, 4) 888719SN/Aexcept SystemExit, e: 898719SN/A print """ 909053Sdam.sunwoo@arm.comYou can use a non-default installation of the Python interpreter by 918719SN/Aeither (1) rearranging your PATH so that scons finds the non-default 929053Sdam.sunwoo@arm.com'python' first or (2) explicitly invoking an alternative interpreter 939053Sdam.sunwoo@arm.comon the scons script. 949053Sdam.sunwoo@arm.com 958719SN/AFor more details, see: 969053Sdam.sunwoo@arm.com http://gem5.org/wiki/index.php/Using_a_non-default_Python_installation 978719SN/A""" 988719SN/A raise 999053Sdam.sunwoo@arm.com 1008719SN/A# Global Python includes 1019053Sdam.sunwoo@arm.comimport os 1029053Sdam.sunwoo@arm.comimport re 1039053Sdam.sunwoo@arm.comimport subprocess 1048719SN/Aimport sys 1059053Sdam.sunwoo@arm.com 1068719SN/Afrom os import mkdir, environ 1078719SN/Afrom os.path import abspath, basename, dirname, expanduser, normpath 1089053Sdam.sunwoo@arm.comfrom os.path import exists, isdir, isfile 1098719SN/Afrom os.path import join as joinpath, split as splitpath 1109053Sdam.sunwoo@arm.com 1119053Sdam.sunwoo@arm.com# SCons includes 1129053Sdam.sunwoo@arm.comimport SCons 1138719SN/Aimport SCons.Node 1149053Sdam.sunwoo@arm.com 1158719SN/Aextra_python_paths = [ 1168719SN/A Dir('src/python').srcnode().abspath, # gem5 includes 1179053Sdam.sunwoo@arm.com Dir('ext/ply').srcnode().abspath, # ply is used by several files 1188719SN/A ] 1199053Sdam.sunwoo@arm.com 1209053Sdam.sunwoo@arm.comsys.path[1:1] = extra_python_paths 1219053Sdam.sunwoo@arm.com 1228719SN/Afrom m5.util import compareVersions, readCommand 1239053Sdam.sunwoo@arm.comfrom m5.util.terminal import get_termcap 1248719SN/A 1258719SN/Ahelp_texts = { 1269053Sdam.sunwoo@arm.com "options" : "", 1278719SN/A "global_vars" : "", 1289053Sdam.sunwoo@arm.com "local_vars" : "" 1299053Sdam.sunwoo@arm.com} 1309053Sdam.sunwoo@arm.com 1318719SN/AExport("help_texts") 1328719SN/A 1338719SN/A 1348719SN/A# There's a bug in scons in that (1) by default, the help texts from 1358719SN/A# AddOption() are supposed to be displayed when you type 'scons -h' 1369053Sdam.sunwoo@arm.com# and (2) you can override the help displayed by 'scons -h' using the 1378719SN/A# Help() function, but these two features are incompatible: once 1389053Sdam.sunwoo@arm.com# you've overridden the help text using Help(), there's no way to get 1399053Sdam.sunwoo@arm.com# at the help texts from AddOptions. See: 1409053Sdam.sunwoo@arm.com# http://scons.tigris.org/issues/show_bug.cgi?id=2356 1419053Sdam.sunwoo@arm.com# http://scons.tigris.org/issues/show_bug.cgi?id=2611 1428719SN/A# This hack lets us extract the help text from AddOptions and 1438719SN/A# re-inject it via Help(). Ideally someday this bug will be fixed and 1448719SN/A# we can just use AddOption directly. 1458719SN/Adef AddLocalOption(*args, **kwargs): 1468719SN/A col_width = 30 1479053Sdam.sunwoo@arm.com 1488719SN/A help = " " + ", ".join(args) 1499053Sdam.sunwoo@arm.com if "help" in kwargs: 1509053Sdam.sunwoo@arm.com length = len(help) 1519053Sdam.sunwoo@arm.com if length >= col_width: 1528719SN/A help += "\n" + " " * col_width 1538719SN/A else: 1548719SN/A help += " " * (col_width - length) 1558719SN/A help += kwargs["help"] 1568719SN/A help_texts["options"] += help + "\n" 1579053Sdam.sunwoo@arm.com 1588719SN/A AddOption(*args, **kwargs) 1599053Sdam.sunwoo@arm.com 1609053Sdam.sunwoo@arm.comAddLocalOption('--colors', dest='use_colors', action='store_true', 1619053Sdam.sunwoo@arm.com help="Add color to abbreviated scons output") 1628719SN/AAddLocalOption('--no-colors', dest='use_colors', action='store_false', 1638719SN/A help="Don't add color to abbreviated scons output") 1648719SN/AAddLocalOption('--default', dest='default', type='string', action='store', 1658719SN/A help='Override which build_opts file to use for defaults') 1668719SN/AAddLocalOption('--ignore-style', dest='ignore_style', action='store_true', 1679053Sdam.sunwoo@arm.com help='Disable style checking hooks') 1688719SN/AAddLocalOption('--no-lto', dest='no_lto', action='store_true', 1699053Sdam.sunwoo@arm.com help='Disable Link-Time Optimization for fast') 1709053Sdam.sunwoo@arm.comAddLocalOption('--update-ref', dest='update_ref', action='store_true', 1719053Sdam.sunwoo@arm.com help='Update test reference outputs') 1728719SN/AAddLocalOption('--verbose', dest='verbose', action='store_true', 1738719SN/A help='Print full tool command lines') 1748719SN/A 1758719SN/Atermcap = get_termcap(GetOption('use_colors')) 1768719SN/A 1778719SN/A######################################################################## 1789235Sandreas.hansson@arm.com# 1799098Sandreas.hansson@arm.com# Set up the main build environment. 1802408SN/A# 1818931Sandreas.hansson@arm.com######################################################################## 1822408SN/Ause_vars = set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH', 1832408SN/A 'LIBRARY_PATH', 'PATH', 'PKG_CONFIG_PATH', 'PYTHONPATH', 1843170SN/A 'RANLIB', 'SWIG' ]) 1856076SN/A 1863170SN/Ause_prefixes = [ 1878931Sandreas.hansson@arm.com "M5", # M5 configuration (e.g., path to kernels) 1883170SN/A "DISTCC_", # distcc (distributed compiler wrapper) configuration 1894626SN/A "CCACHE_", # ccache (caching compiler wrapper) configuration 1903170SN/A "CCC_", # clang static analyzer configuration 1913170SN/A ] 1923170SN/A 1933170SN/Ause_env = {} 1943170SN/Afor key,val in os.environ.iteritems(): 1953170SN/A if key in use_vars or \ 1963170SN/A any([key.startswith(prefix) for prefix in use_prefixes]): 1973170SN/A use_env[key] = val 1983170SN/A 1995714SN/Amain = Environment(ENV=use_env) 2005714SN/Amain.Decider('MD5-timestamp') 2013170SN/Amain.root = Dir(".") # The current directory (where this file lives). 2023170SN/Amain.srcdir = Dir("src") # The source directory 2033170SN/A 2043170SN/Amain_dict_keys = main.Dictionary().keys() 2053170SN/A 2063170SN/A# Check that we have a C/C++ compiler 2075714SN/Aif not ('CC' in main_dict_keys and 'CXX' in main_dict_keys): 2085714SN/A print "No C++ compiler installed (package g++ on Ubuntu and RedHat)" 2093170SN/A Exit(1) 2103170SN/A 2113170SN/A# Check that swig is present 2123170SN/Aif not 'SWIG' in main_dict_keys: 2133170SN/A print "swig is not installed (package swig on Ubuntu and RedHat)" 2143170SN/A Exit(1) 2153170SN/A 2163170SN/A# add useful python code PYTHONPATH so it can be used by subprocesses 2173170SN/A# as well 2188931Sandreas.hansson@arm.commain.AppendENVPath('PYTHONPATH', extra_python_paths) 2193170SN/A 2204626SN/A######################################################################## 2213170SN/A# 2226102SN/A# Mercurial Stuff. 2233170SN/A# 2243170SN/A# If the gem5 directory is a mercurial repository, we should do some 2253170SN/A# extra things. 2263170SN/A# 2279080Smatt.evans@arm.com######################################################################## 2283170SN/A 2299080Smatt.evans@arm.comhgdir = main.root.Dir(".hg") 2309080Smatt.evans@arm.com 2319080Smatt.evans@arm.commercurial_style_message = """ 2329080Smatt.evans@arm.comYou're missing the gem5 style hook, which automatically checks your code 2339080Smatt.evans@arm.comagainst the gem5 style rules on hg commit and qrefresh commands. This 2343170SN/Ascript will now install the hook in your .hg/hgrc file. 2353170SN/APress enter to continue, or ctrl-c to abort: """ 2369080Smatt.evans@arm.com 2379080Smatt.evans@arm.commercurial_style_hook = """ 2389080Smatt.evans@arm.com# The following lines were automatically added by gem5/SConstruct 2399080Smatt.evans@arm.com# to provide the gem5 style-checking hooks 2409080Smatt.evans@arm.com[extensions] 2415714SN/Astyle = %s/util/style.py 2425714SN/A 2439080Smatt.evans@arm.com[hooks] 2449080Smatt.evans@arm.compretxncommit.style = python:style.check_style 2453170SN/Apre-qrefresh.style = python:style.check_style 2469080Smatt.evans@arm.com# End of SConstruct additions 2479080Smatt.evans@arm.com 2489080Smatt.evans@arm.com""" % (main.root.abspath) 2499080Smatt.evans@arm.com 2503170SN/Amercurial_lib_not_found = """ 2519080Smatt.evans@arm.comMercurial libraries cannot be found, ignoring style hook. If 2529080Smatt.evans@arm.comyou are a gem5 developer, please fix this and run the style 2539080Smatt.evans@arm.comhook. It is important. 2549080Smatt.evans@arm.com""" 2559080Smatt.evans@arm.com 2569080Smatt.evans@arm.com# Check for style hook and prompt for installation if it's not there. 2579080Smatt.evans@arm.com# Skip this if --ignore-style was specified, there's no .hg dir to 2589080Smatt.evans@arm.com# install a hook in, or there's no interactive terminal to prompt. 2599080Smatt.evans@arm.comif not GetOption('ignore_style') and hgdir.exists() and sys.stdin.isatty(): 2609080Smatt.evans@arm.com style_hook = True 2619080Smatt.evans@arm.com try: 2629080Smatt.evans@arm.com from mercurial import ui 2639080Smatt.evans@arm.com ui = ui.ui() 2649080Smatt.evans@arm.com ui.readconfig(hgdir.File('hgrc').abspath) 2659080Smatt.evans@arm.com style_hook = ui.config('hooks', 'pretxncommit.style', None) and \ 2669080Smatt.evans@arm.com ui.config('hooks', 'pre-qrefresh.style', None) 2673170SN/A except ImportError: 2683170SN/A print mercurial_lib_not_found 2693170SN/A 2709080Smatt.evans@arm.com if not style_hook: 2713170SN/A print mercurial_style_message, 2723170SN/A # continue unless user does ctrl-c/ctrl-d etc. 2734626SN/A try: 2744626SN/A raw_input() 2754626SN/A except: 2764626SN/A print "Input exception, exiting scons.\n" 2774626SN/A sys.exit(1) 2786429SN/A hgrc_path = '%s/.hg/hgrc' % main.root.abspath 2796429SN/A print "Adding style hook to", hgrc_path, "\n" 2804626SN/A try: 2814626SN/A hgrc = open(hgrc_path, 'a') 2824626SN/A hgrc.write(mercurial_style_hook) 2834626SN/A hgrc.close() 2844626SN/A except: 2854626SN/A print "Error updating", hgrc_path 2864626SN/A sys.exit(1) 2874626SN/A 2884626SN/A 2894626SN/A################################################### 2904626SN/A# 2916429SN/A# Figure out which configurations to set up based on the path(s) of 2926429SN/A# the target(s). 2938077SN/A# 2944626SN/A################################################### 2954626SN/A 2964626SN/A# Find default configuration & binary. 2974626SN/ADefault(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug')) 2984626SN/A 2994626SN/A# helper function: find last occurrence of element in list 3004626SN/Adef rfind(l, elt, offs = -1): 3014626SN/A for i in range(len(l)+offs, 0, -1): 3024626SN/A if l[i] == elt: 3038931Sandreas.hansson@arm.com return i 3048931Sandreas.hansson@arm.com raise ValueError, "element not found" 3052413SN/A 3069405Sandreas.hansson@arm.com# Take a list of paths (or SCons Nodes) and return a list with all 3079405Sandreas.hansson@arm.com# paths made absolute and ~-expanded. Paths will be interpreted 3082414SN/A# relative to the launch directory unless a different root is provided 3094626SN/Adef makePathListAbsolute(path_list, root=GetLaunchDir()): 3104626SN/A return [abspath(joinpath(root, expanduser(str(p)))) 3114626SN/A for p in path_list] 3128931Sandreas.hansson@arm.com 3133175SN/A# Each target must have 'build' in the interior of the path; the 3144626SN/A# directory below this will determine the build parameters. For 3159405Sandreas.hansson@arm.com# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we 3164626SN/A# recognize that ALPHA_SE specifies the configuration because it 3174626SN/A# follow 'build' in the build path. 3188931Sandreas.hansson@arm.com 3194040SN/A# The funky assignment to "[:]" is needed to replace the list contents 3204040SN/A# in place rather than reassign the symbol to a new list, which 3214040SN/A# doesn't work (obviously!). 3224040SN/ABUILD_TARGETS[:] = makePathListAbsolute(BUILD_TARGETS) 3235477SN/A 3245477SN/A# Generate a list of the unique build roots and configs that the 3258931Sandreas.hansson@arm.com# collected targets reference. 3264040SN/Avariant_paths = [] 3274040SN/Abuild_root = None 3284040SN/Afor t in BUILD_TARGETS: 3294040SN/A path_dirs = t.split('/') 3304052SN/A try: 3314626SN/A build_top = rfind(path_dirs, 'build', -2) 3324040SN/A except: 3334040SN/A print "Error: no non-leaf 'build' dir found on target path", t 3344040SN/A Exit(1) 3354052SN/A this_build_root = joinpath('/',*path_dirs[:build_top+1]) 3364626SN/A if not build_root: 3374626SN/A build_root = this_build_root 3384040SN/A else: 3394052SN/A if this_build_root != build_root: 3404626SN/A print "Error: build targets not under same build root\n"\ 3414626SN/A " %s\n %s" % (build_root, this_build_root) 3424040SN/A Exit(1) 3434040SN/A variant_path = joinpath('/',*path_dirs[:build_top+2]) 3444040SN/A if variant_path not in variant_paths: 3454040SN/A variant_paths.append(variant_path) 3464040SN/A 3474626SN/A# Make sure build_root exists (might not if this is the first build there) 3484040SN/Aif not isdir(build_root): 3496429SN/A mkdir(build_root) 3504626SN/Amain['BUILDROOT'] = build_root 3519053Sdam.sunwoo@arm.com 3524626SN/AExport('main') 3534626SN/A 3546102SN/Amain.SConsignFile(joinpath(build_root, "sconsign")) 3554626SN/A 3564040SN/A# Default duplicate option is to use hard links, but this messes up 3575477SN/A# when you use emacs to edit a file in the target dir, as emacs moves 3585477SN/A# file to file~ then copies to file, breaking the link. Symbolic 3596429SN/A# (soft) links work better. 3609053Sdam.sunwoo@arm.commain.SetOption('duplicate', 'soft-copy') 3619053Sdam.sunwoo@arm.com 3628719SN/A# 3639053Sdam.sunwoo@arm.com# Set up global sticky variables... these are common to an entire build 3644626SN/A# tree (not specific to a particular build like ALPHA_SE) 3654626SN/A# 3665477SN/A 3675477SN/Aglobal_vars_file = joinpath(build_root, 'variables.global') 3686429SN/A 3694626SN/Aglobal_vars = Variables(global_vars_file, args=ARGUMENTS) 3709053Sdam.sunwoo@arm.com 3719053Sdam.sunwoo@arm.comglobal_vars.AddVariables( 3724626SN/A ('CC', 'C compiler', environ.get('CC', main['CC'])), 3734626SN/A ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])), 3748931Sandreas.hansson@arm.com ('SWIG', 'SWIG tool', environ.get('SWIG', main['SWIG'])), 3754040SN/A ('PROTOC', 'protoc tool', environ.get('PROTOC', 'protoc')), 3762413SN/A ('BATCH', 'Use batch pool for build and tests', False), 3772413SN/A ('BATCH_CMD', 'Batch pool submission command name', 'qdo'), 3782420SN/A ('M5_BUILD_CACHE', 'Cache built objects in this directory', False), 3794626SN/A ('EXTRAS', 'Add extra directories to the compilation', '') 3808931Sandreas.hansson@arm.com ) 3814626SN/A 3822413SN/A# Update main environment with values from ARGUMENTS & global_vars_file 3832413SN/Aglobal_vars.Update(main) 3848931Sandreas.hansson@arm.comhelp_texts["global_vars"] += global_vars.GenerateHelpText(main) 3858931Sandreas.hansson@arm.com 3868931Sandreas.hansson@arm.com# Save sticky variable settings back to current variables file 3879405Sandreas.hansson@arm.comglobal_vars.Save(global_vars_file, main) 3889405Sandreas.hansson@arm.com 3894626SN/A# Parse EXTRAS variable to build list of all directories where we're 3909405Sandreas.hansson@arm.com# look for sources etc. This list is exported as extras_dir_list. 3914626SN/Abase_dir = main.srcdir.abspath 3925314SN/Aif main['EXTRAS']: 3935477SN/A extras_dir_list = makePathListAbsolute(main['EXTRAS'].split(':')) 3945477SN/Aelse: 3954626SN/A extras_dir_list = [] 3968931Sandreas.hansson@arm.com 3975314SN/AExport('base_dir') 3985477SN/AExport('extras_dir_list') 3995477SN/A 4004626SN/A# the ext directory should be on the #includes path 4018931Sandreas.hansson@arm.commain.Append(CPPPATH=[Dir('ext')]) 4025314SN/A 4035315SN/Adef strip_build_path(path, env): 4045315SN/A path = str(path) 4058992SAli.Saidi@ARM.com variant_base = env['BUILDROOT'] + os.path.sep 4065315SN/A if path.startswith(variant_base): 4075315SN/A path = path[len(variant_base):] 4085314SN/A elif path.startswith('build/'): 4095315SN/A path = path[6:] 4105314SN/A return path 4114626SN/A 4128931Sandreas.hansson@arm.com# Generate a string of the form: 4134626SN/A# common/path/prefix/src1, src2 -> tgt1, tgt2 4144626SN/A# to print while building. 4154490SN/Aclass Transform(object): 416 # all specific color settings should be here and nowhere else 417 tool_color = termcap.Normal 418 pfx_color = termcap.Yellow 419 srcs_color = termcap.Yellow + termcap.Bold 420 arrow_color = termcap.Blue + termcap.Bold 421 tgts_color = termcap.Yellow + termcap.Bold 422 423 def __init__(self, tool, max_sources=99): 424 self.format = self.tool_color + (" [%8s] " % tool) \ 425 + self.pfx_color + "%s" \ 426 + self.srcs_color + "%s" \ 427 + self.arrow_color + " -> " \ 428 + self.tgts_color + "%s" \ 429 + termcap.Normal 430 self.max_sources = max_sources 431 432 def __call__(self, target, source, env, for_signature=None): 433 # truncate source list according to max_sources param 434 source = source[0:self.max_sources] 435 def strip(f): 436 return strip_build_path(str(f), env) 437 if len(source) > 0: 438 srcs = map(strip, source) 439 else: 440 srcs = [''] 441 tgts = map(strip, target) 442 # surprisingly, os.path.commonprefix is a dumb char-by-char string 443 # operation that has nothing to do with paths. 444 com_pfx = os.path.commonprefix(srcs + tgts) 445 com_pfx_len = len(com_pfx) 446 if com_pfx: 447 # do some cleanup and sanity checking on common prefix 448 if com_pfx[-1] == ".": 449 # prefix matches all but file extension: ok 450 # back up one to change 'foo.cc -> o' to 'foo.cc -> .o' 451 com_pfx = com_pfx[0:-1] 452 elif com_pfx[-1] == "/": 453 # common prefix is directory path: OK 454 pass 455 else: 456 src0_len = len(srcs[0]) 457 tgt0_len = len(tgts[0]) 458 if src0_len == com_pfx_len: 459 # source is a substring of target, OK 460 pass 461 elif tgt0_len == com_pfx_len: 462 # target is a substring of source, need to back up to 463 # avoid empty string on RHS of arrow 464 sep_idx = com_pfx.rfind(".") 465 if sep_idx != -1: 466 com_pfx = com_pfx[0:sep_idx] 467 else: 468 com_pfx = '' 469 elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".": 470 # still splitting at file extension: ok 471 pass 472 else: 473 # probably a fluke; ignore it 474 com_pfx = '' 475 # recalculate length in case com_pfx was modified 476 com_pfx_len = len(com_pfx) 477 def fmt(files): 478 f = map(lambda s: s[com_pfx_len:], files) 479 return ', '.join(f) 480 return self.format % (com_pfx, fmt(srcs), fmt(tgts)) 481 482Export('Transform') 483 484# enable the regression script to use the termcap 485main['TERMCAP'] = termcap 486 487if GetOption('verbose'): 488 def MakeAction(action, string, *args, **kwargs): 489 return Action(action, *args, **kwargs) 490else: 491 MakeAction = Action 492 main['CCCOMSTR'] = Transform("CC") 493 main['CXXCOMSTR'] = Transform("CXX") 494 main['ASCOMSTR'] = Transform("AS") 495 main['SWIGCOMSTR'] = Transform("SWIG") 496 main['ARCOMSTR'] = Transform("AR", 0) 497 main['LINKCOMSTR'] = Transform("LINK", 0) 498 main['RANLIBCOMSTR'] = Transform("RANLIB", 0) 499 main['M4COMSTR'] = Transform("M4") 500 main['SHCCCOMSTR'] = Transform("SHCC") 501 main['SHCXXCOMSTR'] = Transform("SHCXX") 502Export('MakeAction') 503 504# Initialize the Link-Time Optimization (LTO) flags 505main['LTO_CCFLAGS'] = [] 506main['LTO_LDFLAGS'] = [] 507 508CXX_version = readCommand([main['CXX'],'--version'], exception=False) 509CXX_V = readCommand([main['CXX'],'-V'], exception=False) 510 511main['GCC'] = CXX_version and CXX_version.find('g++') >= 0 512main['CLANG'] = CXX_version and CXX_version.find('clang') >= 0 513if main['GCC'] + main['CLANG'] > 1: 514 print 'Error: How can we have two at the same time?' 515 Exit(1) 516 517# Set up default C++ compiler flags 518if main['GCC']: 519 # Check for a supported version of gcc, >= 4.4 is needed for c++0x 520 # support. See http://gcc.gnu.org/projects/cxx0x.html for details 521 gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False) 522 if compareVersions(gcc_version, "4.4") < 0: 523 print 'Error: gcc version 4.4 or newer required.' 524 print ' Installed version:', gcc_version 525 Exit(1) 526 527 main['GCC_VERSION'] = gcc_version 528 main.Append(CCFLAGS=['-pipe']) 529 main.Append(CCFLAGS=['-fno-strict-aliasing']) 530 main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef']) 531 main.Append(CXXFLAGS=['-std=c++0x']) 532 533 # Check for versions with bugs 534 if not compareVersions(gcc_version, '4.4.1') or \ 535 not compareVersions(gcc_version, '4.4.2'): 536 print 'Info: Tree vectorizer in GCC 4.4.1 & 4.4.2 is buggy, disabling.' 537 main.Append(CCFLAGS=['-fno-tree-vectorize']) 538 539 # LTO support is only really working properly from 4.6 and beyond 540 if compareVersions(gcc_version, '4.6') >= 0: 541 # Add the appropriate Link-Time Optimization (LTO) flags 542 # unless LTO is explicitly turned off. Note that these flags 543 # are only used by the fast target. 544 if not GetOption('no_lto'): 545 # Pass the LTO flag when compiling to produce GIMPLE 546 # output, we merely create the flags here and only append 547 # them later/ 548 main['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')] 549 550 # Use the same amount of jobs for LTO as we are running 551 # scons with, we hardcode the use of the linker plugin 552 # which requires either gold or GNU ld >= 2.21 553 main['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs'), 554 '-fuse-linker-plugin'] 555 556elif main['CLANG']: 557 # Check for a supported version of clang, >= 2.9 is needed to 558 # support similar features as gcc 4.4. See 559 # http://clang.llvm.org/cxx_status.html for details 560 clang_version_re = re.compile(".* version (\d+\.\d+)") 561 clang_version_match = clang_version_re.match(CXX_version) 562 if (clang_version_match): 563 clang_version = clang_version_match.groups()[0] 564 if compareVersions(clang_version, "2.9") < 0: 565 print 'Error: clang version 2.9 or newer required.' 566 print ' Installed version:', clang_version 567 Exit(1) 568 else: 569 print 'Error: Unable to determine clang version.' 570 Exit(1) 571 572 main.Append(CCFLAGS=['-pipe']) 573 main.Append(CCFLAGS=['-fno-strict-aliasing']) 574 main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef']) 575 main.Append(CCFLAGS=['-Wno-tautological-compare']) 576 main.Append(CCFLAGS=['-Wno-self-assign']) 577 # Ruby makes frequent use of extraneous parantheses in the printing 578 # of if-statements 579 main.Append(CCFLAGS=['-Wno-parentheses']) 580 main.Append(CXXFLAGS=['-std=c++0x']) 581 # On Mac OS X/Darwin we need to also use libc++ (part of XCode) as 582 # opposed to libstdc++ to make the transition from TR1 to 583 # C++11. See http://libcxx.llvm.org. However, clang has chosen a 584 # strict implementation of the C++11 standard, and does not allow 585 # incomplete types in template arguments (besides unique_ptr and 586 # shared_ptr), and the libc++ STL containers create problems in 587 # combination with the current gem5 code. For now, we stick with 588 # libstdc++ and use the TR1 namespace. 589 # if sys.platform == "darwin": 590 # main.Append(CXXFLAGS=['-stdlib=libc++']) 591 592else: 593 print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal, 594 print "Don't know what compiler options to use for your compiler." 595 print termcap.Yellow + ' compiler:' + termcap.Normal, main['CXX'] 596 print termcap.Yellow + ' version:' + termcap.Normal, 597 if not CXX_version: 598 print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\ 599 termcap.Normal 600 else: 601 print CXX_version.replace('\n', '<nl>') 602 print " If you're trying to use a compiler other than GCC" 603 print " or clang, there appears to be something wrong with your" 604 print " environment." 605 print " " 606 print " If you are trying to use a compiler other than those listed" 607 print " above you will need to ease fix SConstruct and " 608 print " src/SConscript to support that compiler." 609 Exit(1) 610 611# Set up common yacc/bison flags (needed for Ruby) 612main['YACCFLAGS'] = '-d' 613main['YACCHXXFILESUFFIX'] = '.hh' 614 615# Do this after we save setting back, or else we'll tack on an 616# extra 'qdo' every time we run scons. 617if main['BATCH']: 618 main['CC'] = main['BATCH_CMD'] + ' ' + main['CC'] 619 main['CXX'] = main['BATCH_CMD'] + ' ' + main['CXX'] 620 main['AS'] = main['BATCH_CMD'] + ' ' + main['AS'] 621 main['AR'] = main['BATCH_CMD'] + ' ' + main['AR'] 622 main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB'] 623 624if sys.platform == 'cygwin': 625 # cygwin has some header file issues... 626 main.Append(CCFLAGS=["-Wno-uninitialized"]) 627 628# Check for the protobuf compiler 629protoc_version = readCommand([main['PROTOC'], '--version'], 630 exception='').split() 631 632# First two words should be "libprotoc x.y.z" 633if len(protoc_version) < 2 or protoc_version[0] != 'libprotoc': 634 print termcap.Yellow + termcap.Bold + \ 635 'Warning: Protocol buffer compiler (protoc) not found.\n' + \ 636 ' Please install protobuf-compiler for tracing support.' + \ 637 termcap.Normal 638 main['PROTOC'] = False 639else: 640 # Based on the availability of the compress stream wrappers, 641 # require 2.1.0 642 min_protoc_version = '2.1.0' 643 if compareVersions(protoc_version[1], min_protoc_version) < 0: 644 print termcap.Yellow + termcap.Bold + \ 645 'Warning: protoc version', min_protoc_version, \ 646 'or newer required.\n' + \ 647 ' Installed version:', protoc_version[1], \ 648 termcap.Normal 649 main['PROTOC'] = False 650 else: 651 # Attempt to determine the appropriate include path and 652 # library path using pkg-config, that means we also need to 653 # check for pkg-config. Note that it is possible to use 654 # protobuf without the involvement of pkg-config. Later on we 655 # check go a library config check and at that point the test 656 # will fail if libprotobuf cannot be found. 657 if readCommand(['pkg-config', '--version'], exception=''): 658 try: 659 # Attempt to establish what linking flags to add for protobuf 660 # using pkg-config 661 main.ParseConfig('pkg-config --cflags --libs-only-L protobuf') 662 except: 663 print termcap.Yellow + termcap.Bold + \ 664 'Warning: pkg-config could not get protobuf flags.' + \ 665 termcap.Normal 666 667# Check for SWIG 668if not main.has_key('SWIG'): 669 print 'Error: SWIG utility not found.' 670 print ' Please install (see http://www.swig.org) and retry.' 671 Exit(1) 672 673# Check for appropriate SWIG version 674swig_version = readCommand([main['SWIG'], '-version'], exception='').split() 675# First 3 words should be "SWIG Version x.y.z" 676if len(swig_version) < 3 or \ 677 swig_version[0] != 'SWIG' or swig_version[1] != 'Version': 678 print 'Error determining SWIG version.' 679 Exit(1) 680 681min_swig_version = '1.3.34' 682if compareVersions(swig_version[2], min_swig_version) < 0: 683 print 'Error: SWIG version', min_swig_version, 'or newer required.' 684 print ' Installed version:', swig_version[2] 685 Exit(1) 686 687# Set up SWIG flags & scanner 688swig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS') 689main.Append(SWIGFLAGS=swig_flags) 690 691# filter out all existing swig scanners, they mess up the dependency 692# stuff for some reason 693scanners = [] 694for scanner in main['SCANNERS']: 695 skeys = scanner.skeys 696 if skeys == '.i': 697 continue 698 699 if isinstance(skeys, (list, tuple)) and '.i' in skeys: 700 continue 701 702 scanners.append(scanner) 703 704# add the new swig scanner that we like better 705from SCons.Scanner import ClassicCPP as CPPScanner 706swig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")' 707scanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re)) 708 709# replace the scanners list that has what we want 710main['SCANNERS'] = scanners 711 712# Add a custom Check function to the Configure context so that we can 713# figure out if the compiler adds leading underscores to global 714# variables. This is needed for the autogenerated asm files that we 715# use for embedding the python code. 716def CheckLeading(context): 717 context.Message("Checking for leading underscore in global variables...") 718 # 1) Define a global variable called x from asm so the C compiler 719 # won't change the symbol at all. 720 # 2) Declare that variable. 721 # 3) Use the variable 722 # 723 # If the compiler prepends an underscore, this will successfully 724 # link because the external symbol 'x' will be called '_x' which 725 # was defined by the asm statement. If the compiler does not 726 # prepend an underscore, this will not successfully link because 727 # '_x' will have been defined by assembly, while the C portion of 728 # the code will be trying to use 'x' 729 ret = context.TryLink(''' 730 asm(".globl _x; _x: .byte 0"); 731 extern int x; 732 int main() { return x; } 733 ''', extension=".c") 734 context.env.Append(LEADING_UNDERSCORE=ret) 735 context.Result(ret) 736 return ret 737 738# Platform-specific configuration. Note again that we assume that all 739# builds under a given build root run on the same host platform. 740conf = Configure(main, 741 conf_dir = joinpath(build_root, '.scons_config'), 742 log_file = joinpath(build_root, 'scons_config.log'), 743 custom_tests = { 'CheckLeading' : CheckLeading }) 744 745# Check for leading underscores. Don't really need to worry either 746# way so don't need to check the return code. 747conf.CheckLeading() 748 749# Check if we should compile a 64 bit binary on Mac OS X/Darwin 750try: 751 import platform 752 uname = platform.uname() 753 if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0: 754 if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]): 755 main.Append(CCFLAGS=['-arch', 'x86_64']) 756 main.Append(CFLAGS=['-arch', 'x86_64']) 757 main.Append(LINKFLAGS=['-arch', 'x86_64']) 758 main.Append(ASFLAGS=['-arch', 'x86_64']) 759except: 760 pass 761 762# Recent versions of scons substitute a "Null" object for Configure() 763# when configuration isn't necessary, e.g., if the "--help" option is 764# present. Unfortuantely this Null object always returns false, 765# breaking all our configuration checks. We replace it with our own 766# more optimistic null object that returns True instead. 767if not conf: 768 def NullCheck(*args, **kwargs): 769 return True 770 771 class NullConf: 772 def __init__(self, env): 773 self.env = env 774 def Finish(self): 775 return self.env 776 def __getattr__(self, mname): 777 return NullCheck 778 779 conf = NullConf(main) 780 781# Find Python include and library directories for embedding the 782# interpreter. For consistency, we will use the same Python 783# installation used to run scons (and thus this script). If you want 784# to link in an alternate version, see above for instructions on how 785# to invoke scons with a different copy of the Python interpreter. 786from distutils import sysconfig 787 788py_getvar = sysconfig.get_config_var 789 790py_debug = getattr(sys, 'pydebug', False) 791py_version = 'python' + py_getvar('VERSION') + (py_debug and "_d" or "") 792 793py_general_include = sysconfig.get_python_inc() 794py_platform_include = sysconfig.get_python_inc(plat_specific=True) 795py_includes = [ py_general_include ] 796if py_platform_include != py_general_include: 797 py_includes.append(py_platform_include) 798 799py_lib_path = [ py_getvar('LIBDIR') ] 800# add the prefix/lib/pythonX.Y/config dir, but only if there is no 801# shared library in prefix/lib/. 802if not py_getvar('Py_ENABLE_SHARED'): 803 py_lib_path.append(py_getvar('LIBPL')) 804 805py_libs = [] 806for lib in py_getvar('LIBS').split() + py_getvar('SYSLIBS').split(): 807 if not lib.startswith('-l'): 808 # Python requires some special flags to link (e.g. -framework 809 # common on OS X systems), assume appending preserves order 810 main.Append(LINKFLAGS=[lib]) 811 else: 812 lib = lib[2:] 813 if lib not in py_libs: 814 py_libs.append(lib) 815py_libs.append(py_version) 816 817main.Append(CPPPATH=py_includes) 818main.Append(LIBPATH=py_lib_path) 819 820# Cache build files in the supplied directory. 821if main['M5_BUILD_CACHE']: 822 print 'Using build cache located at', main['M5_BUILD_CACHE'] 823 CacheDir(main['M5_BUILD_CACHE']) 824 825 826# verify that this stuff works 827if not conf.CheckHeader('Python.h', '<>'): 828 print "Error: can't find Python.h header in", py_includes 829 print "Install Python headers (package python-dev on Ubuntu and RedHat)" 830 Exit(1) 831 832for lib in py_libs: 833 if not conf.CheckLib(lib): 834 print "Error: can't find library %s required by python" % lib 835 Exit(1) 836 837# On Solaris you need to use libsocket for socket ops 838if not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'): 839 if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'): 840 print "Can't find library with socket calls (e.g. accept())" 841 Exit(1) 842 843# Check for zlib. If the check passes, libz will be automatically 844# added to the LIBS environment variable. 845if not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'): 846 print 'Error: did not find needed zlib compression library '\ 847 'and/or zlib.h header file.' 848 print ' Please install zlib and try again.' 849 Exit(1) 850 851# If we have the protobuf compiler, also make sure we have the 852# development libraries. If the check passes, libprotobuf will be 853# automatically added to the LIBS environment variable. After 854# this, we can use the HAVE_PROTOBUF flag to determine if we have 855# got both protoc and libprotobuf available. 856main['HAVE_PROTOBUF'] = main['PROTOC'] and \ 857 conf.CheckLibWithHeader('protobuf', 'google/protobuf/message.h', 858 'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;') 859 860# If we have the compiler but not the library, print another warning. 861if main['PROTOC'] and not main['HAVE_PROTOBUF']: 862 print termcap.Yellow + termcap.Bold + \ 863 'Warning: did not find protocol buffer library and/or headers.\n' + \ 864 ' Please install libprotobuf-dev for tracing support.' + \ 865 termcap.Normal 866 867# Check for librt. 868have_posix_clock = \ 869 conf.CheckLibWithHeader(None, 'time.h', 'C', 870 'clock_nanosleep(0,0,NULL,NULL);') or \ 871 conf.CheckLibWithHeader('rt', 'time.h', 'C', 872 'clock_nanosleep(0,0,NULL,NULL);') 873 874if conf.CheckLib('tcmalloc_minimal'): 875 have_tcmalloc = True 876else: 877 have_tcmalloc = False 878 print termcap.Yellow + termcap.Bold + \ 879 "You can get a 12% performance improvement by installing tcmalloc "\ 880 "(libgoogle-perftools-dev package on Ubuntu or RedHat)." + \ 881 termcap.Normal 882 883if not have_posix_clock: 884 print "Can't find library for POSIX clocks." 885 886# Check for <fenv.h> (C99 FP environment control) 887have_fenv = conf.CheckHeader('fenv.h', '<>') 888if not have_fenv: 889 print "Warning: Header file <fenv.h> not found." 890 print " This host has no IEEE FP rounding mode control." 891 892###################################################################### 893# 894# Finish the configuration 895# 896main = conf.Finish() 897 898###################################################################### 899# 900# Collect all non-global variables 901# 902 903# Define the universe of supported ISAs 904all_isa_list = [ ] 905Export('all_isa_list') 906 907class CpuModel(object): 908 '''The CpuModel class encapsulates everything the ISA parser needs to 909 know about a particular CPU model.''' 910 911 # Dict of available CPU model objects. Accessible as CpuModel.dict. 912 dict = {} 913 list = [] 914 defaults = [] 915 916 # Constructor. Automatically adds models to CpuModel.dict. 917 def __init__(self, name, filename, includes, strings, default=False): 918 self.name = name # name of model 919 self.filename = filename # filename for output exec code 920 self.includes = includes # include files needed in exec file 921 # The 'strings' dict holds all the per-CPU symbols we can 922 # substitute into templates etc. 923 self.strings = strings 924 925 # This cpu is enabled by default 926 self.default = default 927 928 # Add self to dict 929 if name in CpuModel.dict: 930 raise AttributeError, "CpuModel '%s' already registered" % name 931 CpuModel.dict[name] = self 932 CpuModel.list.append(name) 933 934Export('CpuModel') 935 936# Sticky variables get saved in the variables file so they persist from 937# one invocation to the next (unless overridden, in which case the new 938# value becomes sticky). 939sticky_vars = Variables(args=ARGUMENTS) 940Export('sticky_vars') 941 942# Sticky variables that should be exported 943export_vars = [] 944Export('export_vars') 945 946# For Ruby 947all_protocols = [] 948Export('all_protocols') 949protocol_dirs = [] 950Export('protocol_dirs') 951slicc_includes = [] 952Export('slicc_includes') 953 954# Walk the tree and execute all SConsopts scripts that wil add to the 955# above variables 956if not GetOption('verbose'): 957 print "Reading SConsopts" 958for bdir in [ base_dir ] + extras_dir_list: 959 if not isdir(bdir): 960 print "Error: directory '%s' does not exist" % bdir 961 Exit(1) 962 for root, dirs, files in os.walk(bdir): 963 if 'SConsopts' in files: 964 if GetOption('verbose'): 965 print "Reading", joinpath(root, 'SConsopts') 966 SConscript(joinpath(root, 'SConsopts')) 967 968all_isa_list.sort() 969 970sticky_vars.AddVariables( 971 EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list), 972 ListVariable('CPU_MODELS', 'CPU models', 973 sorted(n for n,m in CpuModel.dict.iteritems() if m.default), 974 sorted(CpuModel.list)), 975 BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger', 976 False), 977 BoolVariable('SS_COMPATIBLE_FP', 978 'Make floating-point results compatible with SimpleScalar', 979 False), 980 BoolVariable('USE_SSE2', 981 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts', 982 False), 983 BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock), 984 BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv), 985 BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False), 986 EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None', 987 all_protocols), 988 ) 989 990# These variables get exported to #defines in config/*.hh (see src/SConscript). 991export_vars += ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'CP_ANNOTATE', 992 'USE_POSIX_CLOCK', 'PROTOCOL', 'HAVE_PROTOBUF'] 993 994################################################### 995# 996# Define a SCons builder for configuration flag headers. 997# 998################################################### 999 1000# This function generates a config header file that #defines the 1001# variable symbol to the current variable setting (0 or 1). The source 1002# operands are the name of the variable and a Value node containing the 1003# value of the variable. 1004def build_config_file(target, source, env): 1005 (variable, value) = [s.get_contents() for s in source] 1006 f = file(str(target[0]), 'w') 1007 print >> f, '#define', variable, value 1008 f.close() 1009 return None 1010 1011# Combine the two functions into a scons Action object. 1012config_action = MakeAction(build_config_file, Transform("CONFIG H", 2)) 1013 1014# The emitter munges the source & target node lists to reflect what 1015# we're really doing. 1016def config_emitter(target, source, env): 1017 # extract variable name from Builder arg 1018 variable = str(target[0]) 1019 # True target is config header file 1020 target = joinpath('config', variable.lower() + '.hh') 1021 val = env[variable] 1022 if isinstance(val, bool): 1023 # Force value to 0/1 1024 val = int(val) 1025 elif isinstance(val, str): 1026 val = '"' + val + '"' 1027 1028 # Sources are variable name & value (packaged in SCons Value nodes) 1029 return ([target], [Value(variable), Value(val)]) 1030 1031config_builder = Builder(emitter = config_emitter, action = config_action) 1032 1033main.Append(BUILDERS = { 'ConfigFile' : config_builder }) 1034 1035# libelf build is shared across all configs in the build root. 1036main.SConscript('ext/libelf/SConscript', 1037 variant_dir = joinpath(build_root, 'libelf')) 1038 1039# gzstream build is shared across all configs in the build root. 1040main.SConscript('ext/gzstream/SConscript', 1041 variant_dir = joinpath(build_root, 'gzstream')) 1042 1043################################################### 1044# 1045# This function is used to set up a directory with switching headers 1046# 1047################################################### 1048 1049main['ALL_ISA_LIST'] = all_isa_list 1050def make_switching_dir(dname, switch_headers, env): 1051 # Generate the header. target[0] is the full path of the output 1052 # header to generate. 'source' is a dummy variable, since we get the 1053 # list of ISAs from env['ALL_ISA_LIST']. 1054 def gen_switch_hdr(target, source, env): 1055 fname = str(target[0]) 1056 f = open(fname, 'w') 1057 isa = env['TARGET_ISA'].lower() 1058 print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname)) 1059 f.close() 1060 1061 # Build SCons Action object. 'varlist' specifies env vars that this 1062 # action depends on; when env['ALL_ISA_LIST'] changes these actions 1063 # should get re-executed. 1064 switch_hdr_action = MakeAction(gen_switch_hdr, 1065 Transform("GENERATE"), varlist=['ALL_ISA_LIST']) 1066 1067 # Instantiate actions for each header 1068 for hdr in switch_headers: 1069 env.Command(hdr, [], switch_hdr_action) 1070Export('make_switching_dir') 1071 1072################################################### 1073# 1074# Define build environments for selected configurations. 1075# 1076################################################### 1077 1078for variant_path in variant_paths: 1079 print "Building in", variant_path 1080 1081 # Make a copy of the build-root environment to use for this config. 1082 env = main.Clone() 1083 env['BUILDDIR'] = variant_path 1084 1085 # variant_dir is the tail component of build path, and is used to 1086 # determine the build parameters (e.g., 'ALPHA_SE') 1087 (build_root, variant_dir) = splitpath(variant_path) 1088 1089 # Set env variables according to the build directory config. 1090 sticky_vars.files = [] 1091 # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in 1092 # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke 1093 # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings. 1094 current_vars_file = joinpath(build_root, 'variables', variant_dir) 1095 if isfile(current_vars_file): 1096 sticky_vars.files.append(current_vars_file) 1097 print "Using saved variables file %s" % current_vars_file 1098 else: 1099 # Build dir-specific variables file doesn't exist. 1100 1101 # Make sure the directory is there so we can create it later 1102 opt_dir = dirname(current_vars_file) 1103 if not isdir(opt_dir): 1104 mkdir(opt_dir) 1105 1106 # Get default build variables from source tree. Variables are 1107 # normally determined by name of $VARIANT_DIR, but can be 1108 # overridden by '--default=' arg on command line. 1109 default = GetOption('default') 1110 opts_dir = joinpath(main.root.abspath, 'build_opts') 1111 if default: 1112 default_vars_files = [joinpath(build_root, 'variables', default), 1113 joinpath(opts_dir, default)] 1114 else: 1115 default_vars_files = [joinpath(opts_dir, variant_dir)] 1116 existing_files = filter(isfile, default_vars_files) 1117 if existing_files: 1118 default_vars_file = existing_files[0] 1119 sticky_vars.files.append(default_vars_file) 1120 print "Variables file %s not found,\n using defaults in %s" \ 1121 % (current_vars_file, default_vars_file) 1122 else: 1123 print "Error: cannot find variables file %s or " \ 1124 "default file(s) %s" \ 1125 % (current_vars_file, ' or '.join(default_vars_files)) 1126 Exit(1) 1127 1128 # Apply current variable settings to env 1129 sticky_vars.Update(env) 1130 1131 help_texts["local_vars"] += \ 1132 "Build variables for %s:\n" % variant_dir \ 1133 + sticky_vars.GenerateHelpText(env) 1134 1135 # Process variable settings. 1136 1137 if not have_fenv and env['USE_FENV']: 1138 print "Warning: <fenv.h> not available; " \ 1139 "forcing USE_FENV to False in", variant_dir + "." 1140 env['USE_FENV'] = False 1141 1142 if not env['USE_FENV']: 1143 print "Warning: No IEEE FP rounding mode control in", variant_dir + "." 1144 print " FP results may deviate slightly from other platforms." 1145 1146 if env['EFENCE']: 1147 env.Append(LIBS=['efence']) 1148 1149 # Save sticky variable settings back to current variables file 1150 sticky_vars.Save(current_vars_file, env) 1151 1152 if env['USE_SSE2']: 1153 env.Append(CCFLAGS=['-msse2']) 1154 1155 if have_tcmalloc: 1156 env.Append(LIBS=['tcmalloc_minimal']) 1157 1158 # The src/SConscript file sets up the build rules in 'env' according 1159 # to the configured variables. It returns a list of environments, 1160 # one for each variant build (debug, opt, etc.) 1161 envList = SConscript('src/SConscript', variant_dir = variant_path, 1162 exports = 'env') 1163 1164 # Set up the regression tests for each build. 1165 for e in envList: 1166 SConscript('tests/SConscript', 1167 variant_dir = joinpath(variant_path, 'tests', e.Label), 1168 exports = { 'env' : e }, duplicate = False) 1169 1170# base help text 1171Help(''' 1172Usage: scons [scons options] [build variables] [target(s)] 1173 1174Extra scons options: 1175%(options)s 1176 1177Global build variables: 1178%(global_vars)s 1179 1180%(local_vars)s 1181''' % help_texts) 1182