SConstruct revision 9651
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 5089590Sandreas@sandberg.pp.se# According to the readme, tcmalloc works best if the compiler doesn't 5099590Sandreas@sandberg.pp.se# assume that we're using the builtin malloc and friends. These flags 5109590Sandreas@sandberg.pp.se# are compiler-specific, so we need to set them after we detect which 5119590Sandreas@sandberg.pp.se# compiler we're using. 5129590Sandreas@sandberg.pp.semain['TCMALLOC_CCFLAGS'] = [] 5139590Sandreas@sandberg.pp.se 5146654Snate@binkert.orgCXX_version = readCommand([main['CXX'],'--version'], exception=False) 5156654Snate@binkert.orgCXX_V = readCommand([main['CXX'],'-V'], exception=False) 5165871Snate@binkert.org 5176121Snate@binkert.orgmain['GCC'] = CXX_version and CXX_version.find('g++') >= 0 5188946Sandreas.hansson@arm.commain['CLANG'] = CXX_version and CXX_version.find('clang') >= 0 5199419Sandreas.hansson@arm.comif main['GCC'] + main['CLANG'] > 1: 5203940Ssaidi@eecs.umich.edu print 'Error: How can we have two at the same time?' 5213918Ssaidi@eecs.umich.edu Exit(1) 5223918Ssaidi@eecs.umich.edu 5231858SN/A# Set up default C++ compiler flags 5249556Sandreas.hansson@arm.comif main['GCC'] or main['CLANG']: 5259556Sandreas.hansson@arm.com # As gcc and clang share many flags, do the common parts here 5269556Sandreas.hansson@arm.com main.Append(CCFLAGS=['-pipe']) 5279556Sandreas.hansson@arm.com main.Append(CCFLAGS=['-fno-strict-aliasing']) 5289556Sandreas.hansson@arm.com # Enable -Wall and then disable the few warnings that we 5299556Sandreas.hansson@arm.com # consistently violate 5309556Sandreas.hansson@arm.com main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef']) 5319556Sandreas.hansson@arm.com # We always compile using C++11, but only gcc >= 4.7 and clang 3.1 5329556Sandreas.hansson@arm.com # actually use that name, so we stick with c++0x 5339556Sandreas.hansson@arm.com main.Append(CXXFLAGS=['-std=c++0x']) 5349556Sandreas.hansson@arm.com # Add selected sanity checks from -Wextra 5359556Sandreas.hansson@arm.com main.Append(CXXFLAGS=['-Wmissing-field-initializers', 5369556Sandreas.hansson@arm.com '-Woverloaded-virtual']) 5379556Sandreas.hansson@arm.comelse: 5389556Sandreas.hansson@arm.com print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal, 5399556Sandreas.hansson@arm.com print "Don't know what compiler options to use for your compiler." 5409556Sandreas.hansson@arm.com print termcap.Yellow + ' compiler:' + termcap.Normal, main['CXX'] 5419556Sandreas.hansson@arm.com print termcap.Yellow + ' version:' + termcap.Normal, 5429556Sandreas.hansson@arm.com if not CXX_version: 5439556Sandreas.hansson@arm.com print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\ 5449556Sandreas.hansson@arm.com termcap.Normal 5459556Sandreas.hansson@arm.com else: 5469556Sandreas.hansson@arm.com print CXX_version.replace('\n', '<nl>') 5479556Sandreas.hansson@arm.com print " If you're trying to use a compiler other than GCC" 5489556Sandreas.hansson@arm.com print " or clang, there appears to be something wrong with your" 5499556Sandreas.hansson@arm.com print " environment." 5509556Sandreas.hansson@arm.com print " " 5519556Sandreas.hansson@arm.com print " If you are trying to use a compiler other than those listed" 5529556Sandreas.hansson@arm.com print " above you will need to ease fix SConstruct and " 5539556Sandreas.hansson@arm.com print " src/SConscript to support that compiler." 5549556Sandreas.hansson@arm.com Exit(1) 5559556Sandreas.hansson@arm.com 5566121Snate@binkert.orgif main['GCC']: 5579420Sandreas.hansson@arm.com # Check for a supported version of gcc, >= 4.4 is needed for c++0x 5589420Sandreas.hansson@arm.com # support. See http://gcc.gnu.org/projects/cxx0x.html for details 5599420Sandreas.hansson@arm.com gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False) 5609420Sandreas.hansson@arm.com if compareVersions(gcc_version, "4.4") < 0: 5619420Sandreas.hansson@arm.com print 'Error: gcc version 4.4 or newer required.' 5629420Sandreas.hansson@arm.com print ' Installed version:', gcc_version 5639420Sandreas.hansson@arm.com Exit(1) 5649420Sandreas.hansson@arm.com 5659420Sandreas.hansson@arm.com main['GCC_VERSION'] = gcc_version 5669420Sandreas.hansson@arm.com 5679420Sandreas.hansson@arm.com # Check for versions with bugs 5687618SAli.Saidi@arm.com if not compareVersions(gcc_version, '4.4.1') or \ 5697618SAli.Saidi@arm.com not compareVersions(gcc_version, '4.4.2'): 5707618SAli.Saidi@arm.com print 'Info: Tree vectorizer in GCC 4.4.1 & 4.4.2 is buggy, disabling.' 5717739Sgblack@eecs.umich.edu main.Append(CCFLAGS=['-fno-tree-vectorize']) 5729227Sandreas.hansson@arm.com 5739227Sandreas.hansson@arm.com # LTO support is only really working properly from 4.6 and beyond 5749227Sandreas.hansson@arm.com if compareVersions(gcc_version, '4.6') >= 0: 5759227Sandreas.hansson@arm.com # Add the appropriate Link-Time Optimization (LTO) flags 5769227Sandreas.hansson@arm.com # unless LTO is explicitly turned off. Note that these flags 5779227Sandreas.hansson@arm.com # are only used by the fast target. 5789227Sandreas.hansson@arm.com if not GetOption('no_lto'): 5799227Sandreas.hansson@arm.com # Pass the LTO flag when compiling to produce GIMPLE 5809227Sandreas.hansson@arm.com # output, we merely create the flags here and only append 5819227Sandreas.hansson@arm.com # them later/ 5829227Sandreas.hansson@arm.com main['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')] 5839227Sandreas.hansson@arm.com 5849227Sandreas.hansson@arm.com # Use the same amount of jobs for LTO as we are running 5859227Sandreas.hansson@arm.com # scons with, we hardcode the use of the linker plugin 5869227Sandreas.hansson@arm.com # which requires either gold or GNU ld >= 2.21 5879227Sandreas.hansson@arm.com main['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs'), 5889227Sandreas.hansson@arm.com '-fuse-linker-plugin'] 5899227Sandreas.hansson@arm.com 5909590Sandreas@sandberg.pp.se main.Append(TCMALLOC_CCFLAGS=['-fno-builtin-malloc', '-fno-builtin-calloc', 5919590Sandreas@sandberg.pp.se '-fno-builtin-realloc', '-fno-builtin-free']) 5929590Sandreas@sandberg.pp.se 5938737Skoansin.tan@gmail.comelif main['CLANG']: 5949420Sandreas.hansson@arm.com # Check for a supported version of clang, >= 2.9 is needed to 5959420Sandreas.hansson@arm.com # support similar features as gcc 4.4. See 5969420Sandreas.hansson@arm.com # http://clang.llvm.org/cxx_status.html for details 5978737Skoansin.tan@gmail.com clang_version_re = re.compile(".* version (\d+\.\d+)") 5988737Skoansin.tan@gmail.com clang_version_match = clang_version_re.match(CXX_version) 5998737Skoansin.tan@gmail.com if (clang_version_match): 6008737Skoansin.tan@gmail.com clang_version = clang_version_match.groups()[0] 6018737Skoansin.tan@gmail.com if compareVersions(clang_version, "2.9") < 0: 6028737Skoansin.tan@gmail.com print 'Error: clang version 2.9 or newer required.' 6038737Skoansin.tan@gmail.com print ' Installed version:', clang_version 6048737Skoansin.tan@gmail.com Exit(1) 6058737Skoansin.tan@gmail.com else: 6068737Skoansin.tan@gmail.com print 'Error: Unable to determine clang version.' 6078737Skoansin.tan@gmail.com Exit(1) 6088737Skoansin.tan@gmail.com 6099556Sandreas.hansson@arm.com # clang has a few additional warnings that we disable, 6109556Sandreas.hansson@arm.com # tautological comparisons are allowed due to unsigned integers 6119556Sandreas.hansson@arm.com # being compared to constants that happen to be 0, and extraneous 6129556Sandreas.hansson@arm.com # parantheses are allowed due to Ruby's printing of the AST, 6139556Sandreas.hansson@arm.com # finally self assignments are allowed as the generated CPU code 6149556Sandreas.hansson@arm.com # is relying on this 6159556Sandreas.hansson@arm.com main.Append(CCFLAGS=['-Wno-tautological-compare', 6169556Sandreas.hansson@arm.com '-Wno-parentheses', 6179556Sandreas.hansson@arm.com '-Wno-self-assign']) 6189556Sandreas.hansson@arm.com 6199590Sandreas@sandberg.pp.se main.Append(TCMALLOC_CCFLAGS=['-fno-builtin']) 6209590Sandreas@sandberg.pp.se 6219420Sandreas.hansson@arm.com # On Mac OS X/Darwin we need to also use libc++ (part of XCode) as 6229420Sandreas.hansson@arm.com # opposed to libstdc++ to make the transition from TR1 to 6239420Sandreas.hansson@arm.com # C++11. See http://libcxx.llvm.org. However, clang has chosen a 6249420Sandreas.hansson@arm.com # strict implementation of the C++11 standard, and does not allow 6259420Sandreas.hansson@arm.com # incomplete types in template arguments (besides unique_ptr and 6269420Sandreas.hansson@arm.com # shared_ptr), and the libc++ STL containers create problems in 6279420Sandreas.hansson@arm.com # combination with the current gem5 code. For now, we stick with 6289420Sandreas.hansson@arm.com # libstdc++ and use the TR1 namespace. 6299420Sandreas.hansson@arm.com # if sys.platform == "darwin": 6309420Sandreas.hansson@arm.com # main.Append(CXXFLAGS=['-stdlib=libc++']) 6318946Sandreas.hansson@arm.com 6323918Ssaidi@eecs.umich.eduelse: 6339068SAli.Saidi@ARM.com print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal, 6349068SAli.Saidi@ARM.com print "Don't know what compiler options to use for your compiler." 6359068SAli.Saidi@ARM.com print termcap.Yellow + ' compiler:' + termcap.Normal, main['CXX'] 6369068SAli.Saidi@ARM.com print termcap.Yellow + ' version:' + termcap.Normal, 6379068SAli.Saidi@ARM.com if not CXX_version: 6389068SAli.Saidi@ARM.com print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\ 6399068SAli.Saidi@ARM.com termcap.Normal 6409068SAli.Saidi@ARM.com else: 6419068SAli.Saidi@ARM.com print CXX_version.replace('\n', '<nl>') 6429419Sandreas.hansson@arm.com print " If you're trying to use a compiler other than GCC" 6439068SAli.Saidi@ARM.com print " or clang, there appears to be something wrong with your" 6449068SAli.Saidi@ARM.com print " environment." 6459068SAli.Saidi@ARM.com print " " 6469068SAli.Saidi@ARM.com print " If you are trying to use a compiler other than those listed" 6479068SAli.Saidi@ARM.com print " above you will need to ease fix SConstruct and " 6489068SAli.Saidi@ARM.com print " src/SConscript to support that compiler." 6493918Ssaidi@eecs.umich.edu Exit(1) 6503918Ssaidi@eecs.umich.edu 6516157Snate@binkert.org# Set up common yacc/bison flags (needed for Ruby) 6526157Snate@binkert.orgmain['YACCFLAGS'] = '-d' 6536157Snate@binkert.orgmain['YACCHXXFILESUFFIX'] = '.hh' 6546157Snate@binkert.org 6555397Ssaidi@eecs.umich.edu# Do this after we save setting back, or else we'll tack on an 6565397Ssaidi@eecs.umich.edu# extra 'qdo' every time we run scons. 6576121Snate@binkert.orgif main['BATCH']: 6586121Snate@binkert.org main['CC'] = main['BATCH_CMD'] + ' ' + main['CC'] 6596121Snate@binkert.org main['CXX'] = main['BATCH_CMD'] + ' ' + main['CXX'] 6606121Snate@binkert.org main['AS'] = main['BATCH_CMD'] + ' ' + main['AS'] 6616121Snate@binkert.org main['AR'] = main['BATCH_CMD'] + ' ' + main['AR'] 6626121Snate@binkert.org main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB'] 6635397Ssaidi@eecs.umich.edu 6641851SN/Aif sys.platform == 'cygwin': 6651851SN/A # cygwin has some header file issues... 6667739Sgblack@eecs.umich.edu main.Append(CCFLAGS=["-Wno-uninitialized"]) 667955SN/A 6689396Sandreas.hansson@arm.com# Check for the protobuf compiler 6699396Sandreas.hansson@arm.comprotoc_version = readCommand([main['PROTOC'], '--version'], 6709396Sandreas.hansson@arm.com exception='').split() 6719396Sandreas.hansson@arm.com 6729396Sandreas.hansson@arm.com# First two words should be "libprotoc x.y.z" 6739396Sandreas.hansson@arm.comif len(protoc_version) < 2 or protoc_version[0] != 'libprotoc': 6749396Sandreas.hansson@arm.com print termcap.Yellow + termcap.Bold + \ 6759396Sandreas.hansson@arm.com 'Warning: Protocol buffer compiler (protoc) not found.\n' + \ 6769396Sandreas.hansson@arm.com ' Please install protobuf-compiler for tracing support.' + \ 6779396Sandreas.hansson@arm.com termcap.Normal 6789396Sandreas.hansson@arm.com main['PROTOC'] = False 6799396Sandreas.hansson@arm.comelse: 6809396Sandreas.hansson@arm.com # Based on the availability of the compress stream wrappers, 6819396Sandreas.hansson@arm.com # require 2.1.0 6829396Sandreas.hansson@arm.com min_protoc_version = '2.1.0' 6839396Sandreas.hansson@arm.com if compareVersions(protoc_version[1], min_protoc_version) < 0: 6849477Sandreas.hansson@arm.com print termcap.Yellow + termcap.Bold + \ 6859477Sandreas.hansson@arm.com 'Warning: protoc version', min_protoc_version, \ 6869477Sandreas.hansson@arm.com 'or newer required.\n' + \ 6879477Sandreas.hansson@arm.com ' Installed version:', protoc_version[1], \ 6889477Sandreas.hansson@arm.com termcap.Normal 6899477Sandreas.hansson@arm.com main['PROTOC'] = False 6909477Sandreas.hansson@arm.com else: 6919477Sandreas.hansson@arm.com # Attempt to determine the appropriate include path and 6929477Sandreas.hansson@arm.com # library path using pkg-config, that means we also need to 6939477Sandreas.hansson@arm.com # check for pkg-config. Note that it is possible to use 6949477Sandreas.hansson@arm.com # protobuf without the involvement of pkg-config. Later on we 6959477Sandreas.hansson@arm.com # check go a library config check and at that point the test 6969477Sandreas.hansson@arm.com # will fail if libprotobuf cannot be found. 6979477Sandreas.hansson@arm.com if readCommand(['pkg-config', '--version'], exception=''): 6989477Sandreas.hansson@arm.com try: 6999477Sandreas.hansson@arm.com # Attempt to establish what linking flags to add for protobuf 7009477Sandreas.hansson@arm.com # using pkg-config 7019477Sandreas.hansson@arm.com main.ParseConfig('pkg-config --cflags --libs-only-L protobuf') 7029477Sandreas.hansson@arm.com except: 7039477Sandreas.hansson@arm.com print termcap.Yellow + termcap.Bold + \ 7049477Sandreas.hansson@arm.com 'Warning: pkg-config could not get protobuf flags.' + \ 7059477Sandreas.hansson@arm.com termcap.Normal 7069396Sandreas.hansson@arm.com 7073053Sstever@eecs.umich.edu# Check for SWIG 7086121Snate@binkert.orgif not main.has_key('SWIG'): 7093053Sstever@eecs.umich.edu print 'Error: SWIG utility not found.' 7103053Sstever@eecs.umich.edu print ' Please install (see http://www.swig.org) and retry.' 7113053Sstever@eecs.umich.edu Exit(1) 7123053Sstever@eecs.umich.edu 7133053Sstever@eecs.umich.edu# Check for appropriate SWIG version 7149072Sandreas.hansson@arm.comswig_version = readCommand([main['SWIG'], '-version'], exception='').split() 7153053Sstever@eecs.umich.edu# First 3 words should be "SWIG Version x.y.z" 7164742Sstever@eecs.umich.eduif len(swig_version) < 3 or \ 7174742Sstever@eecs.umich.edu swig_version[0] != 'SWIG' or swig_version[1] != 'Version': 7183053Sstever@eecs.umich.edu print 'Error determining SWIG version.' 7193053Sstever@eecs.umich.edu Exit(1) 7203053Sstever@eecs.umich.edu 7218960Ssteve.reinhardt@amd.commin_swig_version = '1.3.34' 7226654Snate@binkert.orgif compareVersions(swig_version[2], min_swig_version) < 0: 7233053Sstever@eecs.umich.edu print 'Error: SWIG version', min_swig_version, 'or newer required.' 7243053Sstever@eecs.umich.edu print ' Installed version:', swig_version[2] 7253053Sstever@eecs.umich.edu Exit(1) 7263053Sstever@eecs.umich.edu 7279585Sandreas@sandberg.pp.seif swig_version[2] == "2.0.9": 7289585Sandreas@sandberg.pp.se print '\n' + termcap.Yellow + termcap.Bold + \ 7299585Sandreas@sandberg.pp.se 'Warning: SWIG version 2.0.9 sometimes generates broken code.\n' + \ 7309585Sandreas@sandberg.pp.se termcap.Normal + \ 7319585Sandreas@sandberg.pp.se 'This problem only affects some platforms and some Python\n' + \ 7329585Sandreas@sandberg.pp.se 'versions. See the following SWIG bug report for details:\n' + \ 7339585Sandreas@sandberg.pp.se 'http://sourceforge.net/p/swig/bugs/1297/\n' 7349585Sandreas@sandberg.pp.se 7359585Sandreas@sandberg.pp.se 7362667Sstever@eecs.umich.edu# Set up SWIG flags & scanner 7374554Sbinkertn@umich.eduswig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS') 7386121Snate@binkert.orgmain.Append(SWIGFLAGS=swig_flags) 7392667Sstever@eecs.umich.edu 7404554Sbinkertn@umich.edu# filter out all existing swig scanners, they mess up the dependency 7414554Sbinkertn@umich.edu# stuff for some reason 7424554Sbinkertn@umich.eduscanners = [] 7436121Snate@binkert.orgfor scanner in main['SCANNERS']: 7444554Sbinkertn@umich.edu skeys = scanner.skeys 7454554Sbinkertn@umich.edu if skeys == '.i': 7464554Sbinkertn@umich.edu continue 7474781Snate@binkert.org 7484554Sbinkertn@umich.edu if isinstance(skeys, (list, tuple)) and '.i' in skeys: 7494554Sbinkertn@umich.edu continue 7502667Sstever@eecs.umich.edu 7514554Sbinkertn@umich.edu scanners.append(scanner) 7524554Sbinkertn@umich.edu 7534554Sbinkertn@umich.edu# add the new swig scanner that we like better 7544554Sbinkertn@umich.edufrom SCons.Scanner import ClassicCPP as CPPScanner 7552667Sstever@eecs.umich.eduswig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")' 7564554Sbinkertn@umich.eduscanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re)) 7572667Sstever@eecs.umich.edu 7584554Sbinkertn@umich.edu# replace the scanners list that has what we want 7596121Snate@binkert.orgmain['SCANNERS'] = scanners 7602667Sstever@eecs.umich.edu 7615522Snate@binkert.org# Add a custom Check function to the Configure context so that we can 7625522Snate@binkert.org# figure out if the compiler adds leading underscores to global 7635522Snate@binkert.org# variables. This is needed for the autogenerated asm files that we 7645522Snate@binkert.org# use for embedding the python code. 7655522Snate@binkert.orgdef CheckLeading(context): 7665522Snate@binkert.org context.Message("Checking for leading underscore in global variables...") 7675522Snate@binkert.org # 1) Define a global variable called x from asm so the C compiler 7685522Snate@binkert.org # won't change the symbol at all. 7695522Snate@binkert.org # 2) Declare that variable. 7705522Snate@binkert.org # 3) Use the variable 7715522Snate@binkert.org # 7725522Snate@binkert.org # If the compiler prepends an underscore, this will successfully 7735522Snate@binkert.org # link because the external symbol 'x' will be called '_x' which 7745522Snate@binkert.org # was defined by the asm statement. If the compiler does not 7755522Snate@binkert.org # prepend an underscore, this will not successfully link because 7765522Snate@binkert.org # '_x' will have been defined by assembly, while the C portion of 7775522Snate@binkert.org # the code will be trying to use 'x' 7785522Snate@binkert.org ret = context.TryLink(''' 7795522Snate@binkert.org asm(".globl _x; _x: .byte 0"); 7805522Snate@binkert.org extern int x; 7815522Snate@binkert.org int main() { return x; } 7825522Snate@binkert.org ''', extension=".c") 7835522Snate@binkert.org context.env.Append(LEADING_UNDERSCORE=ret) 7845522Snate@binkert.org context.Result(ret) 7855522Snate@binkert.org return ret 7865522Snate@binkert.org 7872638Sstever@eecs.umich.edu# Platform-specific configuration. Note again that we assume that all 7882638Sstever@eecs.umich.edu# builds under a given build root run on the same host platform. 7896121Snate@binkert.orgconf = Configure(main, 7903716Sstever@eecs.umich.edu conf_dir = joinpath(build_root, '.scons_config'), 7915522Snate@binkert.org log_file = joinpath(build_root, 'scons_config.log'), 7929420Sandreas.hansson@arm.com custom_tests = { 'CheckLeading' : CheckLeading }) 7935522Snate@binkert.org 7945522Snate@binkert.org# Check for leading underscores. Don't really need to worry either 7955522Snate@binkert.org# way so don't need to check the return code. 7965522Snate@binkert.orgconf.CheckLeading() 7971858SN/A 7985227Ssaidi@eecs.umich.edu# Check if we should compile a 64 bit binary on Mac OS X/Darwin 7995227Ssaidi@eecs.umich.edutry: 8005227Ssaidi@eecs.umich.edu import platform 8015227Ssaidi@eecs.umich.edu uname = platform.uname() 8026654Snate@binkert.org if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0: 8036654Snate@binkert.org if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]): 8047769SAli.Saidi@ARM.com main.Append(CCFLAGS=['-arch', 'x86_64']) 8057769SAli.Saidi@ARM.com main.Append(CFLAGS=['-arch', 'x86_64']) 8067769SAli.Saidi@ARM.com main.Append(LINKFLAGS=['-arch', 'x86_64']) 8077769SAli.Saidi@ARM.com main.Append(ASFLAGS=['-arch', 'x86_64']) 8085227Ssaidi@eecs.umich.eduexcept: 8095227Ssaidi@eecs.umich.edu pass 8105227Ssaidi@eecs.umich.edu 8115204Sstever@gmail.com# Recent versions of scons substitute a "Null" object for Configure() 8125204Sstever@gmail.com# when configuration isn't necessary, e.g., if the "--help" option is 8135204Sstever@gmail.com# present. Unfortuantely this Null object always returns false, 8145204Sstever@gmail.com# breaking all our configuration checks. We replace it with our own 8155204Sstever@gmail.com# more optimistic null object that returns True instead. 8165204Sstever@gmail.comif not conf: 8175204Sstever@gmail.com def NullCheck(*args, **kwargs): 8185204Sstever@gmail.com return True 8195204Sstever@gmail.com 8205204Sstever@gmail.com class NullConf: 8215204Sstever@gmail.com def __init__(self, env): 8225204Sstever@gmail.com self.env = env 8235204Sstever@gmail.com def Finish(self): 8245204Sstever@gmail.com return self.env 8255204Sstever@gmail.com def __getattr__(self, mname): 8265204Sstever@gmail.com return NullCheck 8275204Sstever@gmail.com 8286121Snate@binkert.org conf = NullConf(main) 8295204Sstever@gmail.com 8303118Sstever@eecs.umich.edu# Find Python include and library directories for embedding the 8313118Sstever@eecs.umich.edu# interpreter. For consistency, we will use the same Python 8323118Sstever@eecs.umich.edu# installation used to run scons (and thus this script). If you want 8333118Sstever@eecs.umich.edu# to link in an alternate version, see above for instructions on how 8343118Sstever@eecs.umich.edu# to invoke scons with a different copy of the Python interpreter. 8355863Snate@binkert.orgfrom distutils import sysconfig 8363118Sstever@eecs.umich.edu 8375863Snate@binkert.orgpy_getvar = sysconfig.get_config_var 8383118Sstever@eecs.umich.edu 8397457Snate@binkert.orgpy_debug = getattr(sys, 'pydebug', False) 8407457Snate@binkert.orgpy_version = 'python' + py_getvar('VERSION') + (py_debug and "_d" or "") 8415863Snate@binkert.org 8425863Snate@binkert.orgpy_general_include = sysconfig.get_python_inc() 8435863Snate@binkert.orgpy_platform_include = sysconfig.get_python_inc(plat_specific=True) 8445863Snate@binkert.orgpy_includes = [ py_general_include ] 8455863Snate@binkert.orgif py_platform_include != py_general_include: 8465863Snate@binkert.org py_includes.append(py_platform_include) 8475863Snate@binkert.org 8486003Snate@binkert.orgpy_lib_path = [ py_getvar('LIBDIR') ] 8495863Snate@binkert.org# add the prefix/lib/pythonX.Y/config dir, but only if there is no 8505863Snate@binkert.org# shared library in prefix/lib/. 8515863Snate@binkert.orgif not py_getvar('Py_ENABLE_SHARED'): 8526120Snate@binkert.org py_lib_path.append(py_getvar('LIBPL')) 8539588Sandreas@sandberg.pp.se # Python requires the flags in LINKFORSHARED to be added the 8549588Sandreas@sandberg.pp.se # linker flags when linking with a statically with Python. Failing 8559588Sandreas@sandberg.pp.se # to do so can lead to errors from the Python's dynamic module 8569588Sandreas@sandberg.pp.se # loader at start up. 8579588Sandreas@sandberg.pp.se main.Append(LINKFLAGS=[py_getvar('LINKFORSHARED').split()]) 8585863Snate@binkert.org 8595863Snate@binkert.orgpy_libs = [] 8605863Snate@binkert.orgfor lib in py_getvar('LIBS').split() + py_getvar('SYSLIBS').split(): 8618655Sandreas.hansson@arm.com if not lib.startswith('-l'): 8628655Sandreas.hansson@arm.com # Python requires some special flags to link (e.g. -framework 8638655Sandreas.hansson@arm.com # common on OS X systems), assume appending preserves order 8648655Sandreas.hansson@arm.com main.Append(LINKFLAGS=[lib]) 8658655Sandreas.hansson@arm.com else: 8668655Sandreas.hansson@arm.com lib = lib[2:] 8678655Sandreas.hansson@arm.com if lib not in py_libs: 8688655Sandreas.hansson@arm.com py_libs.append(lib) 8696120Snate@binkert.orgpy_libs.append(py_version) 8705863Snate@binkert.org 8716121Snate@binkert.orgmain.Append(CPPPATH=py_includes) 8726121Snate@binkert.orgmain.Append(LIBPATH=py_lib_path) 8735863Snate@binkert.org 8747727SAli.Saidi@ARM.com# Cache build files in the supplied directory. 8757727SAli.Saidi@ARM.comif main['M5_BUILD_CACHE']: 8767727SAli.Saidi@ARM.com print 'Using build cache located at', main['M5_BUILD_CACHE'] 8777727SAli.Saidi@ARM.com CacheDir(main['M5_BUILD_CACHE']) 8787727SAli.Saidi@ARM.com 8797727SAli.Saidi@ARM.com 8805863Snate@binkert.org# verify that this stuff works 8813118Sstever@eecs.umich.eduif not conf.CheckHeader('Python.h', '<>'): 8825863Snate@binkert.org print "Error: can't find Python.h header in", py_includes 8839239Sandreas.hansson@arm.com print "Install Python headers (package python-dev on Ubuntu and RedHat)" 8843118Sstever@eecs.umich.edu Exit(1) 8853118Sstever@eecs.umich.edu 8865863Snate@binkert.orgfor lib in py_libs: 8875863Snate@binkert.org if not conf.CheckLib(lib): 8885863Snate@binkert.org print "Error: can't find library %s required by python" % lib 8895863Snate@binkert.org Exit(1) 8903118Sstever@eecs.umich.edu 8913483Ssaidi@eecs.umich.edu# On Solaris you need to use libsocket for socket ops 8923494Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'): 8933494Ssaidi@eecs.umich.edu if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'): 8943483Ssaidi@eecs.umich.edu print "Can't find library with socket calls (e.g. accept())" 8953483Ssaidi@eecs.umich.edu Exit(1) 8963483Ssaidi@eecs.umich.edu 8973053Sstever@eecs.umich.edu# Check for zlib. If the check passes, libz will be automatically 8983053Sstever@eecs.umich.edu# added to the LIBS environment variable. 8993918Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'): 9003053Sstever@eecs.umich.edu print 'Error: did not find needed zlib compression library '\ 9013053Sstever@eecs.umich.edu 'and/or zlib.h header file.' 9023053Sstever@eecs.umich.edu print ' Please install zlib and try again.' 9033053Sstever@eecs.umich.edu Exit(1) 9043053Sstever@eecs.umich.edu 9059396Sandreas.hansson@arm.com# If we have the protobuf compiler, also make sure we have the 9069396Sandreas.hansson@arm.com# development libraries. If the check passes, libprotobuf will be 9079396Sandreas.hansson@arm.com# automatically added to the LIBS environment variable. After 9089396Sandreas.hansson@arm.com# this, we can use the HAVE_PROTOBUF flag to determine if we have 9099396Sandreas.hansson@arm.com# got both protoc and libprotobuf available. 9109396Sandreas.hansson@arm.commain['HAVE_PROTOBUF'] = main['PROTOC'] and \ 9119396Sandreas.hansson@arm.com conf.CheckLibWithHeader('protobuf', 'google/protobuf/message.h', 9129396Sandreas.hansson@arm.com 'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;') 9139396Sandreas.hansson@arm.com 9149477Sandreas.hansson@arm.com# If we have the compiler but not the library, print another warning. 9159396Sandreas.hansson@arm.comif main['PROTOC'] and not main['HAVE_PROTOBUF']: 9169477Sandreas.hansson@arm.com print termcap.Yellow + termcap.Bold + \ 9179477Sandreas.hansson@arm.com 'Warning: did not find protocol buffer library and/or headers.\n' + \ 9189477Sandreas.hansson@arm.com ' Please install libprotobuf-dev for tracing support.' + \ 9199477Sandreas.hansson@arm.com termcap.Normal 9209396Sandreas.hansson@arm.com 9217840Snate@binkert.org# Check for librt. 9227865Sgblack@eecs.umich.eduhave_posix_clock = \ 9237865Sgblack@eecs.umich.edu conf.CheckLibWithHeader(None, 'time.h', 'C', 9247865Sgblack@eecs.umich.edu 'clock_nanosleep(0,0,NULL,NULL);') or \ 9257865Sgblack@eecs.umich.edu conf.CheckLibWithHeader('rt', 'time.h', 'C', 9267865Sgblack@eecs.umich.edu 'clock_nanosleep(0,0,NULL,NULL);') 9277840Snate@binkert.org 9289591Sandreas@sandberg.pp.seif conf.CheckLib('tcmalloc'): 9299591Sandreas@sandberg.pp.se main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS']) 9309591Sandreas@sandberg.pp.seelif conf.CheckLib('tcmalloc_minimal'): 9319590Sandreas@sandberg.pp.se main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS']) 9329590Sandreas@sandberg.pp.seelse: 9339045SAli.Saidi@ARM.com print termcap.Yellow + termcap.Bold + \ 9349045SAli.Saidi@ARM.com "You can get a 12% performance improvement by installing tcmalloc "\ 9359071Sandreas.hansson@arm.com "(libgoogle-perftools-dev package on Ubuntu or RedHat)." + \ 9369071Sandreas.hansson@arm.com termcap.Normal 9379045SAli.Saidi@ARM.com 9387840Snate@binkert.orgif not have_posix_clock: 9397840Snate@binkert.org print "Can't find library for POSIX clocks." 9407840Snate@binkert.org 9411858SN/A# Check for <fenv.h> (C99 FP environment control) 9421858SN/Ahave_fenv = conf.CheckHeader('fenv.h', '<>') 9431858SN/Aif not have_fenv: 9441858SN/A print "Warning: Header file <fenv.h> not found." 9451858SN/A print " This host has no IEEE FP rounding mode control." 9461858SN/A 9479651SAndreas.Sandberg@ARM.com# Check if we should enable KVM-based hardware virtualization 9489651SAndreas.Sandberg@ARM.comhave_kvm = conf.CheckHeader('linux/kvm.h', '<>') 9499651SAndreas.Sandberg@ARM.comif not have_kvm: 9509651SAndreas.Sandberg@ARM.com print "Info: Header file <linux/kvm.h> not found, " \ 9519651SAndreas.Sandberg@ARM.com "disabling KVM support." 9529651SAndreas.Sandberg@ARM.com 9539651SAndreas.Sandberg@ARM.com# Check if the requested target ISA is compatible with the host 9549651SAndreas.Sandberg@ARM.comdef is_isa_kvm_compatible(isa): 9559651SAndreas.Sandberg@ARM.com isa_comp_table = { 9569651SAndreas.Sandberg@ARM.com } 9579651SAndreas.Sandberg@ARM.com try: 9589651SAndreas.Sandberg@ARM.com import platform 9599651SAndreas.Sandberg@ARM.com host_isa = platform.machine() 9609651SAndreas.Sandberg@ARM.com except: 9619651SAndreas.Sandberg@ARM.com print "Warning: Failed to determine host ISA." 9629651SAndreas.Sandberg@ARM.com return False 9639651SAndreas.Sandberg@ARM.com 9649651SAndreas.Sandberg@ARM.com return host_isa in isa_comp_table.get(isa, []) 9659651SAndreas.Sandberg@ARM.com 9669651SAndreas.Sandberg@ARM.com 9675863Snate@binkert.org###################################################################### 9685863Snate@binkert.org# 9695863Snate@binkert.org# Finish the configuration 9705863Snate@binkert.org# 9716121Snate@binkert.orgmain = conf.Finish() 9721858SN/A 9735863Snate@binkert.org###################################################################### 9745863Snate@binkert.org# 9755863Snate@binkert.org# Collect all non-global variables 9765863Snate@binkert.org# 9775863Snate@binkert.org 9782139SN/A# Define the universe of supported ISAs 9794202Sbinkertn@umich.eduall_isa_list = [ ] 9804202Sbinkertn@umich.eduExport('all_isa_list') 9812139SN/A 9826994Snate@binkert.orgclass CpuModel(object): 9836994Snate@binkert.org '''The CpuModel class encapsulates everything the ISA parser needs to 9846994Snate@binkert.org know about a particular CPU model.''' 9856994Snate@binkert.org 9866994Snate@binkert.org # Dict of available CPU model objects. Accessible as CpuModel.dict. 9876994Snate@binkert.org dict = {} 9886994Snate@binkert.org list = [] 9896994Snate@binkert.org defaults = [] 9906994Snate@binkert.org 9916994Snate@binkert.org # Constructor. Automatically adds models to CpuModel.dict. 9926994Snate@binkert.org def __init__(self, name, filename, includes, strings, default=False): 9936994Snate@binkert.org self.name = name # name of model 9946994Snate@binkert.org self.filename = filename # filename for output exec code 9956994Snate@binkert.org self.includes = includes # include files needed in exec file 9966994Snate@binkert.org # The 'strings' dict holds all the per-CPU symbols we can 9976994Snate@binkert.org # substitute into templates etc. 9986994Snate@binkert.org self.strings = strings 9996994Snate@binkert.org 10006994Snate@binkert.org # This cpu is enabled by default 10016994Snate@binkert.org self.default = default 10026994Snate@binkert.org 10036994Snate@binkert.org # Add self to dict 10046994Snate@binkert.org if name in CpuModel.dict: 10056994Snate@binkert.org raise AttributeError, "CpuModel '%s' already registered" % name 10066994Snate@binkert.org CpuModel.dict[name] = self 10076994Snate@binkert.org CpuModel.list.append(name) 10086994Snate@binkert.org 10096994Snate@binkert.orgExport('CpuModel') 10102155SN/A 10115863Snate@binkert.org# Sticky variables get saved in the variables file so they persist from 10121869SN/A# one invocation to the next (unless overridden, in which case the new 10131869SN/A# value becomes sticky). 10145863Snate@binkert.orgsticky_vars = Variables(args=ARGUMENTS) 10155863Snate@binkert.orgExport('sticky_vars') 10164202Sbinkertn@umich.edu 10176108Snate@binkert.org# Sticky variables that should be exported 10186108Snate@binkert.orgexport_vars = [] 10196108Snate@binkert.orgExport('export_vars') 10206108Snate@binkert.org 10219219Spower.jg@gmail.com# For Ruby 10229219Spower.jg@gmail.comall_protocols = [] 10239219Spower.jg@gmail.comExport('all_protocols') 10249219Spower.jg@gmail.comprotocol_dirs = [] 10259219Spower.jg@gmail.comExport('protocol_dirs') 10269219Spower.jg@gmail.comslicc_includes = [] 10279219Spower.jg@gmail.comExport('slicc_includes') 10289219Spower.jg@gmail.com 10294202Sbinkertn@umich.edu# Walk the tree and execute all SConsopts scripts that wil add to the 10305863Snate@binkert.org# above variables 10318474Sgblack@eecs.umich.eduif not GetOption('verbose'): 10328474Sgblack@eecs.umich.edu print "Reading SConsopts" 10335742Snate@binkert.orgfor bdir in [ base_dir ] + extras_dir_list: 10348268Ssteve.reinhardt@amd.com if not isdir(bdir): 10358268Ssteve.reinhardt@amd.com print "Error: directory '%s' does not exist" % bdir 10368268Ssteve.reinhardt@amd.com Exit(1) 10375742Snate@binkert.org for root, dirs, files in os.walk(bdir): 10385341Sstever@gmail.com if 'SConsopts' in files: 10398474Sgblack@eecs.umich.edu if GetOption('verbose'): 10408474Sgblack@eecs.umich.edu print "Reading", joinpath(root, 'SConsopts') 10415342Sstever@gmail.com SConscript(joinpath(root, 'SConsopts')) 10424202Sbinkertn@umich.edu 10434202Sbinkertn@umich.eduall_isa_list.sort() 10444202Sbinkertn@umich.edu 10455863Snate@binkert.orgsticky_vars.AddVariables( 10465863Snate@binkert.org EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list), 10476994Snate@binkert.org ListVariable('CPU_MODELS', 'CPU models', 10486994Snate@binkert.org sorted(n for n,m in CpuModel.dict.iteritems() if m.default), 10496994Snate@binkert.org sorted(CpuModel.list)), 10505863Snate@binkert.org BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger', 10515863Snate@binkert.org False), 10525863Snate@binkert.org BoolVariable('SS_COMPATIBLE_FP', 10535863Snate@binkert.org 'Make floating-point results compatible with SimpleScalar', 10545863Snate@binkert.org False), 10555863Snate@binkert.org BoolVariable('USE_SSE2', 10565863Snate@binkert.org 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts', 10575863Snate@binkert.org False), 10587840Snate@binkert.org BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock), 10595863Snate@binkert.org BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv), 10605952Ssaidi@eecs.umich.edu BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False), 10619651SAndreas.Sandberg@ARM.com BoolVariable('USE_KVM', 'Enable hardware virtualized (KVM) CPU models', have_kvm), 10629219Spower.jg@gmail.com EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None', 10639219Spower.jg@gmail.com all_protocols), 10641869SN/A ) 10651858SN/A 10665863Snate@binkert.org# These variables get exported to #defines in config/*.hh (see src/SConscript). 10679420Sandreas.hansson@arm.comexport_vars += ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'CP_ANNOTATE', 10689420Sandreas.hansson@arm.com 'USE_POSIX_CLOCK', 'PROTOCOL', 'HAVE_PROTOBUF'] 10691858SN/A 1070955SN/A################################################### 1071955SN/A# 10721869SN/A# Define a SCons builder for configuration flag headers. 10731869SN/A# 10741869SN/A################################################### 10751869SN/A 10761869SN/A# This function generates a config header file that #defines the 10775863Snate@binkert.org# variable symbol to the current variable setting (0 or 1). The source 10785863Snate@binkert.org# operands are the name of the variable and a Value node containing the 10795863Snate@binkert.org# value of the variable. 10801869SN/Adef build_config_file(target, source, env): 10815863Snate@binkert.org (variable, value) = [s.get_contents() for s in source] 10821869SN/A f = file(str(target[0]), 'w') 10835863Snate@binkert.org print >> f, '#define', variable, value 10841869SN/A f.close() 10851869SN/A return None 10861869SN/A 10871869SN/A# Combine the two functions into a scons Action object. 10888483Sgblack@eecs.umich.educonfig_action = MakeAction(build_config_file, Transform("CONFIG H", 2)) 10891869SN/A 10901869SN/A# The emitter munges the source & target node lists to reflect what 10911869SN/A# we're really doing. 10921869SN/Adef config_emitter(target, source, env): 10935863Snate@binkert.org # extract variable name from Builder arg 10945863Snate@binkert.org variable = str(target[0]) 10951869SN/A # True target is config header file 10965863Snate@binkert.org target = joinpath('config', variable.lower() + '.hh') 10975863Snate@binkert.org val = env[variable] 10983356Sbinkertn@umich.edu if isinstance(val, bool): 10993356Sbinkertn@umich.edu # Force value to 0/1 11003356Sbinkertn@umich.edu val = int(val) 11013356Sbinkertn@umich.edu elif isinstance(val, str): 11023356Sbinkertn@umich.edu val = '"' + val + '"' 11034781Snate@binkert.org 11045863Snate@binkert.org # Sources are variable name & value (packaged in SCons Value nodes) 11055863Snate@binkert.org return ([target], [Value(variable), Value(val)]) 11061869SN/A 11071869SN/Aconfig_builder = Builder(emitter = config_emitter, action = config_action) 11081869SN/A 11096121Snate@binkert.orgmain.Append(BUILDERS = { 'ConfigFile' : config_builder }) 11101869SN/A 11112638Sstever@eecs.umich.edu# libelf build is shared across all configs in the build root. 11126121Snate@binkert.orgmain.SConscript('ext/libelf/SConscript', 11136121Snate@binkert.org variant_dir = joinpath(build_root, 'libelf')) 11142638Sstever@eecs.umich.edu 11155749Scws3k@cs.virginia.edu# gzstream build is shared across all configs in the build root. 11166121Snate@binkert.orgmain.SConscript('ext/gzstream/SConscript', 11176121Snate@binkert.org variant_dir = joinpath(build_root, 'gzstream')) 11185749Scws3k@cs.virginia.edu 11199537Satgutier@umich.edu# libfdt build is shared across all configs in the build root. 11209537Satgutier@umich.edumain.SConscript('ext/libfdt/SConscript', 11219537Satgutier@umich.edu variant_dir = joinpath(build_root, 'libfdt')) 11229537Satgutier@umich.edu 11231869SN/A################################################### 11241869SN/A# 11253546Sgblack@eecs.umich.edu# This function is used to set up a directory with switching headers 11263546Sgblack@eecs.umich.edu# 11273546Sgblack@eecs.umich.edu################################################### 11283546Sgblack@eecs.umich.edu 11296121Snate@binkert.orgmain['ALL_ISA_LIST'] = all_isa_list 11305863Snate@binkert.orgdef make_switching_dir(dname, switch_headers, env): 11313546Sgblack@eecs.umich.edu # Generate the header. target[0] is the full path of the output 11323546Sgblack@eecs.umich.edu # header to generate. 'source' is a dummy variable, since we get the 11333546Sgblack@eecs.umich.edu # list of ISAs from env['ALL_ISA_LIST']. 11343546Sgblack@eecs.umich.edu def gen_switch_hdr(target, source, env): 11354781Snate@binkert.org fname = str(target[0]) 11364781Snate@binkert.org f = open(fname, 'w') 11376658Snate@binkert.org isa = env['TARGET_ISA'].lower() 11386658Snate@binkert.org print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname)) 11394781Snate@binkert.org f.close() 11403546Sgblack@eecs.umich.edu 11413546Sgblack@eecs.umich.edu # Build SCons Action object. 'varlist' specifies env vars that this 11423546Sgblack@eecs.umich.edu # action depends on; when env['ALL_ISA_LIST'] changes these actions 11433546Sgblack@eecs.umich.edu # should get re-executed. 11447756SAli.Saidi@ARM.com switch_hdr_action = MakeAction(gen_switch_hdr, 11457816Ssteve.reinhardt@amd.com Transform("GENERATE"), varlist=['ALL_ISA_LIST']) 11463546Sgblack@eecs.umich.edu 11473546Sgblack@eecs.umich.edu # Instantiate actions for each header 11483546Sgblack@eecs.umich.edu for hdr in switch_headers: 11493546Sgblack@eecs.umich.edu env.Command(hdr, [], switch_hdr_action) 11504202Sbinkertn@umich.eduExport('make_switching_dir') 11513546Sgblack@eecs.umich.edu 11523546Sgblack@eecs.umich.edu################################################### 11533546Sgblack@eecs.umich.edu# 1154955SN/A# Define build environments for selected configurations. 1155955SN/A# 1156955SN/A################################################### 1157955SN/A 11585863Snate@binkert.orgfor variant_path in variant_paths: 11595863Snate@binkert.org print "Building in", variant_path 11605343Sstever@gmail.com 11615343Sstever@gmail.com # Make a copy of the build-root environment to use for this config. 11626121Snate@binkert.org env = main.Clone() 11635863Snate@binkert.org env['BUILDDIR'] = variant_path 11644773Snate@binkert.org 11655863Snate@binkert.org # variant_dir is the tail component of build path, and is used to 11662632Sstever@eecs.umich.edu # determine the build parameters (e.g., 'ALPHA_SE') 11675863Snate@binkert.org (build_root, variant_dir) = splitpath(variant_path) 11682023SN/A 11695863Snate@binkert.org # Set env variables according to the build directory config. 11705863Snate@binkert.org sticky_vars.files = [] 11715863Snate@binkert.org # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in 11725863Snate@binkert.org # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke 11735863Snate@binkert.org # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings. 11745863Snate@binkert.org current_vars_file = joinpath(build_root, 'variables', variant_dir) 11755863Snate@binkert.org if isfile(current_vars_file): 11765863Snate@binkert.org sticky_vars.files.append(current_vars_file) 11775863Snate@binkert.org print "Using saved variables file %s" % current_vars_file 11782632Sstever@eecs.umich.edu else: 11795863Snate@binkert.org # Build dir-specific variables file doesn't exist. 11802023SN/A 11812632Sstever@eecs.umich.edu # Make sure the directory is there so we can create it later 11825863Snate@binkert.org opt_dir = dirname(current_vars_file) 11835342Sstever@gmail.com if not isdir(opt_dir): 11845863Snate@binkert.org mkdir(opt_dir) 11852632Sstever@eecs.umich.edu 11865863Snate@binkert.org # Get default build variables from source tree. Variables are 11875863Snate@binkert.org # normally determined by name of $VARIANT_DIR, but can be 11888267Ssteve.reinhardt@amd.com # overridden by '--default=' arg on command line. 11898120Sgblack@eecs.umich.edu default = GetOption('default') 11908267Ssteve.reinhardt@amd.com opts_dir = joinpath(main.root.abspath, 'build_opts') 11918267Ssteve.reinhardt@amd.com if default: 11928267Ssteve.reinhardt@amd.com default_vars_files = [joinpath(build_root, 'variables', default), 11938267Ssteve.reinhardt@amd.com joinpath(opts_dir, default)] 11948267Ssteve.reinhardt@amd.com else: 11958267Ssteve.reinhardt@amd.com default_vars_files = [joinpath(opts_dir, variant_dir)] 11968267Ssteve.reinhardt@amd.com existing_files = filter(isfile, default_vars_files) 11978267Ssteve.reinhardt@amd.com if existing_files: 11988267Ssteve.reinhardt@amd.com default_vars_file = existing_files[0] 11995863Snate@binkert.org sticky_vars.files.append(default_vars_file) 12005863Snate@binkert.org print "Variables file %s not found,\n using defaults in %s" \ 12015863Snate@binkert.org % (current_vars_file, default_vars_file) 12022632Sstever@eecs.umich.edu else: 12038267Ssteve.reinhardt@amd.com print "Error: cannot find variables file %s or " \ 12048267Ssteve.reinhardt@amd.com "default file(s) %s" \ 12058267Ssteve.reinhardt@amd.com % (current_vars_file, ' or '.join(default_vars_files)) 12062632Sstever@eecs.umich.edu Exit(1) 12071888SN/A 12085863Snate@binkert.org # Apply current variable settings to env 12095863Snate@binkert.org sticky_vars.Update(env) 12101858SN/A 12118120Sgblack@eecs.umich.edu help_texts["local_vars"] += \ 12128120Sgblack@eecs.umich.edu "Build variables for %s:\n" % variant_dir \ 12137756SAli.Saidi@ARM.com + sticky_vars.GenerateHelpText(env) 12142598SN/A 12155863Snate@binkert.org # Process variable settings. 12161858SN/A 12171858SN/A if not have_fenv and env['USE_FENV']: 12181858SN/A print "Warning: <fenv.h> not available; " \ 12195863Snate@binkert.org "forcing USE_FENV to False in", variant_dir + "." 12201858SN/A env['USE_FENV'] = False 12211858SN/A 12221858SN/A if not env['USE_FENV']: 12235863Snate@binkert.org print "Warning: No IEEE FP rounding mode control in", variant_dir + "." 12241871SN/A print " FP results may deviate slightly from other platforms." 12251858SN/A 12261858SN/A if env['EFENCE']: 12271858SN/A env.Append(LIBS=['efence']) 12281858SN/A 12299651SAndreas.Sandberg@ARM.com if env['USE_KVM']: 12309651SAndreas.Sandberg@ARM.com if not have_kvm: 12319651SAndreas.Sandberg@ARM.com print "Warning: Can not enable KVM, host seems to lack KVM support" 12329651SAndreas.Sandberg@ARM.com env['USE_KVM'] = False 12339651SAndreas.Sandberg@ARM.com elif not is_isa_kvm_compatible(env['TARGET_ISA']): 12349651SAndreas.Sandberg@ARM.com print "Info: KVM support disabled due to unsupported host and " \ 12359651SAndreas.Sandberg@ARM.com "target ISA combination" 12369651SAndreas.Sandberg@ARM.com env['USE_KVM'] = False 12379651SAndreas.Sandberg@ARM.com 12385863Snate@binkert.org # Save sticky variable settings back to current variables file 12395863Snate@binkert.org sticky_vars.Save(current_vars_file, env) 12401869SN/A 12411965SN/A if env['USE_SSE2']: 12427739Sgblack@eecs.umich.edu env.Append(CCFLAGS=['-msse2']) 12431965SN/A 12442761Sstever@eecs.umich.edu # The src/SConscript file sets up the build rules in 'env' according 12455863Snate@binkert.org # to the configured variables. It returns a list of environments, 12461869SN/A # one for each variant build (debug, opt, etc.) 12475863Snate@binkert.org envList = SConscript('src/SConscript', variant_dir = variant_path, 12482667Sstever@eecs.umich.edu exports = 'env') 12491869SN/A 12501869SN/A # Set up the regression tests for each build. 12512929Sktlim@umich.edu for e in envList: 12522929Sktlim@umich.edu SConscript('tests/SConscript', 12535863Snate@binkert.org variant_dir = joinpath(variant_path, 'tests', e.Label), 12542929Sktlim@umich.edu exports = { 'env' : e }, duplicate = False) 1255955SN/A 12568120Sgblack@eecs.umich.edu# base help text 12578120Sgblack@eecs.umich.eduHelp(''' 12588120Sgblack@eecs.umich.eduUsage: scons [scons options] [build variables] [target(s)] 12598120Sgblack@eecs.umich.edu 12608120Sgblack@eecs.umich.eduExtra scons options: 12618120Sgblack@eecs.umich.edu%(options)s 12628120Sgblack@eecs.umich.edu 12638120Sgblack@eecs.umich.eduGlobal build variables: 12648120Sgblack@eecs.umich.edu%(global_vars)s 12658120Sgblack@eecs.umich.edu 12668120Sgblack@eecs.umich.edu%(local_vars)s 12678120Sgblack@eecs.umich.edu''' % help_texts) 1268