SConstruct revision 9416
1955SN/A# -*- mode:python -*- 2955SN/A 37816Ssteve.reinhardt@amd.com# Copyright (c) 2011 Advanced Micro Devices, Inc. 45871Snate@binkert.org# Copyright (c) 2009 The Hewlett-Packard Development Company 51762SN/A# Copyright (c) 2004-2005 The Regents of The University of Michigan 6955SN/A# All rights reserved. 7955SN/A# 8955SN/A# Redistribution and use in source and binary forms, with or without 9955SN/A# modification, are permitted provided that the following conditions are 10955SN/A# met: redistributions of source code must retain the above copyright 11955SN/A# notice, this list of conditions and the following disclaimer; 12955SN/A# redistributions in binary form must reproduce the above copyright 13955SN/A# notice, this list of conditions and the following disclaimer in the 14955SN/A# documentation and/or other materials provided with the distribution; 15955SN/A# neither the name of the copyright holders nor the names of its 16955SN/A# contributors may be used to endorse or promote products derived from 17955SN/A# this software without specific prior written permission. 18955SN/A# 19955SN/A# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20955SN/A# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21955SN/A# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 22955SN/A# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 23955SN/A# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 24955SN/A# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 25955SN/A# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26955SN/A# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27955SN/A# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28955SN/A# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 29955SN/A# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 302665Ssaidi@eecs.umich.edu# 312665Ssaidi@eecs.umich.edu# Authors: Steve Reinhardt 325863Snate@binkert.org# Nathan Binkert 33955SN/A 34955SN/A################################################### 35955SN/A# 36955SN/A# SCons top-level build description (SConstruct) file. 37955SN/A# 388878Ssteve.reinhardt@amd.com# While in this directory ('gem5'), just type 'scons' to build the default 392632Sstever@eecs.umich.edu# configuration (see below), or type 'scons build/<CONFIG>/<binary>' 408878Ssteve.reinhardt@amd.com# to build some other configuration (e.g., 'build/ALPHA/gem5.opt' for 412632Sstever@eecs.umich.edu# the optimized full-system version). 42955SN/A# 438878Ssteve.reinhardt@amd.com# You can build gem5 in a different directory as long as there is a 442632Sstever@eecs.umich.edu# 'build/<CONFIG>' somewhere along the target path. The build system 452761Sstever@eecs.umich.edu# expects that all configs under the same build directory are being 462632Sstever@eecs.umich.edu# built for the same host system. 472632Sstever@eecs.umich.edu# 482632Sstever@eecs.umich.edu# Examples: 492761Sstever@eecs.umich.edu# 502761Sstever@eecs.umich.edu# The following two commands are equivalent. The '-u' option tells 512761Sstever@eecs.umich.edu# scons to search up the directory tree for this SConstruct file. 528878Ssteve.reinhardt@amd.com# % cd <path-to-src>/gem5 ; scons build/ALPHA/gem5.debug 538878Ssteve.reinhardt@amd.com# % cd <path-to-src>/gem5/build/ALPHA; scons -u gem5.debug 542761Sstever@eecs.umich.edu# 552761Sstever@eecs.umich.edu# The following two commands are equivalent and demonstrate building 562761Sstever@eecs.umich.edu# in a directory outside of the source tree. The '-C' option tells 572761Sstever@eecs.umich.edu# scons to chdir to the specified directory to find this SConstruct 582761Sstever@eecs.umich.edu# file. 598878Ssteve.reinhardt@amd.com# % cd <path-to-src>/gem5 ; scons /local/foo/build/ALPHA/gem5.debug 608878Ssteve.reinhardt@amd.com# % cd /local/foo/build/ALPHA; scons -C <path-to-src>/gem5 gem5.debug 612632Sstever@eecs.umich.edu# 622632Sstever@eecs.umich.edu# You can use 'scons -H' to print scons options. If you're in this 638878Ssteve.reinhardt@amd.com# 'gem5' directory (or use -u or -C to tell scons where to find this 648878Ssteve.reinhardt@amd.com# file), you can use 'scons -h' to print all the gem5-specific build 652632Sstever@eecs.umich.edu# options as well. 66955SN/A# 67955SN/A################################################### 68955SN/A 695863Snate@binkert.org# Check for recent-enough Python and SCons versions. 705863Snate@binkert.orgtry: 715863Snate@binkert.org # Really old versions of scons only take two options for the 725863Snate@binkert.org # function, so check once without the revision and once with the 735863Snate@binkert.org # revision, the first instance will fail for stuff other than 745863Snate@binkert.org # 0.98, and the second will fail for 0.98.0 755863Snate@binkert.org EnsureSConsVersion(0, 98) 765863Snate@binkert.org EnsureSConsVersion(0, 98, 1) 775863Snate@binkert.orgexcept SystemExit, e: 785863Snate@binkert.org print """ 795863Snate@binkert.orgFor more details, see: 808878Ssteve.reinhardt@amd.com http://gem5.org/Dependencies 815863Snate@binkert.org""" 825863Snate@binkert.org raise 835863Snate@binkert.org 845863Snate@binkert.org# We ensure the python version early because we have stuff that 855863Snate@binkert.org# requires python 2.4 865863Snate@binkert.orgtry: 875863Snate@binkert.org EnsurePythonVersion(2, 4) 885863Snate@binkert.orgexcept SystemExit, e: 895863Snate@binkert.org print """ 905863Snate@binkert.orgYou can use a non-default installation of the Python interpreter by 915863Snate@binkert.orgeither (1) rearranging your PATH so that scons finds the non-default 925863Snate@binkert.org'python' first or (2) explicitly invoking an alternative interpreter 935863Snate@binkert.orgon the scons script. 945863Snate@binkert.org 955863Snate@binkert.orgFor more details, see: 968878Ssteve.reinhardt@amd.com http://gem5.org/wiki/index.php/Using_a_non-default_Python_installation 975863Snate@binkert.org""" 985863Snate@binkert.org raise 995863Snate@binkert.org 1006654Snate@binkert.org# Global Python includes 101955SN/Aimport os 1025396Ssaidi@eecs.umich.eduimport re 1035863Snate@binkert.orgimport subprocess 1045863Snate@binkert.orgimport sys 1054202Sbinkertn@umich.edu 1065863Snate@binkert.orgfrom os import mkdir, environ 1075863Snate@binkert.orgfrom os.path import abspath, basename, dirname, expanduser, normpath 1085863Snate@binkert.orgfrom os.path import exists, isdir, isfile 1095863Snate@binkert.orgfrom os.path import join as joinpath, split as splitpath 110955SN/A 1116654Snate@binkert.org# SCons includes 1125273Sstever@gmail.comimport SCons 1135871Snate@binkert.orgimport SCons.Node 1145273Sstever@gmail.com 1156655Snate@binkert.orgextra_python_paths = [ 1168878Ssteve.reinhardt@amd.com Dir('src/python').srcnode().abspath, # gem5 includes 1176655Snate@binkert.org Dir('ext/ply').srcnode().abspath, # ply is used by several files 1186655Snate@binkert.org ] 1199219Spower.jg@gmail.com 1206655Snate@binkert.orgsys.path[1:1] = extra_python_paths 1215871Snate@binkert.org 1226654Snate@binkert.orgfrom m5.util import compareVersions, readCommand 1238947Sandreas.hansson@arm.comfrom m5.util.terminal import get_termcap 1245396Ssaidi@eecs.umich.edu 1258120Sgblack@eecs.umich.eduhelp_texts = { 1268120Sgblack@eecs.umich.edu "options" : "", 1278120Sgblack@eecs.umich.edu "global_vars" : "", 1288120Sgblack@eecs.umich.edu "local_vars" : "" 1298120Sgblack@eecs.umich.edu} 1308120Sgblack@eecs.umich.edu 1318120Sgblack@eecs.umich.eduExport("help_texts") 1328120Sgblack@eecs.umich.edu 1338879Ssteve.reinhardt@amd.com 1348879Ssteve.reinhardt@amd.com# There's a bug in scons in that (1) by default, the help texts from 1358879Ssteve.reinhardt@amd.com# AddOption() are supposed to be displayed when you type 'scons -h' 1368879Ssteve.reinhardt@amd.com# and (2) you can override the help displayed by 'scons -h' using the 1378879Ssteve.reinhardt@amd.com# Help() function, but these two features are incompatible: once 1388879Ssteve.reinhardt@amd.com# you've overridden the help text using Help(), there's no way to get 1398879Ssteve.reinhardt@amd.com# at the help texts from AddOptions. See: 1408879Ssteve.reinhardt@amd.com# http://scons.tigris.org/issues/show_bug.cgi?id=2356 1418879Ssteve.reinhardt@amd.com# http://scons.tigris.org/issues/show_bug.cgi?id=2611 1428879Ssteve.reinhardt@amd.com# This hack lets us extract the help text from AddOptions and 1438879Ssteve.reinhardt@amd.com# re-inject it via Help(). Ideally someday this bug will be fixed and 1448879Ssteve.reinhardt@amd.com# we can just use AddOption directly. 1458879Ssteve.reinhardt@amd.comdef AddLocalOption(*args, **kwargs): 1468120Sgblack@eecs.umich.edu col_width = 30 1478120Sgblack@eecs.umich.edu 1488120Sgblack@eecs.umich.edu help = " " + ", ".join(args) 1498120Sgblack@eecs.umich.edu if "help" in kwargs: 1508120Sgblack@eecs.umich.edu length = len(help) 1518120Sgblack@eecs.umich.edu if length >= col_width: 1528120Sgblack@eecs.umich.edu help += "\n" + " " * col_width 1538120Sgblack@eecs.umich.edu else: 1548120Sgblack@eecs.umich.edu help += " " * (col_width - length) 1558120Sgblack@eecs.umich.edu help += kwargs["help"] 1568120Sgblack@eecs.umich.edu help_texts["options"] += help + "\n" 1578120Sgblack@eecs.umich.edu 1588120Sgblack@eecs.umich.edu AddOption(*args, **kwargs) 1598120Sgblack@eecs.umich.edu 1608879Ssteve.reinhardt@amd.comAddLocalOption('--colors', dest='use_colors', action='store_true', 1618879Ssteve.reinhardt@amd.com help="Add color to abbreviated scons output") 1628879Ssteve.reinhardt@amd.comAddLocalOption('--no-colors', dest='use_colors', action='store_false', 1638879Ssteve.reinhardt@amd.com help="Don't add color to abbreviated scons output") 1648879Ssteve.reinhardt@amd.comAddLocalOption('--default', dest='default', type='string', action='store', 1658879Ssteve.reinhardt@amd.com help='Override which build_opts file to use for defaults') 1668879Ssteve.reinhardt@amd.comAddLocalOption('--ignore-style', dest='ignore_style', action='store_true', 1678879Ssteve.reinhardt@amd.com help='Disable style checking hooks') 1689227Sandreas.hansson@arm.comAddLocalOption('--no-lto', dest='no_lto', action='store_true', 1699227Sandreas.hansson@arm.com help='Disable Link-Time Optimization for fast') 1708879Ssteve.reinhardt@amd.comAddLocalOption('--update-ref', dest='update_ref', action='store_true', 1718879Ssteve.reinhardt@amd.com help='Update test reference outputs') 1728879Ssteve.reinhardt@amd.comAddLocalOption('--verbose', dest='verbose', action='store_true', 1738879Ssteve.reinhardt@amd.com help='Print full tool command lines') 1748120Sgblack@eecs.umich.edu 1758947Sandreas.hansson@arm.comtermcap = get_termcap(GetOption('use_colors')) 1767816Ssteve.reinhardt@amd.com 1775871Snate@binkert.org######################################################################## 1785871Snate@binkert.org# 1796121Snate@binkert.org# Set up the main build environment. 1805871Snate@binkert.org# 1815871Snate@binkert.org######################################################################## 1829119Sandreas.hansson@arm.comuse_vars = set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH', 1839396Sandreas.hansson@arm.com 'LIBRARY_PATH', 'PATH', 'PKG_CONFIG_PATH', 'PYTHONPATH', 1849396Sandreas.hansson@arm.com 'RANLIB', 'SWIG' ]) 185955SN/A 1869416SAndreas.Sandberg@ARM.comuse_prefixes = [ 1879416SAndreas.Sandberg@ARM.com "M5", # M5 configuration (e.g., path to kernels) 1889416SAndreas.Sandberg@ARM.com "DISTCC_", # distcc (distributed compiler wrapper) configuration 1899416SAndreas.Sandberg@ARM.com "CCACHE_", # ccache (caching compiler wrapper) configuration 1909416SAndreas.Sandberg@ARM.com "CCC_", # clang static analyzer configuration 1919416SAndreas.Sandberg@ARM.com ] 1929416SAndreas.Sandberg@ARM.com 1935871Snate@binkert.orguse_env = {} 1945871Snate@binkert.orgfor key,val in os.environ.iteritems(): 1959416SAndreas.Sandberg@ARM.com if key in use_vars or \ 1969416SAndreas.Sandberg@ARM.com any([key.startswith(prefix) for prefix in use_prefixes]): 1975871Snate@binkert.org use_env[key] = val 198955SN/A 1996121Snate@binkert.orgmain = Environment(ENV=use_env) 2008881Smarc.orr@gmail.commain.Decider('MD5-timestamp') 2016121Snate@binkert.orgmain.root = Dir(".") # The current directory (where this file lives). 2026121Snate@binkert.orgmain.srcdir = Dir("src") # The source directory 2031533SN/A 2049239Sandreas.hansson@arm.commain_dict_keys = main.Dictionary().keys() 2059239Sandreas.hansson@arm.com 2069239Sandreas.hansson@arm.com# Check that we have a C/C++ compiler 2079239Sandreas.hansson@arm.comif not ('CC' in main_dict_keys and 'CXX' in main_dict_keys): 2089239Sandreas.hansson@arm.com print "No C++ compiler installed (package g++ on Ubuntu and RedHat)" 2099239Sandreas.hansson@arm.com Exit(1) 2109239Sandreas.hansson@arm.com 2119239Sandreas.hansson@arm.com# Check that swig is present 2129239Sandreas.hansson@arm.comif not 'SWIG' in main_dict_keys: 2139239Sandreas.hansson@arm.com print "swig is not installed (package swig on Ubuntu and RedHat)" 2149239Sandreas.hansson@arm.com Exit(1) 2159239Sandreas.hansson@arm.com 2166655Snate@binkert.org# add useful python code PYTHONPATH so it can be used by subprocesses 2176655Snate@binkert.org# as well 2186655Snate@binkert.orgmain.AppendENVPath('PYTHONPATH', extra_python_paths) 2196655Snate@binkert.org 2205871Snate@binkert.org######################################################################## 2215871Snate@binkert.org# 2225863Snate@binkert.org# Mercurial Stuff. 2235871Snate@binkert.org# 2248878Ssteve.reinhardt@amd.com# If the gem5 directory is a mercurial repository, we should do some 2255871Snate@binkert.org# extra things. 2265871Snate@binkert.org# 2275871Snate@binkert.org######################################################################## 2285863Snate@binkert.org 2296121Snate@binkert.orghgdir = main.root.Dir(".hg") 2305863Snate@binkert.org 2315871Snate@binkert.orgmercurial_style_message = """ 2328336Ssteve.reinhardt@amd.comYou're missing the gem5 style hook, which automatically checks your code 2338336Ssteve.reinhardt@amd.comagainst the gem5 style rules on hg commit and qrefresh commands. This 2348336Ssteve.reinhardt@amd.comscript will now install the hook in your .hg/hgrc file. 2358336Ssteve.reinhardt@amd.comPress enter to continue, or ctrl-c to abort: """ 2364678Snate@binkert.org 2378336Ssteve.reinhardt@amd.commercurial_style_hook = """ 2388336Ssteve.reinhardt@amd.com# The following lines were automatically added by gem5/SConstruct 2398336Ssteve.reinhardt@amd.com# to provide the gem5 style-checking hooks 2404678Snate@binkert.org[extensions] 2414678Snate@binkert.orgstyle = %s/util/style.py 2424678Snate@binkert.org 2434678Snate@binkert.org[hooks] 2447827Snate@binkert.orgpretxncommit.style = python:style.check_style 2457827Snate@binkert.orgpre-qrefresh.style = python:style.check_style 2468336Ssteve.reinhardt@amd.com# End of SConstruct additions 2474678Snate@binkert.org 2488336Ssteve.reinhardt@amd.com""" % (main.root.abspath) 2498336Ssteve.reinhardt@amd.com 2508336Ssteve.reinhardt@amd.commercurial_lib_not_found = """ 2518336Ssteve.reinhardt@amd.comMercurial libraries cannot be found, ignoring style hook. If 2528336Ssteve.reinhardt@amd.comyou are a gem5 developer, please fix this and run the style 2538336Ssteve.reinhardt@amd.comhook. It is important. 2545871Snate@binkert.org""" 2555871Snate@binkert.org 2568336Ssteve.reinhardt@amd.com# Check for style hook and prompt for installation if it's not there. 2578336Ssteve.reinhardt@amd.com# Skip this if --ignore-style was specified, there's no .hg dir to 2588336Ssteve.reinhardt@amd.com# install a hook in, or there's no interactive terminal to prompt. 2598336Ssteve.reinhardt@amd.comif not GetOption('ignore_style') and hgdir.exists() and sys.stdin.isatty(): 2608336Ssteve.reinhardt@amd.com style_hook = True 2615871Snate@binkert.org try: 2628336Ssteve.reinhardt@amd.com from mercurial import ui 2638336Ssteve.reinhardt@amd.com ui = ui.ui() 2648336Ssteve.reinhardt@amd.com ui.readconfig(hgdir.File('hgrc').abspath) 2658336Ssteve.reinhardt@amd.com style_hook = ui.config('hooks', 'pretxncommit.style', None) and \ 2668336Ssteve.reinhardt@amd.com ui.config('hooks', 'pre-qrefresh.style', None) 2674678Snate@binkert.org except ImportError: 2685871Snate@binkert.org print mercurial_lib_not_found 2694678Snate@binkert.org 2708336Ssteve.reinhardt@amd.com if not style_hook: 2718336Ssteve.reinhardt@amd.com print mercurial_style_message, 2728336Ssteve.reinhardt@amd.com # continue unless user does ctrl-c/ctrl-d etc. 2738336Ssteve.reinhardt@amd.com try: 2748336Ssteve.reinhardt@amd.com raw_input() 2758336Ssteve.reinhardt@amd.com except: 2768336Ssteve.reinhardt@amd.com print "Input exception, exiting scons.\n" 2778336Ssteve.reinhardt@amd.com sys.exit(1) 2788336Ssteve.reinhardt@amd.com hgrc_path = '%s/.hg/hgrc' % main.root.abspath 2798336Ssteve.reinhardt@amd.com print "Adding style hook to", hgrc_path, "\n" 2808336Ssteve.reinhardt@amd.com try: 2818336Ssteve.reinhardt@amd.com hgrc = open(hgrc_path, 'a') 2828336Ssteve.reinhardt@amd.com hgrc.write(mercurial_style_hook) 2838336Ssteve.reinhardt@amd.com hgrc.close() 2848336Ssteve.reinhardt@amd.com except: 2858336Ssteve.reinhardt@amd.com print "Error updating", hgrc_path 2868336Ssteve.reinhardt@amd.com sys.exit(1) 2875871Snate@binkert.org 2886121Snate@binkert.org 289955SN/A################################################### 290955SN/A# 2912632Sstever@eecs.umich.edu# Figure out which configurations to set up based on the path(s) of 2922632Sstever@eecs.umich.edu# the target(s). 293955SN/A# 294955SN/A################################################### 295955SN/A 296955SN/A# Find default configuration & binary. 2978878Ssteve.reinhardt@amd.comDefault(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug')) 298955SN/A 2992632Sstever@eecs.umich.edu# helper function: find last occurrence of element in list 3002632Sstever@eecs.umich.edudef rfind(l, elt, offs = -1): 3012632Sstever@eecs.umich.edu for i in range(len(l)+offs, 0, -1): 3022632Sstever@eecs.umich.edu if l[i] == elt: 3032632Sstever@eecs.umich.edu return i 3042632Sstever@eecs.umich.edu raise ValueError, "element not found" 3052632Sstever@eecs.umich.edu 3068268Ssteve.reinhardt@amd.com# Take a list of paths (or SCons Nodes) and return a list with all 3078268Ssteve.reinhardt@amd.com# paths made absolute and ~-expanded. Paths will be interpreted 3088268Ssteve.reinhardt@amd.com# relative to the launch directory unless a different root is provided 3098268Ssteve.reinhardt@amd.comdef makePathListAbsolute(path_list, root=GetLaunchDir()): 3108268Ssteve.reinhardt@amd.com return [abspath(joinpath(root, expanduser(str(p)))) 3118268Ssteve.reinhardt@amd.com for p in path_list] 3128268Ssteve.reinhardt@amd.com 3132632Sstever@eecs.umich.edu# Each target must have 'build' in the interior of the path; the 3142632Sstever@eecs.umich.edu# directory below this will determine the build parameters. For 3152632Sstever@eecs.umich.edu# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we 3162632Sstever@eecs.umich.edu# recognize that ALPHA_SE specifies the configuration because it 3178268Ssteve.reinhardt@amd.com# follow 'build' in the build path. 3182632Sstever@eecs.umich.edu 3198268Ssteve.reinhardt@amd.com# The funky assignment to "[:]" is needed to replace the list contents 3208268Ssteve.reinhardt@amd.com# in place rather than reassign the symbol to a new list, which 3218268Ssteve.reinhardt@amd.com# doesn't work (obviously!). 3228268Ssteve.reinhardt@amd.comBUILD_TARGETS[:] = makePathListAbsolute(BUILD_TARGETS) 3233718Sstever@eecs.umich.edu 3242634Sstever@eecs.umich.edu# Generate a list of the unique build roots and configs that the 3252634Sstever@eecs.umich.edu# collected targets reference. 3265863Snate@binkert.orgvariant_paths = [] 3272638Sstever@eecs.umich.edubuild_root = None 3288268Ssteve.reinhardt@amd.comfor t in BUILD_TARGETS: 3292632Sstever@eecs.umich.edu path_dirs = t.split('/') 3302632Sstever@eecs.umich.edu try: 3312632Sstever@eecs.umich.edu build_top = rfind(path_dirs, 'build', -2) 3322632Sstever@eecs.umich.edu except: 3332632Sstever@eecs.umich.edu print "Error: no non-leaf 'build' dir found on target path", t 3341858SN/A Exit(1) 3353716Sstever@eecs.umich.edu this_build_root = joinpath('/',*path_dirs[:build_top+1]) 3362638Sstever@eecs.umich.edu if not build_root: 3372638Sstever@eecs.umich.edu build_root = this_build_root 3382638Sstever@eecs.umich.edu else: 3392638Sstever@eecs.umich.edu if this_build_root != build_root: 3402638Sstever@eecs.umich.edu print "Error: build targets not under same build root\n"\ 3412638Sstever@eecs.umich.edu " %s\n %s" % (build_root, this_build_root) 3422638Sstever@eecs.umich.edu Exit(1) 3435863Snate@binkert.org variant_path = joinpath('/',*path_dirs[:build_top+2]) 3445863Snate@binkert.org if variant_path not in variant_paths: 3455863Snate@binkert.org variant_paths.append(variant_path) 346955SN/A 3475341Sstever@gmail.com# Make sure build_root exists (might not if this is the first build there) 3485341Sstever@gmail.comif not isdir(build_root): 3495863Snate@binkert.org mkdir(build_root) 3507756SAli.Saidi@ARM.commain['BUILDROOT'] = build_root 3515341Sstever@gmail.com 3526121Snate@binkert.orgExport('main') 3534494Ssaidi@eecs.umich.edu 3546121Snate@binkert.orgmain.SConsignFile(joinpath(build_root, "sconsign")) 3551105SN/A 3562667Sstever@eecs.umich.edu# Default duplicate option is to use hard links, but this messes up 3572667Sstever@eecs.umich.edu# when you use emacs to edit a file in the target dir, as emacs moves 3582667Sstever@eecs.umich.edu# file to file~ then copies to file, breaking the link. Symbolic 3592667Sstever@eecs.umich.edu# (soft) links work better. 3606121Snate@binkert.orgmain.SetOption('duplicate', 'soft-copy') 3612667Sstever@eecs.umich.edu 3625341Sstever@gmail.com# 3635863Snate@binkert.org# Set up global sticky variables... these are common to an entire build 3645341Sstever@gmail.com# tree (not specific to a particular build like ALPHA_SE) 3655341Sstever@gmail.com# 3665341Sstever@gmail.com 3678120Sgblack@eecs.umich.eduglobal_vars_file = joinpath(build_root, 'variables.global') 3685341Sstever@gmail.com 3698120Sgblack@eecs.umich.eduglobal_vars = Variables(global_vars_file, args=ARGUMENTS) 3705341Sstever@gmail.com 3718120Sgblack@eecs.umich.eduglobal_vars.AddVariables( 3726121Snate@binkert.org ('CC', 'C compiler', environ.get('CC', main['CC'])), 3736121Snate@binkert.org ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])), 3748980Ssteve.reinhardt@amd.com ('SWIG', 'SWIG tool', environ.get('SWIG', main['SWIG'])), 3759396Sandreas.hansson@arm.com ('PROTOC', 'protoc tool', environ.get('PROTOC', 'protoc')), 3765397Ssaidi@eecs.umich.edu ('BATCH', 'Use batch pool for build and tests', False), 3775397Ssaidi@eecs.umich.edu ('BATCH_CMD', 'Batch pool submission command name', 'qdo'), 3787727SAli.Saidi@ARM.com ('M5_BUILD_CACHE', 'Cache built objects in this directory', False), 3798268Ssteve.reinhardt@amd.com ('EXTRAS', 'Add extra directories to the compilation', '') 3806168Snate@binkert.org ) 3815341Sstever@gmail.com 3828120Sgblack@eecs.umich.edu# Update main environment with values from ARGUMENTS & global_vars_file 3838120Sgblack@eecs.umich.eduglobal_vars.Update(main) 3848120Sgblack@eecs.umich.eduhelp_texts["global_vars"] += global_vars.GenerateHelpText(main) 3856814Sgblack@eecs.umich.edu 3865863Snate@binkert.org# Save sticky variable settings back to current variables file 3878120Sgblack@eecs.umich.eduglobal_vars.Save(global_vars_file, main) 3885341Sstever@gmail.com 3895863Snate@binkert.org# Parse EXTRAS variable to build list of all directories where we're 3908268Ssteve.reinhardt@amd.com# look for sources etc. This list is exported as extras_dir_list. 3916121Snate@binkert.orgbase_dir = main.srcdir.abspath 3926121Snate@binkert.orgif main['EXTRAS']: 3938268Ssteve.reinhardt@amd.com extras_dir_list = makePathListAbsolute(main['EXTRAS'].split(':')) 3945742Snate@binkert.orgelse: 3955742Snate@binkert.org extras_dir_list = [] 3965341Sstever@gmail.com 3975742Snate@binkert.orgExport('base_dir') 3985742Snate@binkert.orgExport('extras_dir_list') 3995341Sstever@gmail.com 4006017Snate@binkert.org# the ext directory should be on the #includes path 4016121Snate@binkert.orgmain.Append(CPPPATH=[Dir('ext')]) 4026017Snate@binkert.org 4037816Ssteve.reinhardt@amd.comdef strip_build_path(path, env): 4047756SAli.Saidi@ARM.com path = str(path) 4057756SAli.Saidi@ARM.com variant_base = env['BUILDROOT'] + os.path.sep 4067756SAli.Saidi@ARM.com if path.startswith(variant_base): 4077756SAli.Saidi@ARM.com path = path[len(variant_base):] 4087756SAli.Saidi@ARM.com elif path.startswith('build/'): 4097756SAli.Saidi@ARM.com path = path[6:] 4107756SAli.Saidi@ARM.com return path 4117756SAli.Saidi@ARM.com 4127816Ssteve.reinhardt@amd.com# Generate a string of the form: 4137816Ssteve.reinhardt@amd.com# common/path/prefix/src1, src2 -> tgt1, tgt2 4147816Ssteve.reinhardt@amd.com# to print while building. 4157816Ssteve.reinhardt@amd.comclass Transform(object): 4167816Ssteve.reinhardt@amd.com # all specific color settings should be here and nowhere else 4177816Ssteve.reinhardt@amd.com tool_color = termcap.Normal 4187816Ssteve.reinhardt@amd.com pfx_color = termcap.Yellow 4197816Ssteve.reinhardt@amd.com srcs_color = termcap.Yellow + termcap.Bold 4207816Ssteve.reinhardt@amd.com arrow_color = termcap.Blue + termcap.Bold 4217816Ssteve.reinhardt@amd.com tgts_color = termcap.Yellow + termcap.Bold 4227756SAli.Saidi@ARM.com 4237816Ssteve.reinhardt@amd.com def __init__(self, tool, max_sources=99): 4247816Ssteve.reinhardt@amd.com self.format = self.tool_color + (" [%8s] " % tool) \ 4257816Ssteve.reinhardt@amd.com + self.pfx_color + "%s" \ 4267816Ssteve.reinhardt@amd.com + self.srcs_color + "%s" \ 4277816Ssteve.reinhardt@amd.com + self.arrow_color + " -> " \ 4287816Ssteve.reinhardt@amd.com + self.tgts_color + "%s" \ 4297816Ssteve.reinhardt@amd.com + termcap.Normal 4307816Ssteve.reinhardt@amd.com self.max_sources = max_sources 4317816Ssteve.reinhardt@amd.com 4327816Ssteve.reinhardt@amd.com def __call__(self, target, source, env, for_signature=None): 4337816Ssteve.reinhardt@amd.com # truncate source list according to max_sources param 4347816Ssteve.reinhardt@amd.com source = source[0:self.max_sources] 4357816Ssteve.reinhardt@amd.com def strip(f): 4367816Ssteve.reinhardt@amd.com return strip_build_path(str(f), env) 4377816Ssteve.reinhardt@amd.com if len(source) > 0: 4387816Ssteve.reinhardt@amd.com srcs = map(strip, source) 4397816Ssteve.reinhardt@amd.com else: 4407816Ssteve.reinhardt@amd.com srcs = [''] 4417816Ssteve.reinhardt@amd.com tgts = map(strip, target) 4427816Ssteve.reinhardt@amd.com # surprisingly, os.path.commonprefix is a dumb char-by-char string 4437816Ssteve.reinhardt@amd.com # operation that has nothing to do with paths. 4447816Ssteve.reinhardt@amd.com com_pfx = os.path.commonprefix(srcs + tgts) 4457816Ssteve.reinhardt@amd.com com_pfx_len = len(com_pfx) 4467816Ssteve.reinhardt@amd.com if com_pfx: 4477816Ssteve.reinhardt@amd.com # do some cleanup and sanity checking on common prefix 4487816Ssteve.reinhardt@amd.com if com_pfx[-1] == ".": 4497816Ssteve.reinhardt@amd.com # prefix matches all but file extension: ok 4507816Ssteve.reinhardt@amd.com # back up one to change 'foo.cc -> o' to 'foo.cc -> .o' 4517816Ssteve.reinhardt@amd.com com_pfx = com_pfx[0:-1] 4527816Ssteve.reinhardt@amd.com elif com_pfx[-1] == "/": 4537816Ssteve.reinhardt@amd.com # common prefix is directory path: OK 4547816Ssteve.reinhardt@amd.com pass 4557816Ssteve.reinhardt@amd.com else: 4567816Ssteve.reinhardt@amd.com src0_len = len(srcs[0]) 4577816Ssteve.reinhardt@amd.com tgt0_len = len(tgts[0]) 4587816Ssteve.reinhardt@amd.com if src0_len == com_pfx_len: 4597816Ssteve.reinhardt@amd.com # source is a substring of target, OK 4607816Ssteve.reinhardt@amd.com pass 4617816Ssteve.reinhardt@amd.com elif tgt0_len == com_pfx_len: 4627816Ssteve.reinhardt@amd.com # target is a substring of source, need to back up to 4637816Ssteve.reinhardt@amd.com # avoid empty string on RHS of arrow 4647816Ssteve.reinhardt@amd.com sep_idx = com_pfx.rfind(".") 4657816Ssteve.reinhardt@amd.com if sep_idx != -1: 4667816Ssteve.reinhardt@amd.com com_pfx = com_pfx[0:sep_idx] 4677816Ssteve.reinhardt@amd.com else: 4687816Ssteve.reinhardt@amd.com com_pfx = '' 4697816Ssteve.reinhardt@amd.com elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".": 4707816Ssteve.reinhardt@amd.com # still splitting at file extension: ok 4717816Ssteve.reinhardt@amd.com pass 4727816Ssteve.reinhardt@amd.com else: 4737816Ssteve.reinhardt@amd.com # probably a fluke; ignore it 4747816Ssteve.reinhardt@amd.com com_pfx = '' 4757816Ssteve.reinhardt@amd.com # recalculate length in case com_pfx was modified 4767816Ssteve.reinhardt@amd.com com_pfx_len = len(com_pfx) 4777816Ssteve.reinhardt@amd.com def fmt(files): 4787816Ssteve.reinhardt@amd.com f = map(lambda s: s[com_pfx_len:], files) 4797816Ssteve.reinhardt@amd.com return ', '.join(f) 4807816Ssteve.reinhardt@amd.com return self.format % (com_pfx, fmt(srcs), fmt(tgts)) 4817816Ssteve.reinhardt@amd.com 4827816Ssteve.reinhardt@amd.comExport('Transform') 4837816Ssteve.reinhardt@amd.com 4848947Sandreas.hansson@arm.com# enable the regression script to use the termcap 4858947Sandreas.hansson@arm.commain['TERMCAP'] = termcap 4867756SAli.Saidi@ARM.com 4878120Sgblack@eecs.umich.eduif GetOption('verbose'): 4887756SAli.Saidi@ARM.com def MakeAction(action, string, *args, **kwargs): 4897756SAli.Saidi@ARM.com return Action(action, *args, **kwargs) 4907756SAli.Saidi@ARM.comelse: 4917756SAli.Saidi@ARM.com MakeAction = Action 4927816Ssteve.reinhardt@amd.com main['CCCOMSTR'] = Transform("CC") 4937816Ssteve.reinhardt@amd.com main['CXXCOMSTR'] = Transform("CXX") 4947816Ssteve.reinhardt@amd.com main['ASCOMSTR'] = Transform("AS") 4957816Ssteve.reinhardt@amd.com main['SWIGCOMSTR'] = Transform("SWIG") 4967816Ssteve.reinhardt@amd.com main['ARCOMSTR'] = Transform("AR", 0) 4977816Ssteve.reinhardt@amd.com main['LINKCOMSTR'] = Transform("LINK", 0) 4987816Ssteve.reinhardt@amd.com main['RANLIBCOMSTR'] = Transform("RANLIB", 0) 4997816Ssteve.reinhardt@amd.com main['M4COMSTR'] = Transform("M4") 5007816Ssteve.reinhardt@amd.com main['SHCCCOMSTR'] = Transform("SHCC") 5017816Ssteve.reinhardt@amd.com main['SHCXXCOMSTR'] = Transform("SHCXX") 5027756SAli.Saidi@ARM.comExport('MakeAction') 5037756SAli.Saidi@ARM.com 5049227Sandreas.hansson@arm.com# Initialize the Link-Time Optimization (LTO) flags 5059227Sandreas.hansson@arm.commain['LTO_CCFLAGS'] = [] 5069227Sandreas.hansson@arm.commain['LTO_LDFLAGS'] = [] 5079227Sandreas.hansson@arm.com 5086654Snate@binkert.orgCXX_version = readCommand([main['CXX'],'--version'], exception=False) 5096654Snate@binkert.orgCXX_V = readCommand([main['CXX'],'-V'], exception=False) 5105871Snate@binkert.org 5116121Snate@binkert.orgmain['GCC'] = CXX_version and CXX_version.find('g++') >= 0 5126121Snate@binkert.orgmain['SUNCC'] = CXX_V and CXX_V.find('Sun C++') >= 0 5136121Snate@binkert.orgmain['ICC'] = CXX_V and CXX_V.find('Intel') >= 0 5148946Sandreas.hansson@arm.commain['CLANG'] = CXX_version and CXX_version.find('clang') >= 0 5158737Skoansin.tan@gmail.comif main['GCC'] + main['SUNCC'] + main['ICC'] + main['CLANG'] > 1: 5163940Ssaidi@eecs.umich.edu print 'Error: How can we have two at the same time?' 5173918Ssaidi@eecs.umich.edu Exit(1) 5183918Ssaidi@eecs.umich.edu 5191858SN/A# Set up default C++ compiler flags 5206121Snate@binkert.orgif main['GCC']: 5217739Sgblack@eecs.umich.edu main.Append(CCFLAGS=['-pipe']) 5227739Sgblack@eecs.umich.edu main.Append(CCFLAGS=['-fno-strict-aliasing']) 5236143Snate@binkert.org main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef']) 5247618SAli.Saidi@arm.com # Read the GCC version to check for versions with bugs 5257618SAli.Saidi@arm.com # Note CCVERSION doesn't work here because it is run with the CC 5267618SAli.Saidi@arm.com # before we override it from the command line 5277618SAli.Saidi@arm.com gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False) 5288614Sgblack@eecs.umich.edu main['GCC_VERSION'] = gcc_version 5297618SAli.Saidi@arm.com if not compareVersions(gcc_version, '4.4.1') or \ 5307618SAli.Saidi@arm.com not compareVersions(gcc_version, '4.4.2'): 5317618SAli.Saidi@arm.com print 'Info: Tree vectorizer in GCC 4.4.1 & 4.4.2 is buggy, disabling.' 5327739Sgblack@eecs.umich.edu main.Append(CCFLAGS=['-fno-tree-vectorize']) 5339224Sandreas.hansson@arm.com # c++0x support in gcc is useful already from 4.4, see 5349224Sandreas.hansson@arm.com # http://gcc.gnu.org/projects/cxx0x.html for details 5359224Sandreas.hansson@arm.com if compareVersions(gcc_version, '4.4') >= 0: 5368946Sandreas.hansson@arm.com main.Append(CXXFLAGS=['-std=c++0x']) 5379227Sandreas.hansson@arm.com 5389227Sandreas.hansson@arm.com # LTO support is only really working properly from 4.6 and beyond 5399227Sandreas.hansson@arm.com if compareVersions(gcc_version, '4.6') >= 0: 5409227Sandreas.hansson@arm.com # Add the appropriate Link-Time Optimization (LTO) flags 5419227Sandreas.hansson@arm.com # unless LTO is explicitly turned off. Note that these flags 5429227Sandreas.hansson@arm.com # are only used by the fast target. 5439227Sandreas.hansson@arm.com if not GetOption('no_lto'): 5449227Sandreas.hansson@arm.com # Pass the LTO flag when compiling to produce GIMPLE 5459227Sandreas.hansson@arm.com # output, we merely create the flags here and only append 5469227Sandreas.hansson@arm.com # them later/ 5479227Sandreas.hansson@arm.com main['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')] 5489227Sandreas.hansson@arm.com 5499227Sandreas.hansson@arm.com # Use the same amount of jobs for LTO as we are running 5509227Sandreas.hansson@arm.com # scons with, we hardcode the use of the linker plugin 5519227Sandreas.hansson@arm.com # which requires either gold or GNU ld >= 2.21 5529227Sandreas.hansson@arm.com main['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs'), 5539227Sandreas.hansson@arm.com '-fuse-linker-plugin'] 5549227Sandreas.hansson@arm.com 5556121Snate@binkert.orgelif main['ICC']: 5563940Ssaidi@eecs.umich.edu pass #Fix me... add warning flags once we clean up icc warnings 5576121Snate@binkert.orgelif main['SUNCC']: 5587739Sgblack@eecs.umich.edu main.Append(CCFLAGS=['-Qoption ccfe']) 5597739Sgblack@eecs.umich.edu main.Append(CCFLAGS=['-features=gcc']) 5607739Sgblack@eecs.umich.edu main.Append(CCFLAGS=['-features=extensions']) 5617739Sgblack@eecs.umich.edu main.Append(CCFLAGS=['-library=stlport4']) 5627739Sgblack@eecs.umich.edu main.Append(CCFLAGS=['-xar']) 5637739Sgblack@eecs.umich.edu #main.Append(CCFLAGS=['-instances=semiexplicit']) 5648737Skoansin.tan@gmail.comelif main['CLANG']: 5658737Skoansin.tan@gmail.com clang_version_re = re.compile(".* version (\d+\.\d+)") 5668737Skoansin.tan@gmail.com clang_version_match = clang_version_re.match(CXX_version) 5678737Skoansin.tan@gmail.com if (clang_version_match): 5688737Skoansin.tan@gmail.com clang_version = clang_version_match.groups()[0] 5698737Skoansin.tan@gmail.com if compareVersions(clang_version, "2.9") < 0: 5708737Skoansin.tan@gmail.com print 'Error: clang version 2.9 or newer required.' 5718737Skoansin.tan@gmail.com print ' Installed version:', clang_version 5728737Skoansin.tan@gmail.com Exit(1) 5738737Skoansin.tan@gmail.com else: 5748737Skoansin.tan@gmail.com print 'Error: Unable to determine clang version.' 5758737Skoansin.tan@gmail.com Exit(1) 5768737Skoansin.tan@gmail.com 5778737Skoansin.tan@gmail.com main.Append(CCFLAGS=['-pipe']) 5788737Skoansin.tan@gmail.com main.Append(CCFLAGS=['-fno-strict-aliasing']) 5798737Skoansin.tan@gmail.com main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef']) 5808737Skoansin.tan@gmail.com main.Append(CCFLAGS=['-Wno-tautological-compare']) 5818737Skoansin.tan@gmail.com main.Append(CCFLAGS=['-Wno-self-assign']) 5828946Sandreas.hansson@arm.com # Ruby makes frequent use of extraneous parantheses in the printing 5838946Sandreas.hansson@arm.com # of if-statements 5848946Sandreas.hansson@arm.com main.Append(CCFLAGS=['-Wno-parentheses']) 5858946Sandreas.hansson@arm.com 5869224Sandreas.hansson@arm.com # clang 2.9 does not play well with c++0x as it ships with C++ 5879224Sandreas.hansson@arm.com # headers that produce errors, this was fixed in 3.0 5888946Sandreas.hansson@arm.com if compareVersions(clang_version, "3") >= 0: 5898946Sandreas.hansson@arm.com main.Append(CXXFLAGS=['-std=c++0x']) 5903918Ssaidi@eecs.umich.eduelse: 5919068SAli.Saidi@ARM.com print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal, 5929068SAli.Saidi@ARM.com print "Don't know what compiler options to use for your compiler." 5939068SAli.Saidi@ARM.com print termcap.Yellow + ' compiler:' + termcap.Normal, main['CXX'] 5949068SAli.Saidi@ARM.com print termcap.Yellow + ' version:' + termcap.Normal, 5959068SAli.Saidi@ARM.com if not CXX_version: 5969068SAli.Saidi@ARM.com print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\ 5979068SAli.Saidi@ARM.com termcap.Normal 5989068SAli.Saidi@ARM.com else: 5999068SAli.Saidi@ARM.com print CXX_version.replace('\n', '<nl>') 6009068SAli.Saidi@ARM.com print " If you're trying to use a compiler other than GCC, ICC, SunCC," 6019068SAli.Saidi@ARM.com print " or clang, there appears to be something wrong with your" 6029068SAli.Saidi@ARM.com print " environment." 6039068SAli.Saidi@ARM.com print " " 6049068SAli.Saidi@ARM.com print " If you are trying to use a compiler other than those listed" 6059068SAli.Saidi@ARM.com print " above you will need to ease fix SConstruct and " 6069068SAli.Saidi@ARM.com print " src/SConscript to support that compiler." 6073918Ssaidi@eecs.umich.edu Exit(1) 6083918Ssaidi@eecs.umich.edu 6096157Snate@binkert.org# Set up common yacc/bison flags (needed for Ruby) 6106157Snate@binkert.orgmain['YACCFLAGS'] = '-d' 6116157Snate@binkert.orgmain['YACCHXXFILESUFFIX'] = '.hh' 6126157Snate@binkert.org 6135397Ssaidi@eecs.umich.edu# Do this after we save setting back, or else we'll tack on an 6145397Ssaidi@eecs.umich.edu# extra 'qdo' every time we run scons. 6156121Snate@binkert.orgif main['BATCH']: 6166121Snate@binkert.org main['CC'] = main['BATCH_CMD'] + ' ' + main['CC'] 6176121Snate@binkert.org main['CXX'] = main['BATCH_CMD'] + ' ' + main['CXX'] 6186121Snate@binkert.org main['AS'] = main['BATCH_CMD'] + ' ' + main['AS'] 6196121Snate@binkert.org main['AR'] = main['BATCH_CMD'] + ' ' + main['AR'] 6206121Snate@binkert.org main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB'] 6215397Ssaidi@eecs.umich.edu 6221851SN/Aif sys.platform == 'cygwin': 6231851SN/A # cygwin has some header file issues... 6247739Sgblack@eecs.umich.edu main.Append(CCFLAGS=["-Wno-uninitialized"]) 625955SN/A 6269396Sandreas.hansson@arm.com# Check for the protobuf compiler 6279396Sandreas.hansson@arm.comprotoc_version = readCommand([main['PROTOC'], '--version'], 6289396Sandreas.hansson@arm.com exception='').split() 6299396Sandreas.hansson@arm.com 6309396Sandreas.hansson@arm.com# First two words should be "libprotoc x.y.z" 6319396Sandreas.hansson@arm.comif len(protoc_version) < 2 or protoc_version[0] != 'libprotoc': 6329396Sandreas.hansson@arm.com print termcap.Yellow + termcap.Bold + \ 6339396Sandreas.hansson@arm.com 'Warning: Protocol buffer compiler (protoc) not found.\n' + \ 6349396Sandreas.hansson@arm.com ' Please install protobuf-compiler for tracing support.' + \ 6359396Sandreas.hansson@arm.com termcap.Normal 6369396Sandreas.hansson@arm.com main['PROTOC'] = False 6379396Sandreas.hansson@arm.comelse: 6389396Sandreas.hansson@arm.com # Determine the appropriate include path and library path using 6399396Sandreas.hansson@arm.com # pkg-config, that means we also need to check for pkg-config 6409396Sandreas.hansson@arm.com if not readCommand(['pkg-config', '--version'], exception=''): 6419396Sandreas.hansson@arm.com print 'Error: pkg-config not found. Please install and retry.' 6429396Sandreas.hansson@arm.com Exit(1) 6439396Sandreas.hansson@arm.com 6449396Sandreas.hansson@arm.com main.ParseConfig('pkg-config --cflags --libs-only-L protobuf') 6459396Sandreas.hansson@arm.com 6469396Sandreas.hansson@arm.com # Based on the availability of the compress stream wrappers, 6479396Sandreas.hansson@arm.com # require 2.1.0 6489396Sandreas.hansson@arm.com min_protoc_version = '2.1.0' 6499396Sandreas.hansson@arm.com if compareVersions(protoc_version[1], min_protoc_version) < 0: 6509396Sandreas.hansson@arm.com print 'Error: protoc version', min_protoc_version, 'or newer required.' 6519396Sandreas.hansson@arm.com print ' Installed version:', protoc_version[1] 6529396Sandreas.hansson@arm.com Exit(1) 6539396Sandreas.hansson@arm.com 6543053Sstever@eecs.umich.edu# Check for SWIG 6556121Snate@binkert.orgif not main.has_key('SWIG'): 6563053Sstever@eecs.umich.edu print 'Error: SWIG utility not found.' 6573053Sstever@eecs.umich.edu print ' Please install (see http://www.swig.org) and retry.' 6583053Sstever@eecs.umich.edu Exit(1) 6593053Sstever@eecs.umich.edu 6603053Sstever@eecs.umich.edu# Check for appropriate SWIG version 6619072Sandreas.hansson@arm.comswig_version = readCommand([main['SWIG'], '-version'], exception='').split() 6623053Sstever@eecs.umich.edu# First 3 words should be "SWIG Version x.y.z" 6634742Sstever@eecs.umich.eduif len(swig_version) < 3 or \ 6644742Sstever@eecs.umich.edu swig_version[0] != 'SWIG' or swig_version[1] != 'Version': 6653053Sstever@eecs.umich.edu print 'Error determining SWIG version.' 6663053Sstever@eecs.umich.edu Exit(1) 6673053Sstever@eecs.umich.edu 6688960Ssteve.reinhardt@amd.commin_swig_version = '1.3.34' 6696654Snate@binkert.orgif compareVersions(swig_version[2], min_swig_version) < 0: 6703053Sstever@eecs.umich.edu print 'Error: SWIG version', min_swig_version, 'or newer required.' 6713053Sstever@eecs.umich.edu print ' Installed version:', swig_version[2] 6723053Sstever@eecs.umich.edu Exit(1) 6733053Sstever@eecs.umich.edu 6742667Sstever@eecs.umich.edu# Set up SWIG flags & scanner 6754554Sbinkertn@umich.eduswig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS') 6766121Snate@binkert.orgmain.Append(SWIGFLAGS=swig_flags) 6772667Sstever@eecs.umich.edu 6784554Sbinkertn@umich.edu# filter out all existing swig scanners, they mess up the dependency 6794554Sbinkertn@umich.edu# stuff for some reason 6804554Sbinkertn@umich.eduscanners = [] 6816121Snate@binkert.orgfor scanner in main['SCANNERS']: 6824554Sbinkertn@umich.edu skeys = scanner.skeys 6834554Sbinkertn@umich.edu if skeys == '.i': 6844554Sbinkertn@umich.edu continue 6854781Snate@binkert.org 6864554Sbinkertn@umich.edu if isinstance(skeys, (list, tuple)) and '.i' in skeys: 6874554Sbinkertn@umich.edu continue 6882667Sstever@eecs.umich.edu 6894554Sbinkertn@umich.edu scanners.append(scanner) 6904554Sbinkertn@umich.edu 6914554Sbinkertn@umich.edu# add the new swig scanner that we like better 6924554Sbinkertn@umich.edufrom SCons.Scanner import ClassicCPP as CPPScanner 6932667Sstever@eecs.umich.eduswig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")' 6944554Sbinkertn@umich.eduscanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re)) 6952667Sstever@eecs.umich.edu 6964554Sbinkertn@umich.edu# replace the scanners list that has what we want 6976121Snate@binkert.orgmain['SCANNERS'] = scanners 6982667Sstever@eecs.umich.edu 6995522Snate@binkert.org# Add a custom Check function to the Configure context so that we can 7005522Snate@binkert.org# figure out if the compiler adds leading underscores to global 7015522Snate@binkert.org# variables. This is needed for the autogenerated asm files that we 7025522Snate@binkert.org# use for embedding the python code. 7035522Snate@binkert.orgdef CheckLeading(context): 7045522Snate@binkert.org context.Message("Checking for leading underscore in global variables...") 7055522Snate@binkert.org # 1) Define a global variable called x from asm so the C compiler 7065522Snate@binkert.org # won't change the symbol at all. 7075522Snate@binkert.org # 2) Declare that variable. 7085522Snate@binkert.org # 3) Use the variable 7095522Snate@binkert.org # 7105522Snate@binkert.org # If the compiler prepends an underscore, this will successfully 7115522Snate@binkert.org # link because the external symbol 'x' will be called '_x' which 7125522Snate@binkert.org # was defined by the asm statement. If the compiler does not 7135522Snate@binkert.org # prepend an underscore, this will not successfully link because 7145522Snate@binkert.org # '_x' will have been defined by assembly, while the C portion of 7155522Snate@binkert.org # the code will be trying to use 'x' 7165522Snate@binkert.org ret = context.TryLink(''' 7175522Snate@binkert.org asm(".globl _x; _x: .byte 0"); 7185522Snate@binkert.org extern int x; 7195522Snate@binkert.org int main() { return x; } 7205522Snate@binkert.org ''', extension=".c") 7215522Snate@binkert.org context.env.Append(LEADING_UNDERSCORE=ret) 7225522Snate@binkert.org context.Result(ret) 7235522Snate@binkert.org return ret 7245522Snate@binkert.org 7259255SAndreas.Sandberg@arm.com# Test for the presence of C++11 static asserts. If the compiler lacks 7269255SAndreas.Sandberg@arm.com# support for static asserts, base/compiler.hh enables a macro that 7279255SAndreas.Sandberg@arm.com# removes any static asserts in the code. 7289255SAndreas.Sandberg@arm.comdef CheckStaticAssert(context): 7299255SAndreas.Sandberg@arm.com context.Message("Checking for C++11 static_assert support...") 7309255SAndreas.Sandberg@arm.com ret = context.TryCompile(''' 7319255SAndreas.Sandberg@arm.com static_assert(1, "This assert is always true"); 7329255SAndreas.Sandberg@arm.com ''', extension=".cc") 7339255SAndreas.Sandberg@arm.com context.env.Append(HAVE_STATIC_ASSERT=ret) 7349255SAndreas.Sandberg@arm.com context.Result(ret) 7359255SAndreas.Sandberg@arm.com return ret 7369255SAndreas.Sandberg@arm.com 7372638Sstever@eecs.umich.edu# Platform-specific configuration. Note again that we assume that all 7382638Sstever@eecs.umich.edu# builds under a given build root run on the same host platform. 7396121Snate@binkert.orgconf = Configure(main, 7403716Sstever@eecs.umich.edu conf_dir = joinpath(build_root, '.scons_config'), 7415522Snate@binkert.org log_file = joinpath(build_root, 'scons_config.log'), 7429255SAndreas.Sandberg@arm.com custom_tests = { 'CheckLeading' : CheckLeading, 7439255SAndreas.Sandberg@arm.com 'CheckStaticAssert' : CheckStaticAssert, 7449255SAndreas.Sandberg@arm.com }) 7455522Snate@binkert.org 7465522Snate@binkert.org# Check for leading underscores. Don't really need to worry either 7475522Snate@binkert.org# way so don't need to check the return code. 7485522Snate@binkert.orgconf.CheckLeading() 7491858SN/A 7509255SAndreas.Sandberg@arm.com# Check for C++11 features we want to use if they exist 7519255SAndreas.Sandberg@arm.comconf.CheckStaticAssert() 7529255SAndreas.Sandberg@arm.com 7535227Ssaidi@eecs.umich.edu# Check if we should compile a 64 bit binary on Mac OS X/Darwin 7545227Ssaidi@eecs.umich.edutry: 7555227Ssaidi@eecs.umich.edu import platform 7565227Ssaidi@eecs.umich.edu uname = platform.uname() 7576654Snate@binkert.org if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0: 7586654Snate@binkert.org if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]): 7597769SAli.Saidi@ARM.com main.Append(CCFLAGS=['-arch', 'x86_64']) 7607769SAli.Saidi@ARM.com main.Append(CFLAGS=['-arch', 'x86_64']) 7617769SAli.Saidi@ARM.com main.Append(LINKFLAGS=['-arch', 'x86_64']) 7627769SAli.Saidi@ARM.com main.Append(ASFLAGS=['-arch', 'x86_64']) 7635227Ssaidi@eecs.umich.eduexcept: 7645227Ssaidi@eecs.umich.edu pass 7655227Ssaidi@eecs.umich.edu 7665204Sstever@gmail.com# Recent versions of scons substitute a "Null" object for Configure() 7675204Sstever@gmail.com# when configuration isn't necessary, e.g., if the "--help" option is 7685204Sstever@gmail.com# present. Unfortuantely this Null object always returns false, 7695204Sstever@gmail.com# breaking all our configuration checks. We replace it with our own 7705204Sstever@gmail.com# more optimistic null object that returns True instead. 7715204Sstever@gmail.comif not conf: 7725204Sstever@gmail.com def NullCheck(*args, **kwargs): 7735204Sstever@gmail.com return True 7745204Sstever@gmail.com 7755204Sstever@gmail.com class NullConf: 7765204Sstever@gmail.com def __init__(self, env): 7775204Sstever@gmail.com self.env = env 7785204Sstever@gmail.com def Finish(self): 7795204Sstever@gmail.com return self.env 7805204Sstever@gmail.com def __getattr__(self, mname): 7815204Sstever@gmail.com return NullCheck 7825204Sstever@gmail.com 7836121Snate@binkert.org conf = NullConf(main) 7845204Sstever@gmail.com 7853118Sstever@eecs.umich.edu# Find Python include and library directories for embedding the 7863118Sstever@eecs.umich.edu# interpreter. For consistency, we will use the same Python 7873118Sstever@eecs.umich.edu# installation used to run scons (and thus this script). If you want 7883118Sstever@eecs.umich.edu# to link in an alternate version, see above for instructions on how 7893118Sstever@eecs.umich.edu# to invoke scons with a different copy of the Python interpreter. 7905863Snate@binkert.orgfrom distutils import sysconfig 7913118Sstever@eecs.umich.edu 7925863Snate@binkert.orgpy_getvar = sysconfig.get_config_var 7933118Sstever@eecs.umich.edu 7947457Snate@binkert.orgpy_debug = getattr(sys, 'pydebug', False) 7957457Snate@binkert.orgpy_version = 'python' + py_getvar('VERSION') + (py_debug and "_d" or "") 7965863Snate@binkert.org 7975863Snate@binkert.orgpy_general_include = sysconfig.get_python_inc() 7985863Snate@binkert.orgpy_platform_include = sysconfig.get_python_inc(plat_specific=True) 7995863Snate@binkert.orgpy_includes = [ py_general_include ] 8005863Snate@binkert.orgif py_platform_include != py_general_include: 8015863Snate@binkert.org py_includes.append(py_platform_include) 8025863Snate@binkert.org 8036003Snate@binkert.orgpy_lib_path = [ py_getvar('LIBDIR') ] 8045863Snate@binkert.org# add the prefix/lib/pythonX.Y/config dir, but only if there is no 8055863Snate@binkert.org# shared library in prefix/lib/. 8065863Snate@binkert.orgif not py_getvar('Py_ENABLE_SHARED'): 8076120Snate@binkert.org py_lib_path.append(py_getvar('LIBPL')) 8085863Snate@binkert.org 8095863Snate@binkert.orgpy_libs = [] 8105863Snate@binkert.orgfor lib in py_getvar('LIBS').split() + py_getvar('SYSLIBS').split(): 8118655Sandreas.hansson@arm.com if not lib.startswith('-l'): 8128655Sandreas.hansson@arm.com # Python requires some special flags to link (e.g. -framework 8138655Sandreas.hansson@arm.com # common on OS X systems), assume appending preserves order 8148655Sandreas.hansson@arm.com main.Append(LINKFLAGS=[lib]) 8158655Sandreas.hansson@arm.com else: 8168655Sandreas.hansson@arm.com lib = lib[2:] 8178655Sandreas.hansson@arm.com if lib not in py_libs: 8188655Sandreas.hansson@arm.com py_libs.append(lib) 8196120Snate@binkert.orgpy_libs.append(py_version) 8205863Snate@binkert.org 8216121Snate@binkert.orgmain.Append(CPPPATH=py_includes) 8226121Snate@binkert.orgmain.Append(LIBPATH=py_lib_path) 8235863Snate@binkert.org 8247727SAli.Saidi@ARM.com# Cache build files in the supplied directory. 8257727SAli.Saidi@ARM.comif main['M5_BUILD_CACHE']: 8267727SAli.Saidi@ARM.com print 'Using build cache located at', main['M5_BUILD_CACHE'] 8277727SAli.Saidi@ARM.com CacheDir(main['M5_BUILD_CACHE']) 8287727SAli.Saidi@ARM.com 8297727SAli.Saidi@ARM.com 8305863Snate@binkert.org# verify that this stuff works 8313118Sstever@eecs.umich.eduif not conf.CheckHeader('Python.h', '<>'): 8325863Snate@binkert.org print "Error: can't find Python.h header in", py_includes 8339239Sandreas.hansson@arm.com print "Install Python headers (package python-dev on Ubuntu and RedHat)" 8343118Sstever@eecs.umich.edu Exit(1) 8353118Sstever@eecs.umich.edu 8365863Snate@binkert.orgfor lib in py_libs: 8375863Snate@binkert.org if not conf.CheckLib(lib): 8385863Snate@binkert.org print "Error: can't find library %s required by python" % lib 8395863Snate@binkert.org Exit(1) 8403118Sstever@eecs.umich.edu 8413483Ssaidi@eecs.umich.edu# On Solaris you need to use libsocket for socket ops 8423494Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'): 8433494Ssaidi@eecs.umich.edu if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'): 8443483Ssaidi@eecs.umich.edu print "Can't find library with socket calls (e.g. accept())" 8453483Ssaidi@eecs.umich.edu Exit(1) 8463483Ssaidi@eecs.umich.edu 8473053Sstever@eecs.umich.edu# Check for zlib. If the check passes, libz will be automatically 8483053Sstever@eecs.umich.edu# added to the LIBS environment variable. 8493918Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'): 8503053Sstever@eecs.umich.edu print 'Error: did not find needed zlib compression library '\ 8513053Sstever@eecs.umich.edu 'and/or zlib.h header file.' 8523053Sstever@eecs.umich.edu print ' Please install zlib and try again.' 8533053Sstever@eecs.umich.edu Exit(1) 8543053Sstever@eecs.umich.edu 8559396Sandreas.hansson@arm.com# If we have the protobuf compiler, also make sure we have the 8569396Sandreas.hansson@arm.com# development libraries. If the check passes, libprotobuf will be 8579396Sandreas.hansson@arm.com# automatically added to the LIBS environment variable. After 8589396Sandreas.hansson@arm.com# this, we can use the HAVE_PROTOBUF flag to determine if we have 8599396Sandreas.hansson@arm.com# got both protoc and libprotobuf available. 8609396Sandreas.hansson@arm.commain['HAVE_PROTOBUF'] = main['PROTOC'] and \ 8619396Sandreas.hansson@arm.com conf.CheckLibWithHeader('protobuf', 'google/protobuf/message.h', 8629396Sandreas.hansson@arm.com 'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;') 8639396Sandreas.hansson@arm.com 8649396Sandreas.hansson@arm.com# If we have the compiler but not the library, treat it as an error. 8659396Sandreas.hansson@arm.comif main['PROTOC'] and not main['HAVE_PROTOBUF']: 8669396Sandreas.hansson@arm.com print 'Error: did not find protocol buffer library and/or headers.' 8679396Sandreas.hansson@arm.com print ' Please install libprotobuf-dev and try again.' 8689396Sandreas.hansson@arm.com Exit(1) 8699396Sandreas.hansson@arm.com 8707840Snate@binkert.org# Check for librt. 8717865Sgblack@eecs.umich.eduhave_posix_clock = \ 8727865Sgblack@eecs.umich.edu conf.CheckLibWithHeader(None, 'time.h', 'C', 8737865Sgblack@eecs.umich.edu 'clock_nanosleep(0,0,NULL,NULL);') or \ 8747865Sgblack@eecs.umich.edu conf.CheckLibWithHeader('rt', 'time.h', 'C', 8757865Sgblack@eecs.umich.edu 'clock_nanosleep(0,0,NULL,NULL);') 8767840Snate@binkert.org 8779045SAli.Saidi@ARM.comif conf.CheckLib('tcmalloc_minimal'): 8789045SAli.Saidi@ARM.com have_tcmalloc = True 8799045SAli.Saidi@ARM.comelse: 8809045SAli.Saidi@ARM.com have_tcmalloc = False 8819045SAli.Saidi@ARM.com print termcap.Yellow + termcap.Bold + \ 8829045SAli.Saidi@ARM.com "You can get a 12% performance improvement by installing tcmalloc "\ 8839071Sandreas.hansson@arm.com "(libgoogle-perftools-dev package on Ubuntu or RedHat)." + \ 8849071Sandreas.hansson@arm.com termcap.Normal 8859045SAli.Saidi@ARM.com 8867840Snate@binkert.orgif not have_posix_clock: 8877840Snate@binkert.org print "Can't find library for POSIX clocks." 8887840Snate@binkert.org 8891858SN/A# Check for <fenv.h> (C99 FP environment control) 8901858SN/Ahave_fenv = conf.CheckHeader('fenv.h', '<>') 8911858SN/Aif not have_fenv: 8921858SN/A print "Warning: Header file <fenv.h> not found." 8931858SN/A print " This host has no IEEE FP rounding mode control." 8941858SN/A 8955863Snate@binkert.org###################################################################### 8965863Snate@binkert.org# 8975863Snate@binkert.org# Finish the configuration 8985863Snate@binkert.org# 8996121Snate@binkert.orgmain = conf.Finish() 9001858SN/A 9015863Snate@binkert.org###################################################################### 9025863Snate@binkert.org# 9035863Snate@binkert.org# Collect all non-global variables 9045863Snate@binkert.org# 9055863Snate@binkert.org 9062139SN/A# Define the universe of supported ISAs 9074202Sbinkertn@umich.eduall_isa_list = [ ] 9084202Sbinkertn@umich.eduExport('all_isa_list') 9092139SN/A 9106994Snate@binkert.orgclass CpuModel(object): 9116994Snate@binkert.org '''The CpuModel class encapsulates everything the ISA parser needs to 9126994Snate@binkert.org know about a particular CPU model.''' 9136994Snate@binkert.org 9146994Snate@binkert.org # Dict of available CPU model objects. Accessible as CpuModel.dict. 9156994Snate@binkert.org dict = {} 9166994Snate@binkert.org list = [] 9176994Snate@binkert.org defaults = [] 9186994Snate@binkert.org 9196994Snate@binkert.org # Constructor. Automatically adds models to CpuModel.dict. 9206994Snate@binkert.org def __init__(self, name, filename, includes, strings, default=False): 9216994Snate@binkert.org self.name = name # name of model 9226994Snate@binkert.org self.filename = filename # filename for output exec code 9236994Snate@binkert.org self.includes = includes # include files needed in exec file 9246994Snate@binkert.org # The 'strings' dict holds all the per-CPU symbols we can 9256994Snate@binkert.org # substitute into templates etc. 9266994Snate@binkert.org self.strings = strings 9276994Snate@binkert.org 9286994Snate@binkert.org # This cpu is enabled by default 9296994Snate@binkert.org self.default = default 9306994Snate@binkert.org 9316994Snate@binkert.org # Add self to dict 9326994Snate@binkert.org if name in CpuModel.dict: 9336994Snate@binkert.org raise AttributeError, "CpuModel '%s' already registered" % name 9346994Snate@binkert.org CpuModel.dict[name] = self 9356994Snate@binkert.org CpuModel.list.append(name) 9366994Snate@binkert.org 9376994Snate@binkert.orgExport('CpuModel') 9382155SN/A 9395863Snate@binkert.org# Sticky variables get saved in the variables file so they persist from 9401869SN/A# one invocation to the next (unless overridden, in which case the new 9411869SN/A# value becomes sticky). 9425863Snate@binkert.orgsticky_vars = Variables(args=ARGUMENTS) 9435863Snate@binkert.orgExport('sticky_vars') 9444202Sbinkertn@umich.edu 9456108Snate@binkert.org# Sticky variables that should be exported 9466108Snate@binkert.orgexport_vars = [] 9476108Snate@binkert.orgExport('export_vars') 9486108Snate@binkert.org 9499219Spower.jg@gmail.com# For Ruby 9509219Spower.jg@gmail.comall_protocols = [] 9519219Spower.jg@gmail.comExport('all_protocols') 9529219Spower.jg@gmail.comprotocol_dirs = [] 9539219Spower.jg@gmail.comExport('protocol_dirs') 9549219Spower.jg@gmail.comslicc_includes = [] 9559219Spower.jg@gmail.comExport('slicc_includes') 9569219Spower.jg@gmail.com 9574202Sbinkertn@umich.edu# Walk the tree and execute all SConsopts scripts that wil add to the 9585863Snate@binkert.org# above variables 9598474Sgblack@eecs.umich.eduif not GetOption('verbose'): 9608474Sgblack@eecs.umich.edu print "Reading SConsopts" 9615742Snate@binkert.orgfor bdir in [ base_dir ] + extras_dir_list: 9628268Ssteve.reinhardt@amd.com if not isdir(bdir): 9638268Ssteve.reinhardt@amd.com print "Error: directory '%s' does not exist" % bdir 9648268Ssteve.reinhardt@amd.com Exit(1) 9655742Snate@binkert.org for root, dirs, files in os.walk(bdir): 9665341Sstever@gmail.com if 'SConsopts' in files: 9678474Sgblack@eecs.umich.edu if GetOption('verbose'): 9688474Sgblack@eecs.umich.edu print "Reading", joinpath(root, 'SConsopts') 9695342Sstever@gmail.com SConscript(joinpath(root, 'SConsopts')) 9704202Sbinkertn@umich.edu 9714202Sbinkertn@umich.eduall_isa_list.sort() 9724202Sbinkertn@umich.edu 9735863Snate@binkert.orgsticky_vars.AddVariables( 9745863Snate@binkert.org EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list), 9756994Snate@binkert.org ListVariable('CPU_MODELS', 'CPU models', 9766994Snate@binkert.org sorted(n for n,m in CpuModel.dict.iteritems() if m.default), 9776994Snate@binkert.org sorted(CpuModel.list)), 9785863Snate@binkert.org BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger', 9795863Snate@binkert.org False), 9805863Snate@binkert.org BoolVariable('SS_COMPATIBLE_FP', 9815863Snate@binkert.org 'Make floating-point results compatible with SimpleScalar', 9825863Snate@binkert.org False), 9835863Snate@binkert.org BoolVariable('USE_SSE2', 9845863Snate@binkert.org 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts', 9855863Snate@binkert.org False), 9867840Snate@binkert.org BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock), 9875863Snate@binkert.org BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv), 9885952Ssaidi@eecs.umich.edu BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False), 9899219Spower.jg@gmail.com EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None', 9909219Spower.jg@gmail.com all_protocols), 9911869SN/A ) 9921858SN/A 9935863Snate@binkert.org# These variables get exported to #defines in config/*.hh (see src/SConscript). 9949044SAli.Saidi@ARM.comexport_vars += ['USE_FENV', 'SS_COMPATIBLE_FP', 9959219Spower.jg@gmail.com 'TARGET_ISA', 'CP_ANNOTATE', 'USE_POSIX_CLOCK', 'PROTOCOL', 9969396Sandreas.hansson@arm.com 'HAVE_STATIC_ASSERT', 'HAVE_PROTOBUF'] 9971858SN/A 998955SN/A################################################### 999955SN/A# 10001869SN/A# Define a SCons builder for configuration flag headers. 10011869SN/A# 10021869SN/A################################################### 10031869SN/A 10041869SN/A# This function generates a config header file that #defines the 10055863Snate@binkert.org# variable symbol to the current variable setting (0 or 1). The source 10065863Snate@binkert.org# operands are the name of the variable and a Value node containing the 10075863Snate@binkert.org# value of the variable. 10081869SN/Adef build_config_file(target, source, env): 10095863Snate@binkert.org (variable, value) = [s.get_contents() for s in source] 10101869SN/A f = file(str(target[0]), 'w') 10115863Snate@binkert.org print >> f, '#define', variable, value 10121869SN/A f.close() 10131869SN/A return None 10141869SN/A 10151869SN/A# Combine the two functions into a scons Action object. 10168483Sgblack@eecs.umich.educonfig_action = MakeAction(build_config_file, Transform("CONFIG H", 2)) 10171869SN/A 10181869SN/A# The emitter munges the source & target node lists to reflect what 10191869SN/A# we're really doing. 10201869SN/Adef config_emitter(target, source, env): 10215863Snate@binkert.org # extract variable name from Builder arg 10225863Snate@binkert.org variable = str(target[0]) 10231869SN/A # True target is config header file 10245863Snate@binkert.org target = joinpath('config', variable.lower() + '.hh') 10255863Snate@binkert.org val = env[variable] 10263356Sbinkertn@umich.edu if isinstance(val, bool): 10273356Sbinkertn@umich.edu # Force value to 0/1 10283356Sbinkertn@umich.edu val = int(val) 10293356Sbinkertn@umich.edu elif isinstance(val, str): 10303356Sbinkertn@umich.edu val = '"' + val + '"' 10314781Snate@binkert.org 10325863Snate@binkert.org # Sources are variable name & value (packaged in SCons Value nodes) 10335863Snate@binkert.org return ([target], [Value(variable), Value(val)]) 10341869SN/A 10351869SN/Aconfig_builder = Builder(emitter = config_emitter, action = config_action) 10361869SN/A 10376121Snate@binkert.orgmain.Append(BUILDERS = { 'ConfigFile' : config_builder }) 10381869SN/A 10392638Sstever@eecs.umich.edu# libelf build is shared across all configs in the build root. 10406121Snate@binkert.orgmain.SConscript('ext/libelf/SConscript', 10416121Snate@binkert.org variant_dir = joinpath(build_root, 'libelf')) 10422638Sstever@eecs.umich.edu 10435749Scws3k@cs.virginia.edu# gzstream build is shared across all configs in the build root. 10446121Snate@binkert.orgmain.SConscript('ext/gzstream/SConscript', 10456121Snate@binkert.org variant_dir = joinpath(build_root, 'gzstream')) 10465749Scws3k@cs.virginia.edu 10471869SN/A################################################### 10481869SN/A# 10493546Sgblack@eecs.umich.edu# This function is used to set up a directory with switching headers 10503546Sgblack@eecs.umich.edu# 10513546Sgblack@eecs.umich.edu################################################### 10523546Sgblack@eecs.umich.edu 10536121Snate@binkert.orgmain['ALL_ISA_LIST'] = all_isa_list 10545863Snate@binkert.orgdef make_switching_dir(dname, switch_headers, env): 10553546Sgblack@eecs.umich.edu # Generate the header. target[0] is the full path of the output 10563546Sgblack@eecs.umich.edu # header to generate. 'source' is a dummy variable, since we get the 10573546Sgblack@eecs.umich.edu # list of ISAs from env['ALL_ISA_LIST']. 10583546Sgblack@eecs.umich.edu def gen_switch_hdr(target, source, env): 10594781Snate@binkert.org fname = str(target[0]) 10604781Snate@binkert.org f = open(fname, 'w') 10616658Snate@binkert.org isa = env['TARGET_ISA'].lower() 10626658Snate@binkert.org print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname)) 10634781Snate@binkert.org f.close() 10643546Sgblack@eecs.umich.edu 10653546Sgblack@eecs.umich.edu # Build SCons Action object. 'varlist' specifies env vars that this 10663546Sgblack@eecs.umich.edu # action depends on; when env['ALL_ISA_LIST'] changes these actions 10673546Sgblack@eecs.umich.edu # should get re-executed. 10687756SAli.Saidi@ARM.com switch_hdr_action = MakeAction(gen_switch_hdr, 10697816Ssteve.reinhardt@amd.com Transform("GENERATE"), varlist=['ALL_ISA_LIST']) 10703546Sgblack@eecs.umich.edu 10713546Sgblack@eecs.umich.edu # Instantiate actions for each header 10723546Sgblack@eecs.umich.edu for hdr in switch_headers: 10733546Sgblack@eecs.umich.edu env.Command(hdr, [], switch_hdr_action) 10744202Sbinkertn@umich.eduExport('make_switching_dir') 10753546Sgblack@eecs.umich.edu 10763546Sgblack@eecs.umich.edu################################################### 10773546Sgblack@eecs.umich.edu# 1078955SN/A# Define build environments for selected configurations. 1079955SN/A# 1080955SN/A################################################### 1081955SN/A 10825863Snate@binkert.orgfor variant_path in variant_paths: 10835863Snate@binkert.org print "Building in", variant_path 10845343Sstever@gmail.com 10855343Sstever@gmail.com # Make a copy of the build-root environment to use for this config. 10866121Snate@binkert.org env = main.Clone() 10875863Snate@binkert.org env['BUILDDIR'] = variant_path 10884773Snate@binkert.org 10895863Snate@binkert.org # variant_dir is the tail component of build path, and is used to 10902632Sstever@eecs.umich.edu # determine the build parameters (e.g., 'ALPHA_SE') 10915863Snate@binkert.org (build_root, variant_dir) = splitpath(variant_path) 10922023SN/A 10935863Snate@binkert.org # Set env variables according to the build directory config. 10945863Snate@binkert.org sticky_vars.files = [] 10955863Snate@binkert.org # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in 10965863Snate@binkert.org # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke 10975863Snate@binkert.org # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings. 10985863Snate@binkert.org current_vars_file = joinpath(build_root, 'variables', variant_dir) 10995863Snate@binkert.org if isfile(current_vars_file): 11005863Snate@binkert.org sticky_vars.files.append(current_vars_file) 11015863Snate@binkert.org print "Using saved variables file %s" % current_vars_file 11022632Sstever@eecs.umich.edu else: 11035863Snate@binkert.org # Build dir-specific variables file doesn't exist. 11042023SN/A 11052632Sstever@eecs.umich.edu # Make sure the directory is there so we can create it later 11065863Snate@binkert.org opt_dir = dirname(current_vars_file) 11075342Sstever@gmail.com if not isdir(opt_dir): 11085863Snate@binkert.org mkdir(opt_dir) 11092632Sstever@eecs.umich.edu 11105863Snate@binkert.org # Get default build variables from source tree. Variables are 11115863Snate@binkert.org # normally determined by name of $VARIANT_DIR, but can be 11128267Ssteve.reinhardt@amd.com # overridden by '--default=' arg on command line. 11138120Sgblack@eecs.umich.edu default = GetOption('default') 11148267Ssteve.reinhardt@amd.com opts_dir = joinpath(main.root.abspath, 'build_opts') 11158267Ssteve.reinhardt@amd.com if default: 11168267Ssteve.reinhardt@amd.com default_vars_files = [joinpath(build_root, 'variables', default), 11178267Ssteve.reinhardt@amd.com joinpath(opts_dir, default)] 11188267Ssteve.reinhardt@amd.com else: 11198267Ssteve.reinhardt@amd.com default_vars_files = [joinpath(opts_dir, variant_dir)] 11208267Ssteve.reinhardt@amd.com existing_files = filter(isfile, default_vars_files) 11218267Ssteve.reinhardt@amd.com if existing_files: 11228267Ssteve.reinhardt@amd.com default_vars_file = existing_files[0] 11235863Snate@binkert.org sticky_vars.files.append(default_vars_file) 11245863Snate@binkert.org print "Variables file %s not found,\n using defaults in %s" \ 11255863Snate@binkert.org % (current_vars_file, default_vars_file) 11262632Sstever@eecs.umich.edu else: 11278267Ssteve.reinhardt@amd.com print "Error: cannot find variables file %s or " \ 11288267Ssteve.reinhardt@amd.com "default file(s) %s" \ 11298267Ssteve.reinhardt@amd.com % (current_vars_file, ' or '.join(default_vars_files)) 11302632Sstever@eecs.umich.edu Exit(1) 11311888SN/A 11325863Snate@binkert.org # Apply current variable settings to env 11335863Snate@binkert.org sticky_vars.Update(env) 11341858SN/A 11358120Sgblack@eecs.umich.edu help_texts["local_vars"] += \ 11368120Sgblack@eecs.umich.edu "Build variables for %s:\n" % variant_dir \ 11377756SAli.Saidi@ARM.com + sticky_vars.GenerateHelpText(env) 11382598SN/A 11395863Snate@binkert.org # Process variable settings. 11401858SN/A 11411858SN/A if not have_fenv and env['USE_FENV']: 11421858SN/A print "Warning: <fenv.h> not available; " \ 11435863Snate@binkert.org "forcing USE_FENV to False in", variant_dir + "." 11441858SN/A env['USE_FENV'] = False 11451858SN/A 11461858SN/A if not env['USE_FENV']: 11475863Snate@binkert.org print "Warning: No IEEE FP rounding mode control in", variant_dir + "." 11481871SN/A print " FP results may deviate slightly from other platforms." 11491858SN/A 11501858SN/A if env['EFENCE']: 11511858SN/A env.Append(LIBS=['efence']) 11521858SN/A 11535863Snate@binkert.org # Save sticky variable settings back to current variables file 11545863Snate@binkert.org sticky_vars.Save(current_vars_file, env) 11551869SN/A 11561965SN/A if env['USE_SSE2']: 11577739Sgblack@eecs.umich.edu env.Append(CCFLAGS=['-msse2']) 11581965SN/A 11599045SAli.Saidi@ARM.com if have_tcmalloc: 11609045SAli.Saidi@ARM.com env.Append(LIBS=['tcmalloc_minimal']) 11619045SAli.Saidi@ARM.com 11622761Sstever@eecs.umich.edu # The src/SConscript file sets up the build rules in 'env' according 11635863Snate@binkert.org # to the configured variables. It returns a list of environments, 11641869SN/A # one for each variant build (debug, opt, etc.) 11655863Snate@binkert.org envList = SConscript('src/SConscript', variant_dir = variant_path, 11662667Sstever@eecs.umich.edu exports = 'env') 11671869SN/A 11681869SN/A # Set up the regression tests for each build. 11692929Sktlim@umich.edu for e in envList: 11702929Sktlim@umich.edu SConscript('tests/SConscript', 11715863Snate@binkert.org variant_dir = joinpath(variant_path, 'tests', e.Label), 11722929Sktlim@umich.edu exports = { 'env' : e }, duplicate = False) 1173955SN/A 11748120Sgblack@eecs.umich.edu# base help text 11758120Sgblack@eecs.umich.eduHelp(''' 11768120Sgblack@eecs.umich.eduUsage: scons [scons options] [build variables] [target(s)] 11778120Sgblack@eecs.umich.edu 11788120Sgblack@eecs.umich.eduExtra scons options: 11798120Sgblack@eecs.umich.edu%(options)s 11808120Sgblack@eecs.umich.edu 11818120Sgblack@eecs.umich.eduGlobal build variables: 11828120Sgblack@eecs.umich.edu%(global_vars)s 11838120Sgblack@eecs.umich.edu 11848120Sgblack@eecs.umich.edu%(local_vars)s 11858120Sgblack@eecs.umich.edu''' % help_texts) 1186