SConstruct revision 9651:f551c8ad12a5
15392Sgblack@eecs.umich.edu# -*- mode:python -*- 25392Sgblack@eecs.umich.edu 35392Sgblack@eecs.umich.edu# Copyright (c) 2011 Advanced Micro Devices, Inc. 45392Sgblack@eecs.umich.edu# Copyright (c) 2009 The Hewlett-Packard Development Company 55392Sgblack@eecs.umich.edu# Copyright (c) 2004-2005 The Regents of The University of Michigan 65392Sgblack@eecs.umich.edu# All rights reserved. 75392Sgblack@eecs.umich.edu# 85392Sgblack@eecs.umich.edu# Redistribution and use in source and binary forms, with or without 95392Sgblack@eecs.umich.edu# modification, are permitted provided that the following conditions are 105392Sgblack@eecs.umich.edu# met: redistributions of source code must retain the above copyright 115392Sgblack@eecs.umich.edu# notice, this list of conditions and the following disclaimer; 125392Sgblack@eecs.umich.edu# redistributions in binary form must reproduce the above copyright 135392Sgblack@eecs.umich.edu# notice, this list of conditions and the following disclaimer in the 145392Sgblack@eecs.umich.edu# documentation and/or other materials provided with the distribution; 155392Sgblack@eecs.umich.edu# neither the name of the copyright holders nor the names of its 165392Sgblack@eecs.umich.edu# contributors may be used to endorse or promote products derived from 175392Sgblack@eecs.umich.edu# this software without specific prior written permission. 185392Sgblack@eecs.umich.edu# 195392Sgblack@eecs.umich.edu# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 205392Sgblack@eecs.umich.edu# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 215392Sgblack@eecs.umich.edu# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 225392Sgblack@eecs.umich.edu# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 235392Sgblack@eecs.umich.edu# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 245392Sgblack@eecs.umich.edu# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 255392Sgblack@eecs.umich.edu# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 265392Sgblack@eecs.umich.edu# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 275392Sgblack@eecs.umich.edu# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 285392Sgblack@eecs.umich.edu# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 295392Sgblack@eecs.umich.edu# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 305392Sgblack@eecs.umich.edu# 315392Sgblack@eecs.umich.edu# Authors: Steve Reinhardt 325392Sgblack@eecs.umich.edu# Nathan Binkert 335392Sgblack@eecs.umich.edu 345392Sgblack@eecs.umich.edu################################################### 355392Sgblack@eecs.umich.edu# 365392Sgblack@eecs.umich.edu# SCons top-level build description (SConstruct) file. 375392Sgblack@eecs.umich.edu# 385813Sgblack@eecs.umich.edu# While in this directory ('gem5'), just type 'scons' to build the default 395392Sgblack@eecs.umich.edu# configuration (see below), or type 'scons build/<CONFIG>/<binary>' 405392Sgblack@eecs.umich.edu# to build some other configuration (e.g., 'build/ALPHA/gem5.opt' for 415392Sgblack@eecs.umich.edu# the optimized full-system version). 425392Sgblack@eecs.umich.edu# 435392Sgblack@eecs.umich.edu# You can build gem5 in a different directory as long as there is a 445392Sgblack@eecs.umich.edu# 'build/<CONFIG>' somewhere along the target path. The build system 455392Sgblack@eecs.umich.edu# expects that all configs under the same build directory are being 466620Sgblack@eecs.umich.edu# built for the same host system. 476620Sgblack@eecs.umich.edu# 485392Sgblack@eecs.umich.edu# Examples: 496620Sgblack@eecs.umich.edu# 506620Sgblack@eecs.umich.edu# The following two commands are equivalent. The '-u' option tells 516620Sgblack@eecs.umich.edu# scons to search up the directory tree for this SConstruct file. 526620Sgblack@eecs.umich.edu# % cd <path-to-src>/gem5 ; scons build/ALPHA/gem5.debug 536620Sgblack@eecs.umich.edu# % cd <path-to-src>/gem5/build/ALPHA; scons -u gem5.debug 545392Sgblack@eecs.umich.edu# 556621Sgblack@eecs.umich.edu# The following two commands are equivalent and demonstrate building 566621Sgblack@eecs.umich.edu# in a directory outside of the source tree. The '-C' option tells 576621Sgblack@eecs.umich.edu# scons to chdir to the specified directory to find this SConstruct 586621Sgblack@eecs.umich.edu# file. 596621Sgblack@eecs.umich.edu# % cd <path-to-src>/gem5 ; scons /local/foo/build/ALPHA/gem5.debug 606621Sgblack@eecs.umich.edu# % cd /local/foo/build/ALPHA; scons -C <path-to-src>/gem5 gem5.debug 616621Sgblack@eecs.umich.edu# 626621Sgblack@eecs.umich.edu# You can use 'scons -H' to print scons options. If you're in this 636621Sgblack@eecs.umich.edu# 'gem5' directory (or use -u or -C to tell scons where to find this 646620Sgblack@eecs.umich.edu# file), you can use 'scons -h' to print all the gem5-specific build 656620Sgblack@eecs.umich.edu# options as well. 666620Sgblack@eecs.umich.edu# 676620Sgblack@eecs.umich.edu################################################### 685392Sgblack@eecs.umich.edu 695392Sgblack@eecs.umich.edu# Check for recent-enough Python and SCons versions. 705392Sgblack@eecs.umich.edutry: 715392Sgblack@eecs.umich.edu # Really old versions of scons only take two options for the 725392Sgblack@eecs.umich.edu # function, so check once without the revision and once with the 735392Sgblack@eecs.umich.edu # revision, the first instance will fail for stuff other than 745392Sgblack@eecs.umich.edu # 0.98, and the second will fail for 0.98.0 755392Sgblack@eecs.umich.edu EnsureSConsVersion(0, 98) 765392Sgblack@eecs.umich.edu EnsureSConsVersion(0, 98, 1) 775392Sgblack@eecs.umich.eduexcept SystemExit, e: 785392Sgblack@eecs.umich.edu print """ 796620Sgblack@eecs.umich.eduFor more details, see: 806620Sgblack@eecs.umich.edu http://gem5.org/Dependencies 816620Sgblack@eecs.umich.edu""" 826620Sgblack@eecs.umich.edu raise 836620Sgblack@eecs.umich.edu 846620Sgblack@eecs.umich.edu# We ensure the python version early because we have stuff that 856620Sgblack@eecs.umich.edu# requires python 2.4 866620Sgblack@eecs.umich.edutry: 876620Sgblack@eecs.umich.edu EnsurePythonVersion(2, 4) 886620Sgblack@eecs.umich.eduexcept SystemExit, e: 896620Sgblack@eecs.umich.edu print """ 906620Sgblack@eecs.umich.eduYou can use a non-default installation of the Python interpreter by 916620Sgblack@eecs.umich.edueither (1) rearranging your PATH so that scons finds the non-default 926620Sgblack@eecs.umich.edu'python' first or (2) explicitly invoking an alternative interpreter 936620Sgblack@eecs.umich.eduon the scons script. 946620Sgblack@eecs.umich.edu 956620Sgblack@eecs.umich.eduFor more details, see: 966620Sgblack@eecs.umich.edu http://gem5.org/wiki/index.php/Using_a_non-default_Python_installation 976620Sgblack@eecs.umich.edu""" 986620Sgblack@eecs.umich.edu raise 996620Sgblack@eecs.umich.edu 1006620Sgblack@eecs.umich.edu# Global Python includes 1016620Sgblack@eecs.umich.eduimport os 1026620Sgblack@eecs.umich.eduimport re 1035392Sgblack@eecs.umich.eduimport subprocess 1045392Sgblack@eecs.umich.eduimport sys 1055392Sgblack@eecs.umich.edu 1065606Snate@binkert.orgfrom os import mkdir, environ 1075606Snate@binkert.orgfrom os.path import abspath, basename, dirname, expanduser, normpath 1087683Ssteve.reinhardt@amd.comfrom os.path import exists, isdir, isfile 1097683Ssteve.reinhardt@amd.comfrom os.path import join as joinpath, split as splitpath 1105606Snate@binkert.org 1115606Snate@binkert.org# SCons includes 1125392Sgblack@eecs.umich.eduimport SCons 1135392Sgblack@eecs.umich.eduimport SCons.Node 1145392Sgblack@eecs.umich.edu 1156621Sgblack@eecs.umich.eduextra_python_paths = [ 1165392Sgblack@eecs.umich.edu Dir('src/python').srcnode().abspath, # gem5 includes 1176621Sgblack@eecs.umich.edu Dir('ext/ply').srcnode().abspath, # ply is used by several files 1186621Sgblack@eecs.umich.edu ] 1196621Sgblack@eecs.umich.edu 1206621Sgblack@eecs.umich.edusys.path[1:1] = extra_python_paths 1216621Sgblack@eecs.umich.edu 1226621Sgblack@eecs.umich.edufrom m5.util import compareVersions, readCommand 1236621Sgblack@eecs.umich.edufrom m5.util.terminal import get_termcap 1246621Sgblack@eecs.umich.edu 1255392Sgblack@eecs.umich.eduhelp_texts = { 1265392Sgblack@eecs.umich.edu "options" : "", 1275813Sgblack@eecs.umich.edu "global_vars" : "", 1285813Sgblack@eecs.umich.edu "local_vars" : "" 1295392Sgblack@eecs.umich.edu} 1305813Sgblack@eecs.umich.edu 1315392Sgblack@eecs.umich.eduExport("help_texts") 1325392Sgblack@eecs.umich.edu 1336617Sgblack@eecs.umich.edu 1345392Sgblack@eecs.umich.edu# There's a bug in scons in that (1) by default, the help texts from 1355392Sgblack@eecs.umich.edu# AddOption() are supposed to be displayed when you type 'scons -h' 1365392Sgblack@eecs.umich.edu# and (2) you can override the help displayed by 'scons -h' using the 1375392Sgblack@eecs.umich.edu# Help() function, but these two features are incompatible: once 1385392Sgblack@eecs.umich.edu# you've overridden the help text using Help(), there's no way to get 1395392Sgblack@eecs.umich.edu# at the help texts from AddOptions. See: 1405392Sgblack@eecs.umich.edu# http://scons.tigris.org/issues/show_bug.cgi?id=2356 1415606Snate@binkert.org# http://scons.tigris.org/issues/show_bug.cgi?id=2611 1425392Sgblack@eecs.umich.edu# This hack lets us extract the help text from AddOptions and 1435392Sgblack@eecs.umich.edu# re-inject it via Help(). Ideally someday this bug will be fixed and 1445392Sgblack@eecs.umich.edu# we can just use AddOption directly. 1455392Sgblack@eecs.umich.edudef AddLocalOption(*args, **kwargs): 1465392Sgblack@eecs.umich.edu col_width = 30 1475392Sgblack@eecs.umich.edu 1485392Sgblack@eecs.umich.edu help = " " + ", ".join(args) 1495392Sgblack@eecs.umich.edu if "help" in kwargs: 1505392Sgblack@eecs.umich.edu length = len(help) 1515392Sgblack@eecs.umich.edu if length >= col_width: 1525392Sgblack@eecs.umich.edu help += "\n" + " " * col_width 1535392Sgblack@eecs.umich.edu else: 1545392Sgblack@eecs.umich.edu help += " " * (col_width - length) 1555392Sgblack@eecs.umich.edu help += kwargs["help"] 1565392Sgblack@eecs.umich.edu help_texts["options"] += help + "\n" 1575392Sgblack@eecs.umich.edu 1585392Sgblack@eecs.umich.edu AddOption(*args, **kwargs) 1595392Sgblack@eecs.umich.edu 1605392Sgblack@eecs.umich.eduAddLocalOption('--colors', dest='use_colors', action='store_true', 1615392Sgblack@eecs.umich.edu help="Add color to abbreviated scons output") 1625392Sgblack@eecs.umich.eduAddLocalOption('--no-colors', dest='use_colors', action='store_false', 1635392Sgblack@eecs.umich.edu help="Don't add color to abbreviated scons output") 1645392Sgblack@eecs.umich.eduAddLocalOption('--default', dest='default', type='string', action='store', 1655392Sgblack@eecs.umich.edu help='Override which build_opts file to use for defaults') 1665392Sgblack@eecs.umich.eduAddLocalOption('--ignore-style', dest='ignore_style', action='store_true', 1675392Sgblack@eecs.umich.edu help='Disable style checking hooks') 1685392Sgblack@eecs.umich.eduAddLocalOption('--no-lto', dest='no_lto', action='store_true', 1695392Sgblack@eecs.umich.edu help='Disable Link-Time Optimization for fast') 1705392Sgblack@eecs.umich.eduAddLocalOption('--update-ref', dest='update_ref', action='store_true', 1715392Sgblack@eecs.umich.edu help='Update test reference outputs') 1725392Sgblack@eecs.umich.eduAddLocalOption('--verbose', dest='verbose', action='store_true', 1735392Sgblack@eecs.umich.edu help='Print full tool command lines') 1745392Sgblack@eecs.umich.edu 1755392Sgblack@eecs.umich.edutermcap = get_termcap(GetOption('use_colors')) 1765392Sgblack@eecs.umich.edu 1775392Sgblack@eecs.umich.edu######################################################################## 1786620Sgblack@eecs.umich.edu# 1796620Sgblack@eecs.umich.edu# Set up the main build environment. 1806620Sgblack@eecs.umich.edu# 1816620Sgblack@eecs.umich.edu######################################################################## 1826620Sgblack@eecs.umich.eduuse_vars = set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH', 1836620Sgblack@eecs.umich.edu 'LIBRARY_PATH', 'PATH', 'PKG_CONFIG_PATH', 'PYTHONPATH', 1846620Sgblack@eecs.umich.edu 'RANLIB', 'SWIG' ]) 1856620Sgblack@eecs.umich.edu 1866620Sgblack@eecs.umich.eduuse_prefixes = [ 1876620Sgblack@eecs.umich.edu "M5", # M5 configuration (e.g., path to kernels) 1886620Sgblack@eecs.umich.edu "DISTCC_", # distcc (distributed compiler wrapper) configuration 1896620Sgblack@eecs.umich.edu "CCACHE_", # ccache (caching compiler wrapper) configuration 1906620Sgblack@eecs.umich.edu "CCC_", # clang static analyzer configuration 1916620Sgblack@eecs.umich.edu ] 1926620Sgblack@eecs.umich.edu 1936620Sgblack@eecs.umich.eduuse_env = {} 1946620Sgblack@eecs.umich.edufor key,val in os.environ.iteritems(): 1956620Sgblack@eecs.umich.edu if key in use_vars or \ 1966620Sgblack@eecs.umich.edu any([key.startswith(prefix) for prefix in use_prefixes]): 1976620Sgblack@eecs.umich.edu use_env[key] = val 1986620Sgblack@eecs.umich.edu 1996620Sgblack@eecs.umich.edumain = Environment(ENV=use_env) 2006620Sgblack@eecs.umich.edumain.Decider('MD5-timestamp') 2016620Sgblack@eecs.umich.edumain.root = Dir(".") # The current directory (where this file lives). 2026620Sgblack@eecs.umich.edumain.srcdir = Dir("src") # The source directory 2036620Sgblack@eecs.umich.edu 2046620Sgblack@eecs.umich.edumain_dict_keys = main.Dictionary().keys() 2056620Sgblack@eecs.umich.edu 2065392Sgblack@eecs.umich.edu# Check that we have a C/C++ compiler 2075392Sgblack@eecs.umich.eduif not ('CC' in main_dict_keys and 'CXX' in main_dict_keys): 2085392Sgblack@eecs.umich.edu print "No C++ compiler installed (package g++ on Ubuntu and RedHat)" 2095392Sgblack@eecs.umich.edu Exit(1) 2105392Sgblack@eecs.umich.edu 2115392Sgblack@eecs.umich.edu# Check that swig is present 2126677SBrad.Beckmann@amd.comif not 'SWIG' in main_dict_keys: 2136677SBrad.Beckmann@amd.com print "swig is not installed (package swig on Ubuntu and RedHat)" 2146677SBrad.Beckmann@amd.com Exit(1) 2156677SBrad.Beckmann@amd.com 2166677SBrad.Beckmann@amd.com# add useful python code PYTHONPATH so it can be used by subprocesses 2177683Ssteve.reinhardt@amd.com# as well 2186677SBrad.Beckmann@amd.commain.AppendENVPath('PYTHONPATH', extra_python_paths) 2197683Ssteve.reinhardt@amd.com 2206677SBrad.Beckmann@amd.com######################################################################## 2215392Sgblack@eecs.umich.edu# 2225392Sgblack@eecs.umich.edu# Mercurial Stuff. 2235392Sgblack@eecs.umich.edu# 2245392Sgblack@eecs.umich.edu# If the gem5 directory is a mercurial repository, we should do some 2255392Sgblack@eecs.umich.edu# extra things. 2265392Sgblack@eecs.umich.edu# 2275392Sgblack@eecs.umich.edu######################################################################## 2285392Sgblack@eecs.umich.edu 2295392Sgblack@eecs.umich.eduhgdir = main.root.Dir(".hg") 2305392Sgblack@eecs.umich.edu 2315392Sgblack@eecs.umich.edumercurial_style_message = """ 2326677SBrad.Beckmann@amd.comYou're missing the gem5 style hook, which automatically checks your code 2336677SBrad.Beckmann@amd.comagainst the gem5 style rules on hg commit and qrefresh commands. This 2346677SBrad.Beckmann@amd.comscript will now install the hook in your .hg/hgrc file. 2356677SBrad.Beckmann@amd.comPress enter to continue, or ctrl-c to abort: """ 2366677SBrad.Beckmann@amd.com 2376677SBrad.Beckmann@amd.commercurial_style_hook = """ 2386677SBrad.Beckmann@amd.com# The following lines were automatically added by gem5/SConstruct 2396677SBrad.Beckmann@amd.com# to provide the gem5 style-checking hooks 2406677SBrad.Beckmann@amd.com[extensions] 2415392Sgblack@eecs.umich.edustyle = %s/util/style.py 2425392Sgblack@eecs.umich.edu 2435392Sgblack@eecs.umich.edu[hooks] 2445606Snate@binkert.orgpretxncommit.style = python:style.check_style 2455392Sgblack@eecs.umich.edupre-qrefresh.style = python:style.check_style 2465392Sgblack@eecs.umich.edu# End of SConstruct additions 2475606Snate@binkert.org 2485392Sgblack@eecs.umich.edu""" % (main.root.abspath) 2495392Sgblack@eecs.umich.edu 2505392Sgblack@eecs.umich.edumercurial_lib_not_found = """ 2515392Sgblack@eecs.umich.eduMercurial libraries cannot be found, ignoring style hook. If 2525392Sgblack@eecs.umich.eduyou are a gem5 developer, please fix this and run the style 2535606Snate@binkert.orghook. It is important. 2545392Sgblack@eecs.umich.edu""" 2555392Sgblack@eecs.umich.edu 2565392Sgblack@eecs.umich.edu# Check for style hook and prompt for installation if it's not there. 2575392Sgblack@eecs.umich.edu# Skip this if --ignore-style was specified, there's no .hg dir to 2585392Sgblack@eecs.umich.edu# install a hook in, or there's no interactive terminal to prompt. 2595392Sgblack@eecs.umich.eduif not GetOption('ignore_style') and hgdir.exists() and sys.stdin.isatty(): 2605606Snate@binkert.org style_hook = True 2615392Sgblack@eecs.umich.edu try: 2625392Sgblack@eecs.umich.edu from mercurial import ui 2635392Sgblack@eecs.umich.edu ui = ui.ui() 2645392Sgblack@eecs.umich.edu ui.readconfig(hgdir.File('hgrc').abspath) 2655392Sgblack@eecs.umich.edu style_hook = ui.config('hooks', 'pretxncommit.style', None) and \ 2665392Sgblack@eecs.umich.edu ui.config('hooks', 'pre-qrefresh.style', None) 2675392Sgblack@eecs.umich.edu except ImportError: 2685392Sgblack@eecs.umich.edu print mercurial_lib_not_found 2696620Sgblack@eecs.umich.edu 2706620Sgblack@eecs.umich.edu if not style_hook: 2716620Sgblack@eecs.umich.edu print mercurial_style_message, 2726620Sgblack@eecs.umich.edu # continue unless user does ctrl-c/ctrl-d etc. 2736620Sgblack@eecs.umich.edu try: 2747064Snate@binkert.org raw_input() 2756620Sgblack@eecs.umich.edu except: 2766620Sgblack@eecs.umich.edu print "Input exception, exiting scons.\n" 2776620Sgblack@eecs.umich.edu sys.exit(1) 2786620Sgblack@eecs.umich.edu hgrc_path = '%s/.hg/hgrc' % main.root.abspath 2796620Sgblack@eecs.umich.edu print "Adding style hook to", hgrc_path, "\n" 2806620Sgblack@eecs.umich.edu try: 2816620Sgblack@eecs.umich.edu hgrc = open(hgrc_path, 'a') 2826620Sgblack@eecs.umich.edu hgrc.write(mercurial_style_hook) 283 hgrc.close() 284 except: 285 print "Error updating", hgrc_path 286 sys.exit(1) 287 288 289################################################### 290# 291# Figure out which configurations to set up based on the path(s) of 292# the target(s). 293# 294################################################### 295 296# Find default configuration & binary. 297Default(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug')) 298 299# helper function: find last occurrence of element in list 300def rfind(l, elt, offs = -1): 301 for i in range(len(l)+offs, 0, -1): 302 if l[i] == elt: 303 return i 304 raise ValueError, "element not found" 305 306# Take a list of paths (or SCons Nodes) and return a list with all 307# paths made absolute and ~-expanded. Paths will be interpreted 308# relative to the launch directory unless a different root is provided 309def makePathListAbsolute(path_list, root=GetLaunchDir()): 310 return [abspath(joinpath(root, expanduser(str(p)))) 311 for p in path_list] 312 313# Each target must have 'build' in the interior of the path; the 314# directory below this will determine the build parameters. For 315# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we 316# recognize that ALPHA_SE specifies the configuration because it 317# follow 'build' in the build path. 318 319# The funky assignment to "[:]" is needed to replace the list contents 320# in place rather than reassign the symbol to a new list, which 321# doesn't work (obviously!). 322BUILD_TARGETS[:] = makePathListAbsolute(BUILD_TARGETS) 323 324# Generate a list of the unique build roots and configs that the 325# collected targets reference. 326variant_paths = [] 327build_root = None 328for t in BUILD_TARGETS: 329 path_dirs = t.split('/') 330 try: 331 build_top = rfind(path_dirs, 'build', -2) 332 except: 333 print "Error: no non-leaf 'build' dir found on target path", t 334 Exit(1) 335 this_build_root = joinpath('/',*path_dirs[:build_top+1]) 336 if not build_root: 337 build_root = this_build_root 338 else: 339 if this_build_root != build_root: 340 print "Error: build targets not under same build root\n"\ 341 " %s\n %s" % (build_root, this_build_root) 342 Exit(1) 343 variant_path = joinpath('/',*path_dirs[:build_top+2]) 344 if variant_path not in variant_paths: 345 variant_paths.append(variant_path) 346 347# Make sure build_root exists (might not if this is the first build there) 348if not isdir(build_root): 349 mkdir(build_root) 350main['BUILDROOT'] = build_root 351 352Export('main') 353 354main.SConsignFile(joinpath(build_root, "sconsign")) 355 356# Default duplicate option is to use hard links, but this messes up 357# when you use emacs to edit a file in the target dir, as emacs moves 358# file to file~ then copies to file, breaking the link. Symbolic 359# (soft) links work better. 360main.SetOption('duplicate', 'soft-copy') 361 362# 363# Set up global sticky variables... these are common to an entire build 364# tree (not specific to a particular build like ALPHA_SE) 365# 366 367global_vars_file = joinpath(build_root, 'variables.global') 368 369global_vars = Variables(global_vars_file, args=ARGUMENTS) 370 371global_vars.AddVariables( 372 ('CC', 'C compiler', environ.get('CC', main['CC'])), 373 ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])), 374 ('SWIG', 'SWIG tool', environ.get('SWIG', main['SWIG'])), 375 ('PROTOC', 'protoc tool', environ.get('PROTOC', 'protoc')), 376 ('BATCH', 'Use batch pool for build and tests', False), 377 ('BATCH_CMD', 'Batch pool submission command name', 'qdo'), 378 ('M5_BUILD_CACHE', 'Cache built objects in this directory', False), 379 ('EXTRAS', 'Add extra directories to the compilation', '') 380 ) 381 382# Update main environment with values from ARGUMENTS & global_vars_file 383global_vars.Update(main) 384help_texts["global_vars"] += global_vars.GenerateHelpText(main) 385 386# Save sticky variable settings back to current variables file 387global_vars.Save(global_vars_file, main) 388 389# Parse EXTRAS variable to build list of all directories where we're 390# look for sources etc. This list is exported as extras_dir_list. 391base_dir = main.srcdir.abspath 392if main['EXTRAS']: 393 extras_dir_list = makePathListAbsolute(main['EXTRAS'].split(':')) 394else: 395 extras_dir_list = [] 396 397Export('base_dir') 398Export('extras_dir_list') 399 400# the ext directory should be on the #includes path 401main.Append(CPPPATH=[Dir('ext')]) 402 403def strip_build_path(path, env): 404 path = str(path) 405 variant_base = env['BUILDROOT'] + os.path.sep 406 if path.startswith(variant_base): 407 path = path[len(variant_base):] 408 elif path.startswith('build/'): 409 path = path[6:] 410 return path 411 412# Generate a string of the form: 413# common/path/prefix/src1, src2 -> tgt1, tgt2 414# to print while building. 415class Transform(object): 416 # all specific color settings should be here and nowhere else 417 tool_color = termcap.Normal 418 pfx_color = termcap.Yellow 419 srcs_color = termcap.Yellow + termcap.Bold 420 arrow_color = termcap.Blue + termcap.Bold 421 tgts_color = termcap.Yellow + termcap.Bold 422 423 def __init__(self, tool, max_sources=99): 424 self.format = self.tool_color + (" [%8s] " % tool) \ 425 + self.pfx_color + "%s" \ 426 + self.srcs_color + "%s" \ 427 + self.arrow_color + " -> " \ 428 + self.tgts_color + "%s" \ 429 + termcap.Normal 430 self.max_sources = max_sources 431 432 def __call__(self, target, source, env, for_signature=None): 433 # truncate source list according to max_sources param 434 source = source[0:self.max_sources] 435 def strip(f): 436 return strip_build_path(str(f), env) 437 if len(source) > 0: 438 srcs = map(strip, source) 439 else: 440 srcs = [''] 441 tgts = map(strip, target) 442 # surprisingly, os.path.commonprefix is a dumb char-by-char string 443 # operation that has nothing to do with paths. 444 com_pfx = os.path.commonprefix(srcs + tgts) 445 com_pfx_len = len(com_pfx) 446 if com_pfx: 447 # do some cleanup and sanity checking on common prefix 448 if com_pfx[-1] == ".": 449 # prefix matches all but file extension: ok 450 # back up one to change 'foo.cc -> o' to 'foo.cc -> .o' 451 com_pfx = com_pfx[0:-1] 452 elif com_pfx[-1] == "/": 453 # common prefix is directory path: OK 454 pass 455 else: 456 src0_len = len(srcs[0]) 457 tgt0_len = len(tgts[0]) 458 if src0_len == com_pfx_len: 459 # source is a substring of target, OK 460 pass 461 elif tgt0_len == com_pfx_len: 462 # target is a substring of source, need to back up to 463 # avoid empty string on RHS of arrow 464 sep_idx = com_pfx.rfind(".") 465 if sep_idx != -1: 466 com_pfx = com_pfx[0:sep_idx] 467 else: 468 com_pfx = '' 469 elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".": 470 # still splitting at file extension: ok 471 pass 472 else: 473 # probably a fluke; ignore it 474 com_pfx = '' 475 # recalculate length in case com_pfx was modified 476 com_pfx_len = len(com_pfx) 477 def fmt(files): 478 f = map(lambda s: s[com_pfx_len:], files) 479 return ', '.join(f) 480 return self.format % (com_pfx, fmt(srcs), fmt(tgts)) 481 482Export('Transform') 483 484# enable the regression script to use the termcap 485main['TERMCAP'] = termcap 486 487if GetOption('verbose'): 488 def MakeAction(action, string, *args, **kwargs): 489 return Action(action, *args, **kwargs) 490else: 491 MakeAction = Action 492 main['CCCOMSTR'] = Transform("CC") 493 main['CXXCOMSTR'] = Transform("CXX") 494 main['ASCOMSTR'] = Transform("AS") 495 main['SWIGCOMSTR'] = Transform("SWIG") 496 main['ARCOMSTR'] = Transform("AR", 0) 497 main['LINKCOMSTR'] = Transform("LINK", 0) 498 main['RANLIBCOMSTR'] = Transform("RANLIB", 0) 499 main['M4COMSTR'] = Transform("M4") 500 main['SHCCCOMSTR'] = Transform("SHCC") 501 main['SHCXXCOMSTR'] = Transform("SHCXX") 502Export('MakeAction') 503 504# Initialize the Link-Time Optimization (LTO) flags 505main['LTO_CCFLAGS'] = [] 506main['LTO_LDFLAGS'] = [] 507 508# According to the readme, tcmalloc works best if the compiler doesn't 509# assume that we're using the builtin malloc and friends. These flags 510# are compiler-specific, so we need to set them after we detect which 511# compiler we're using. 512main['TCMALLOC_CCFLAGS'] = [] 513 514CXX_version = readCommand([main['CXX'],'--version'], exception=False) 515CXX_V = readCommand([main['CXX'],'-V'], exception=False) 516 517main['GCC'] = CXX_version and CXX_version.find('g++') >= 0 518main['CLANG'] = CXX_version and CXX_version.find('clang') >= 0 519if main['GCC'] + main['CLANG'] > 1: 520 print 'Error: How can we have two at the same time?' 521 Exit(1) 522 523# Set up default C++ compiler flags 524if main['GCC'] or main['CLANG']: 525 # As gcc and clang share many flags, do the common parts here 526 main.Append(CCFLAGS=['-pipe']) 527 main.Append(CCFLAGS=['-fno-strict-aliasing']) 528 # Enable -Wall and then disable the few warnings that we 529 # consistently violate 530 main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef']) 531 # We always compile using C++11, but only gcc >= 4.7 and clang 3.1 532 # actually use that name, so we stick with c++0x 533 main.Append(CXXFLAGS=['-std=c++0x']) 534 # Add selected sanity checks from -Wextra 535 main.Append(CXXFLAGS=['-Wmissing-field-initializers', 536 '-Woverloaded-virtual']) 537else: 538 print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal, 539 print "Don't know what compiler options to use for your compiler." 540 print termcap.Yellow + ' compiler:' + termcap.Normal, main['CXX'] 541 print termcap.Yellow + ' version:' + termcap.Normal, 542 if not CXX_version: 543 print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\ 544 termcap.Normal 545 else: 546 print CXX_version.replace('\n', '<nl>') 547 print " If you're trying to use a compiler other than GCC" 548 print " or clang, there appears to be something wrong with your" 549 print " environment." 550 print " " 551 print " If you are trying to use a compiler other than those listed" 552 print " above you will need to ease fix SConstruct and " 553 print " src/SConscript to support that compiler." 554 Exit(1) 555 556if main['GCC']: 557 # Check for a supported version of gcc, >= 4.4 is needed for c++0x 558 # support. See http://gcc.gnu.org/projects/cxx0x.html for details 559 gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False) 560 if compareVersions(gcc_version, "4.4") < 0: 561 print 'Error: gcc version 4.4 or newer required.' 562 print ' Installed version:', gcc_version 563 Exit(1) 564 565 main['GCC_VERSION'] = gcc_version 566 567 # Check for versions with bugs 568 if not compareVersions(gcc_version, '4.4.1') or \ 569 not compareVersions(gcc_version, '4.4.2'): 570 print 'Info: Tree vectorizer in GCC 4.4.1 & 4.4.2 is buggy, disabling.' 571 main.Append(CCFLAGS=['-fno-tree-vectorize']) 572 573 # LTO support is only really working properly from 4.6 and beyond 574 if compareVersions(gcc_version, '4.6') >= 0: 575 # Add the appropriate Link-Time Optimization (LTO) flags 576 # unless LTO is explicitly turned off. Note that these flags 577 # are only used by the fast target. 578 if not GetOption('no_lto'): 579 # Pass the LTO flag when compiling to produce GIMPLE 580 # output, we merely create the flags here and only append 581 # them later/ 582 main['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')] 583 584 # Use the same amount of jobs for LTO as we are running 585 # scons with, we hardcode the use of the linker plugin 586 # which requires either gold or GNU ld >= 2.21 587 main['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs'), 588 '-fuse-linker-plugin'] 589 590 main.Append(TCMALLOC_CCFLAGS=['-fno-builtin-malloc', '-fno-builtin-calloc', 591 '-fno-builtin-realloc', '-fno-builtin-free']) 592 593elif main['CLANG']: 594 # Check for a supported version of clang, >= 2.9 is needed to 595 # support similar features as gcc 4.4. See 596 # http://clang.llvm.org/cxx_status.html for details 597 clang_version_re = re.compile(".* version (\d+\.\d+)") 598 clang_version_match = clang_version_re.match(CXX_version) 599 if (clang_version_match): 600 clang_version = clang_version_match.groups()[0] 601 if compareVersions(clang_version, "2.9") < 0: 602 print 'Error: clang version 2.9 or newer required.' 603 print ' Installed version:', clang_version 604 Exit(1) 605 else: 606 print 'Error: Unable to determine clang version.' 607 Exit(1) 608 609 # clang has a few additional warnings that we disable, 610 # tautological comparisons are allowed due to unsigned integers 611 # being compared to constants that happen to be 0, and extraneous 612 # parantheses are allowed due to Ruby's printing of the AST, 613 # finally self assignments are allowed as the generated CPU code 614 # is relying on this 615 main.Append(CCFLAGS=['-Wno-tautological-compare', 616 '-Wno-parentheses', 617 '-Wno-self-assign']) 618 619 main.Append(TCMALLOC_CCFLAGS=['-fno-builtin']) 620 621 # On Mac OS X/Darwin we need to also use libc++ (part of XCode) as 622 # opposed to libstdc++ to make the transition from TR1 to 623 # C++11. See http://libcxx.llvm.org. However, clang has chosen a 624 # strict implementation of the C++11 standard, and does not allow 625 # incomplete types in template arguments (besides unique_ptr and 626 # shared_ptr), and the libc++ STL containers create problems in 627 # combination with the current gem5 code. For now, we stick with 628 # libstdc++ and use the TR1 namespace. 629 # if sys.platform == "darwin": 630 # main.Append(CXXFLAGS=['-stdlib=libc++']) 631 632else: 633 print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal, 634 print "Don't know what compiler options to use for your compiler." 635 print termcap.Yellow + ' compiler:' + termcap.Normal, main['CXX'] 636 print termcap.Yellow + ' version:' + termcap.Normal, 637 if not CXX_version: 638 print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\ 639 termcap.Normal 640 else: 641 print CXX_version.replace('\n', '<nl>') 642 print " If you're trying to use a compiler other than GCC" 643 print " or clang, there appears to be something wrong with your" 644 print " environment." 645 print " " 646 print " If you are trying to use a compiler other than those listed" 647 print " above you will need to ease fix SConstruct and " 648 print " src/SConscript to support that compiler." 649 Exit(1) 650 651# Set up common yacc/bison flags (needed for Ruby) 652main['YACCFLAGS'] = '-d' 653main['YACCHXXFILESUFFIX'] = '.hh' 654 655# Do this after we save setting back, or else we'll tack on an 656# extra 'qdo' every time we run scons. 657if main['BATCH']: 658 main['CC'] = main['BATCH_CMD'] + ' ' + main['CC'] 659 main['CXX'] = main['BATCH_CMD'] + ' ' + main['CXX'] 660 main['AS'] = main['BATCH_CMD'] + ' ' + main['AS'] 661 main['AR'] = main['BATCH_CMD'] + ' ' + main['AR'] 662 main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB'] 663 664if sys.platform == 'cygwin': 665 # cygwin has some header file issues... 666 main.Append(CCFLAGS=["-Wno-uninitialized"]) 667 668# Check for the protobuf compiler 669protoc_version = readCommand([main['PROTOC'], '--version'], 670 exception='').split() 671 672# First two words should be "libprotoc x.y.z" 673if len(protoc_version) < 2 or protoc_version[0] != 'libprotoc': 674 print termcap.Yellow + termcap.Bold + \ 675 'Warning: Protocol buffer compiler (protoc) not found.\n' + \ 676 ' Please install protobuf-compiler for tracing support.' + \ 677 termcap.Normal 678 main['PROTOC'] = False 679else: 680 # Based on the availability of the compress stream wrappers, 681 # require 2.1.0 682 min_protoc_version = '2.1.0' 683 if compareVersions(protoc_version[1], min_protoc_version) < 0: 684 print termcap.Yellow + termcap.Bold + \ 685 'Warning: protoc version', min_protoc_version, \ 686 'or newer required.\n' + \ 687 ' Installed version:', protoc_version[1], \ 688 termcap.Normal 689 main['PROTOC'] = False 690 else: 691 # Attempt to determine the appropriate include path and 692 # library path using pkg-config, that means we also need to 693 # check for pkg-config. Note that it is possible to use 694 # protobuf without the involvement of pkg-config. Later on we 695 # check go a library config check and at that point the test 696 # will fail if libprotobuf cannot be found. 697 if readCommand(['pkg-config', '--version'], exception=''): 698 try: 699 # Attempt to establish what linking flags to add for protobuf 700 # using pkg-config 701 main.ParseConfig('pkg-config --cflags --libs-only-L protobuf') 702 except: 703 print termcap.Yellow + termcap.Bold + \ 704 'Warning: pkg-config could not get protobuf flags.' + \ 705 termcap.Normal 706 707# Check for SWIG 708if not main.has_key('SWIG'): 709 print 'Error: SWIG utility not found.' 710 print ' Please install (see http://www.swig.org) and retry.' 711 Exit(1) 712 713# Check for appropriate SWIG version 714swig_version = readCommand([main['SWIG'], '-version'], exception='').split() 715# First 3 words should be "SWIG Version x.y.z" 716if len(swig_version) < 3 or \ 717 swig_version[0] != 'SWIG' or swig_version[1] != 'Version': 718 print 'Error determining SWIG version.' 719 Exit(1) 720 721min_swig_version = '1.3.34' 722if compareVersions(swig_version[2], min_swig_version) < 0: 723 print 'Error: SWIG version', min_swig_version, 'or newer required.' 724 print ' Installed version:', swig_version[2] 725 Exit(1) 726 727if swig_version[2] == "2.0.9": 728 print '\n' + termcap.Yellow + termcap.Bold + \ 729 'Warning: SWIG version 2.0.9 sometimes generates broken code.\n' + \ 730 termcap.Normal + \ 731 'This problem only affects some platforms and some Python\n' + \ 732 'versions. See the following SWIG bug report for details:\n' + \ 733 'http://sourceforge.net/p/swig/bugs/1297/\n' 734 735 736# Set up SWIG flags & scanner 737swig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS') 738main.Append(SWIGFLAGS=swig_flags) 739 740# filter out all existing swig scanners, they mess up the dependency 741# stuff for some reason 742scanners = [] 743for scanner in main['SCANNERS']: 744 skeys = scanner.skeys 745 if skeys == '.i': 746 continue 747 748 if isinstance(skeys, (list, tuple)) and '.i' in skeys: 749 continue 750 751 scanners.append(scanner) 752 753# add the new swig scanner that we like better 754from SCons.Scanner import ClassicCPP as CPPScanner 755swig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")' 756scanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re)) 757 758# replace the scanners list that has what we want 759main['SCANNERS'] = scanners 760 761# Add a custom Check function to the Configure context so that we can 762# figure out if the compiler adds leading underscores to global 763# variables. This is needed for the autogenerated asm files that we 764# use for embedding the python code. 765def CheckLeading(context): 766 context.Message("Checking for leading underscore in global variables...") 767 # 1) Define a global variable called x from asm so the C compiler 768 # won't change the symbol at all. 769 # 2) Declare that variable. 770 # 3) Use the variable 771 # 772 # If the compiler prepends an underscore, this will successfully 773 # link because the external symbol 'x' will be called '_x' which 774 # was defined by the asm statement. If the compiler does not 775 # prepend an underscore, this will not successfully link because 776 # '_x' will have been defined by assembly, while the C portion of 777 # the code will be trying to use 'x' 778 ret = context.TryLink(''' 779 asm(".globl _x; _x: .byte 0"); 780 extern int x; 781 int main() { return x; } 782 ''', extension=".c") 783 context.env.Append(LEADING_UNDERSCORE=ret) 784 context.Result(ret) 785 return ret 786 787# Platform-specific configuration. Note again that we assume that all 788# builds under a given build root run on the same host platform. 789conf = Configure(main, 790 conf_dir = joinpath(build_root, '.scons_config'), 791 log_file = joinpath(build_root, 'scons_config.log'), 792 custom_tests = { 'CheckLeading' : CheckLeading }) 793 794# Check for leading underscores. Don't really need to worry either 795# way so don't need to check the return code. 796conf.CheckLeading() 797 798# Check if we should compile a 64 bit binary on Mac OS X/Darwin 799try: 800 import platform 801 uname = platform.uname() 802 if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0: 803 if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]): 804 main.Append(CCFLAGS=['-arch', 'x86_64']) 805 main.Append(CFLAGS=['-arch', 'x86_64']) 806 main.Append(LINKFLAGS=['-arch', 'x86_64']) 807 main.Append(ASFLAGS=['-arch', 'x86_64']) 808except: 809 pass 810 811# Recent versions of scons substitute a "Null" object for Configure() 812# when configuration isn't necessary, e.g., if the "--help" option is 813# present. Unfortuantely this Null object always returns false, 814# breaking all our configuration checks. We replace it with our own 815# more optimistic null object that returns True instead. 816if not conf: 817 def NullCheck(*args, **kwargs): 818 return True 819 820 class NullConf: 821 def __init__(self, env): 822 self.env = env 823 def Finish(self): 824 return self.env 825 def __getattr__(self, mname): 826 return NullCheck 827 828 conf = NullConf(main) 829 830# Find Python include and library directories for embedding the 831# interpreter. For consistency, we will use the same Python 832# installation used to run scons (and thus this script). If you want 833# to link in an alternate version, see above for instructions on how 834# to invoke scons with a different copy of the Python interpreter. 835from distutils import sysconfig 836 837py_getvar = sysconfig.get_config_var 838 839py_debug = getattr(sys, 'pydebug', False) 840py_version = 'python' + py_getvar('VERSION') + (py_debug and "_d" or "") 841 842py_general_include = sysconfig.get_python_inc() 843py_platform_include = sysconfig.get_python_inc(plat_specific=True) 844py_includes = [ py_general_include ] 845if py_platform_include != py_general_include: 846 py_includes.append(py_platform_include) 847 848py_lib_path = [ py_getvar('LIBDIR') ] 849# add the prefix/lib/pythonX.Y/config dir, but only if there is no 850# shared library in prefix/lib/. 851if not py_getvar('Py_ENABLE_SHARED'): 852 py_lib_path.append(py_getvar('LIBPL')) 853 # Python requires the flags in LINKFORSHARED to be added the 854 # linker flags when linking with a statically with Python. Failing 855 # to do so can lead to errors from the Python's dynamic module 856 # loader at start up. 857 main.Append(LINKFLAGS=[py_getvar('LINKFORSHARED').split()]) 858 859py_libs = [] 860for lib in py_getvar('LIBS').split() + py_getvar('SYSLIBS').split(): 861 if not lib.startswith('-l'): 862 # Python requires some special flags to link (e.g. -framework 863 # common on OS X systems), assume appending preserves order 864 main.Append(LINKFLAGS=[lib]) 865 else: 866 lib = lib[2:] 867 if lib not in py_libs: 868 py_libs.append(lib) 869py_libs.append(py_version) 870 871main.Append(CPPPATH=py_includes) 872main.Append(LIBPATH=py_lib_path) 873 874# Cache build files in the supplied directory. 875if main['M5_BUILD_CACHE']: 876 print 'Using build cache located at', main['M5_BUILD_CACHE'] 877 CacheDir(main['M5_BUILD_CACHE']) 878 879 880# verify that this stuff works 881if not conf.CheckHeader('Python.h', '<>'): 882 print "Error: can't find Python.h header in", py_includes 883 print "Install Python headers (package python-dev on Ubuntu and RedHat)" 884 Exit(1) 885 886for lib in py_libs: 887 if not conf.CheckLib(lib): 888 print "Error: can't find library %s required by python" % lib 889 Exit(1) 890 891# On Solaris you need to use libsocket for socket ops 892if not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'): 893 if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'): 894 print "Can't find library with socket calls (e.g. accept())" 895 Exit(1) 896 897# Check for zlib. If the check passes, libz will be automatically 898# added to the LIBS environment variable. 899if not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'): 900 print 'Error: did not find needed zlib compression library '\ 901 'and/or zlib.h header file.' 902 print ' Please install zlib and try again.' 903 Exit(1) 904 905# If we have the protobuf compiler, also make sure we have the 906# development libraries. If the check passes, libprotobuf will be 907# automatically added to the LIBS environment variable. After 908# this, we can use the HAVE_PROTOBUF flag to determine if we have 909# got both protoc and libprotobuf available. 910main['HAVE_PROTOBUF'] = main['PROTOC'] and \ 911 conf.CheckLibWithHeader('protobuf', 'google/protobuf/message.h', 912 'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;') 913 914# If we have the compiler but not the library, print another warning. 915if main['PROTOC'] and not main['HAVE_PROTOBUF']: 916 print termcap.Yellow + termcap.Bold + \ 917 'Warning: did not find protocol buffer library and/or headers.\n' + \ 918 ' Please install libprotobuf-dev for tracing support.' + \ 919 termcap.Normal 920 921# Check for librt. 922have_posix_clock = \ 923 conf.CheckLibWithHeader(None, 'time.h', 'C', 924 'clock_nanosleep(0,0,NULL,NULL);') or \ 925 conf.CheckLibWithHeader('rt', 'time.h', 'C', 926 'clock_nanosleep(0,0,NULL,NULL);') 927 928if conf.CheckLib('tcmalloc'): 929 main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS']) 930elif conf.CheckLib('tcmalloc_minimal'): 931 main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS']) 932else: 933 print termcap.Yellow + termcap.Bold + \ 934 "You can get a 12% performance improvement by installing tcmalloc "\ 935 "(libgoogle-perftools-dev package on Ubuntu or RedHat)." + \ 936 termcap.Normal 937 938if not have_posix_clock: 939 print "Can't find library for POSIX clocks." 940 941# Check for <fenv.h> (C99 FP environment control) 942have_fenv = conf.CheckHeader('fenv.h', '<>') 943if not have_fenv: 944 print "Warning: Header file <fenv.h> not found." 945 print " This host has no IEEE FP rounding mode control." 946 947# Check if we should enable KVM-based hardware virtualization 948have_kvm = conf.CheckHeader('linux/kvm.h', '<>') 949if not have_kvm: 950 print "Info: Header file <linux/kvm.h> not found, " \ 951 "disabling KVM support." 952 953# Check if the requested target ISA is compatible with the host 954def is_isa_kvm_compatible(isa): 955 isa_comp_table = { 956 } 957 try: 958 import platform 959 host_isa = platform.machine() 960 except: 961 print "Warning: Failed to determine host ISA." 962 return False 963 964 return host_isa in isa_comp_table.get(isa, []) 965 966 967###################################################################### 968# 969# Finish the configuration 970# 971main = conf.Finish() 972 973###################################################################### 974# 975# Collect all non-global variables 976# 977 978# Define the universe of supported ISAs 979all_isa_list = [ ] 980Export('all_isa_list') 981 982class CpuModel(object): 983 '''The CpuModel class encapsulates everything the ISA parser needs to 984 know about a particular CPU model.''' 985 986 # Dict of available CPU model objects. Accessible as CpuModel.dict. 987 dict = {} 988 list = [] 989 defaults = [] 990 991 # Constructor. Automatically adds models to CpuModel.dict. 992 def __init__(self, name, filename, includes, strings, default=False): 993 self.name = name # name of model 994 self.filename = filename # filename for output exec code 995 self.includes = includes # include files needed in exec file 996 # The 'strings' dict holds all the per-CPU symbols we can 997 # substitute into templates etc. 998 self.strings = strings 999 1000 # This cpu is enabled by default 1001 self.default = default 1002 1003 # Add self to dict 1004 if name in CpuModel.dict: 1005 raise AttributeError, "CpuModel '%s' already registered" % name 1006 CpuModel.dict[name] = self 1007 CpuModel.list.append(name) 1008 1009Export('CpuModel') 1010 1011# Sticky variables get saved in the variables file so they persist from 1012# one invocation to the next (unless overridden, in which case the new 1013# value becomes sticky). 1014sticky_vars = Variables(args=ARGUMENTS) 1015Export('sticky_vars') 1016 1017# Sticky variables that should be exported 1018export_vars = [] 1019Export('export_vars') 1020 1021# For Ruby 1022all_protocols = [] 1023Export('all_protocols') 1024protocol_dirs = [] 1025Export('protocol_dirs') 1026slicc_includes = [] 1027Export('slicc_includes') 1028 1029# Walk the tree and execute all SConsopts scripts that wil add to the 1030# above variables 1031if not GetOption('verbose'): 1032 print "Reading SConsopts" 1033for bdir in [ base_dir ] + extras_dir_list: 1034 if not isdir(bdir): 1035 print "Error: directory '%s' does not exist" % bdir 1036 Exit(1) 1037 for root, dirs, files in os.walk(bdir): 1038 if 'SConsopts' in files: 1039 if GetOption('verbose'): 1040 print "Reading", joinpath(root, 'SConsopts') 1041 SConscript(joinpath(root, 'SConsopts')) 1042 1043all_isa_list.sort() 1044 1045sticky_vars.AddVariables( 1046 EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list), 1047 ListVariable('CPU_MODELS', 'CPU models', 1048 sorted(n for n,m in CpuModel.dict.iteritems() if m.default), 1049 sorted(CpuModel.list)), 1050 BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger', 1051 False), 1052 BoolVariable('SS_COMPATIBLE_FP', 1053 'Make floating-point results compatible with SimpleScalar', 1054 False), 1055 BoolVariable('USE_SSE2', 1056 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts', 1057 False), 1058 BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock), 1059 BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv), 1060 BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False), 1061 BoolVariable('USE_KVM', 'Enable hardware virtualized (KVM) CPU models', have_kvm), 1062 EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None', 1063 all_protocols), 1064 ) 1065 1066# These variables get exported to #defines in config/*.hh (see src/SConscript). 1067export_vars += ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'CP_ANNOTATE', 1068 'USE_POSIX_CLOCK', 'PROTOCOL', 'HAVE_PROTOBUF'] 1069 1070################################################### 1071# 1072# Define a SCons builder for configuration flag headers. 1073# 1074################################################### 1075 1076# This function generates a config header file that #defines the 1077# variable symbol to the current variable setting (0 or 1). The source 1078# operands are the name of the variable and a Value node containing the 1079# value of the variable. 1080def build_config_file(target, source, env): 1081 (variable, value) = [s.get_contents() for s in source] 1082 f = file(str(target[0]), 'w') 1083 print >> f, '#define', variable, value 1084 f.close() 1085 return None 1086 1087# Combine the two functions into a scons Action object. 1088config_action = MakeAction(build_config_file, Transform("CONFIG H", 2)) 1089 1090# The emitter munges the source & target node lists to reflect what 1091# we're really doing. 1092def config_emitter(target, source, env): 1093 # extract variable name from Builder arg 1094 variable = str(target[0]) 1095 # True target is config header file 1096 target = joinpath('config', variable.lower() + '.hh') 1097 val = env[variable] 1098 if isinstance(val, bool): 1099 # Force value to 0/1 1100 val = int(val) 1101 elif isinstance(val, str): 1102 val = '"' + val + '"' 1103 1104 # Sources are variable name & value (packaged in SCons Value nodes) 1105 return ([target], [Value(variable), Value(val)]) 1106 1107config_builder = Builder(emitter = config_emitter, action = config_action) 1108 1109main.Append(BUILDERS = { 'ConfigFile' : config_builder }) 1110 1111# libelf build is shared across all configs in the build root. 1112main.SConscript('ext/libelf/SConscript', 1113 variant_dir = joinpath(build_root, 'libelf')) 1114 1115# gzstream build is shared across all configs in the build root. 1116main.SConscript('ext/gzstream/SConscript', 1117 variant_dir = joinpath(build_root, 'gzstream')) 1118 1119# libfdt build is shared across all configs in the build root. 1120main.SConscript('ext/libfdt/SConscript', 1121 variant_dir = joinpath(build_root, 'libfdt')) 1122 1123################################################### 1124# 1125# This function is used to set up a directory with switching headers 1126# 1127################################################### 1128 1129main['ALL_ISA_LIST'] = all_isa_list 1130def make_switching_dir(dname, switch_headers, env): 1131 # Generate the header. target[0] is the full path of the output 1132 # header to generate. 'source' is a dummy variable, since we get the 1133 # list of ISAs from env['ALL_ISA_LIST']. 1134 def gen_switch_hdr(target, source, env): 1135 fname = str(target[0]) 1136 f = open(fname, 'w') 1137 isa = env['TARGET_ISA'].lower() 1138 print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname)) 1139 f.close() 1140 1141 # Build SCons Action object. 'varlist' specifies env vars that this 1142 # action depends on; when env['ALL_ISA_LIST'] changes these actions 1143 # should get re-executed. 1144 switch_hdr_action = MakeAction(gen_switch_hdr, 1145 Transform("GENERATE"), varlist=['ALL_ISA_LIST']) 1146 1147 # Instantiate actions for each header 1148 for hdr in switch_headers: 1149 env.Command(hdr, [], switch_hdr_action) 1150Export('make_switching_dir') 1151 1152################################################### 1153# 1154# Define build environments for selected configurations. 1155# 1156################################################### 1157 1158for variant_path in variant_paths: 1159 print "Building in", variant_path 1160 1161 # Make a copy of the build-root environment to use for this config. 1162 env = main.Clone() 1163 env['BUILDDIR'] = variant_path 1164 1165 # variant_dir is the tail component of build path, and is used to 1166 # determine the build parameters (e.g., 'ALPHA_SE') 1167 (build_root, variant_dir) = splitpath(variant_path) 1168 1169 # Set env variables according to the build directory config. 1170 sticky_vars.files = [] 1171 # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in 1172 # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke 1173 # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings. 1174 current_vars_file = joinpath(build_root, 'variables', variant_dir) 1175 if isfile(current_vars_file): 1176 sticky_vars.files.append(current_vars_file) 1177 print "Using saved variables file %s" % current_vars_file 1178 else: 1179 # Build dir-specific variables file doesn't exist. 1180 1181 # Make sure the directory is there so we can create it later 1182 opt_dir = dirname(current_vars_file) 1183 if not isdir(opt_dir): 1184 mkdir(opt_dir) 1185 1186 # Get default build variables from source tree. Variables are 1187 # normally determined by name of $VARIANT_DIR, but can be 1188 # overridden by '--default=' arg on command line. 1189 default = GetOption('default') 1190 opts_dir = joinpath(main.root.abspath, 'build_opts') 1191 if default: 1192 default_vars_files = [joinpath(build_root, 'variables', default), 1193 joinpath(opts_dir, default)] 1194 else: 1195 default_vars_files = [joinpath(opts_dir, variant_dir)] 1196 existing_files = filter(isfile, default_vars_files) 1197 if existing_files: 1198 default_vars_file = existing_files[0] 1199 sticky_vars.files.append(default_vars_file) 1200 print "Variables file %s not found,\n using defaults in %s" \ 1201 % (current_vars_file, default_vars_file) 1202 else: 1203 print "Error: cannot find variables file %s or " \ 1204 "default file(s) %s" \ 1205 % (current_vars_file, ' or '.join(default_vars_files)) 1206 Exit(1) 1207 1208 # Apply current variable settings to env 1209 sticky_vars.Update(env) 1210 1211 help_texts["local_vars"] += \ 1212 "Build variables for %s:\n" % variant_dir \ 1213 + sticky_vars.GenerateHelpText(env) 1214 1215 # Process variable settings. 1216 1217 if not have_fenv and env['USE_FENV']: 1218 print "Warning: <fenv.h> not available; " \ 1219 "forcing USE_FENV to False in", variant_dir + "." 1220 env['USE_FENV'] = False 1221 1222 if not env['USE_FENV']: 1223 print "Warning: No IEEE FP rounding mode control in", variant_dir + "." 1224 print " FP results may deviate slightly from other platforms." 1225 1226 if env['EFENCE']: 1227 env.Append(LIBS=['efence']) 1228 1229 if env['USE_KVM']: 1230 if not have_kvm: 1231 print "Warning: Can not enable KVM, host seems to lack KVM support" 1232 env['USE_KVM'] = False 1233 elif not is_isa_kvm_compatible(env['TARGET_ISA']): 1234 print "Info: KVM support disabled due to unsupported host and " \ 1235 "target ISA combination" 1236 env['USE_KVM'] = False 1237 1238 # Save sticky variable settings back to current variables file 1239 sticky_vars.Save(current_vars_file, env) 1240 1241 if env['USE_SSE2']: 1242 env.Append(CCFLAGS=['-msse2']) 1243 1244 # The src/SConscript file sets up the build rules in 'env' according 1245 # to the configured variables. It returns a list of environments, 1246 # one for each variant build (debug, opt, etc.) 1247 envList = SConscript('src/SConscript', variant_dir = variant_path, 1248 exports = 'env') 1249 1250 # Set up the regression tests for each build. 1251 for e in envList: 1252 SConscript('tests/SConscript', 1253 variant_dir = joinpath(variant_path, 'tests', e.Label), 1254 exports = { 'env' : e }, duplicate = False) 1255 1256# base help text 1257Help(''' 1258Usage: scons [scons options] [build variables] [target(s)] 1259 1260Extra scons options: 1261%(options)s 1262 1263Global build variables: 1264%(global_vars)s 1265 1266%(local_vars)s 1267''' % help_texts) 1268