SConstruct revision 8120
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# 382632Sstever@eecs.umich.edu# While in this directory ('m5'), just type 'scons' to build the default 392632Sstever@eecs.umich.edu# configuration (see below), or type 'scons build/<CONFIG>/<binary>' 402632Sstever@eecs.umich.edu# to build some other configuration (e.g., 'build/ALPHA_FS/m5.opt' for 412632Sstever@eecs.umich.edu# the optimized full-system version). 42955SN/A# 432632Sstever@eecs.umich.edu# You can build M5 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. 522632Sstever@eecs.umich.edu# % cd <path-to-src>/m5 ; scons build/ALPHA_FS/m5.debug 532632Sstever@eecs.umich.edu# % cd <path-to-src>/m5/build/ALPHA_FS; scons -u m5.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. 592632Sstever@eecs.umich.edu# % cd <path-to-src>/m5 ; scons /local/foo/build/ALPHA_FS/m5.debug 602632Sstever@eecs.umich.edu# % cd /local/foo/build/ALPHA_FS; scons -C <path-to-src>/m5 m5.debug 612632Sstever@eecs.umich.edu# 622632Sstever@eecs.umich.edu# You can use 'scons -H' to print scons options. If you're in this 632632Sstever@eecs.umich.edu# 'm5' directory (or use -u or -C to tell scons where to find this 642632Sstever@eecs.umich.edu# file), you can use 'scons -h' to print all the M5-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: 805863Snate@binkert.org http://m5sim.org/wiki/index.php/Compiling_M5 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: 965863Snate@binkert.org http://m5sim.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 = [ 1166655Snate@binkert.org Dir('src/python').srcnode().abspath, # M5 includes 1176655Snate@binkert.org Dir('ext/ply').srcnode().abspath, # ply is used by several files 1186655Snate@binkert.org ] 1196655Snate@binkert.org 1206655Snate@binkert.orgsys.path[1:1] = extra_python_paths 1215871Snate@binkert.org 1226654Snate@binkert.orgfrom m5.util import compareVersions, readCommand 1235396Ssaidi@eecs.umich.edu 1248120Sgblack@eecs.umich.eduhelp_texts = { 1258120Sgblack@eecs.umich.edu "options" : "", 1268120Sgblack@eecs.umich.edu "global_vars" : "", 1278120Sgblack@eecs.umich.edu "local_vars" : "" 1288120Sgblack@eecs.umich.edu} 1298120Sgblack@eecs.umich.edu 1308120Sgblack@eecs.umich.eduExport("help_texts") 1318120Sgblack@eecs.umich.edu 1328120Sgblack@eecs.umich.edudef AddM5Option(*args, **kwargs): 1338120Sgblack@eecs.umich.edu col_width = 30 1348120Sgblack@eecs.umich.edu 1358120Sgblack@eecs.umich.edu help = " " + ", ".join(args) 1368120Sgblack@eecs.umich.edu if "help" in kwargs: 1378120Sgblack@eecs.umich.edu length = len(help) 1388120Sgblack@eecs.umich.edu if length >= col_width: 1398120Sgblack@eecs.umich.edu help += "\n" + " " * col_width 1408120Sgblack@eecs.umich.edu else: 1418120Sgblack@eecs.umich.edu help += " " * (col_width - length) 1428120Sgblack@eecs.umich.edu help += kwargs["help"] 1438120Sgblack@eecs.umich.edu help_texts["options"] += help + "\n" 1448120Sgblack@eecs.umich.edu 1458120Sgblack@eecs.umich.edu AddOption(*args, **kwargs) 1468120Sgblack@eecs.umich.edu 1478120Sgblack@eecs.umich.eduAddM5Option('--colors', dest='use_colors', action='store_true', 1488120Sgblack@eecs.umich.edu help="Add color to abbreviated scons output") 1498120Sgblack@eecs.umich.eduAddM5Option('--no-colors', dest='use_colors', action='store_false', 1508120Sgblack@eecs.umich.edu help="Don't add color to abbreviated scons output") 1518120Sgblack@eecs.umich.eduAddM5Option('--default', dest='default', type='string', action='store', 1528120Sgblack@eecs.umich.edu help='Override which build_opts file to use for defaults') 1538120Sgblack@eecs.umich.eduAddM5Option('--ignore-style', dest='ignore_style', action='store_true', 1548120Sgblack@eecs.umich.edu help='Disable style checking hooks') 1558120Sgblack@eecs.umich.eduAddM5Option('--update-ref', dest='update_ref', action='store_true', 1568120Sgblack@eecs.umich.edu help='Update test reference outputs') 1578120Sgblack@eecs.umich.eduAddM5Option('--verbose', dest='verbose', action='store_true', 1588120Sgblack@eecs.umich.edu help='Print full tool command lines') 1598120Sgblack@eecs.umich.edu 1607816Ssteve.reinhardt@amd.comuse_colors = GetOption('use_colors') 1617816Ssteve.reinhardt@amd.comif use_colors: 1627816Ssteve.reinhardt@amd.com from m5.util.terminal import termcap 1637816Ssteve.reinhardt@amd.comelif use_colors is None: 1647816Ssteve.reinhardt@amd.com # option unspecified; default behavior is to use colors iff isatty 1657816Ssteve.reinhardt@amd.com from m5.util.terminal import tty_termcap as termcap 1667816Ssteve.reinhardt@amd.comelse: 1677816Ssteve.reinhardt@amd.com from m5.util.terminal import no_termcap as termcap 1687816Ssteve.reinhardt@amd.com 1695871Snate@binkert.org######################################################################## 1705871Snate@binkert.org# 1716121Snate@binkert.org# Set up the main build environment. 1725871Snate@binkert.org# 1735871Snate@binkert.org######################################################################## 1746003Snate@binkert.orguse_vars = set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH', 'PATH', 1756655Snate@binkert.org 'PYTHONPATH', 'RANLIB' ]) 176955SN/A 1775871Snate@binkert.orguse_env = {} 1785871Snate@binkert.orgfor key,val in os.environ.iteritems(): 1795871Snate@binkert.org if key in use_vars or key.startswith("M5"): 1805871Snate@binkert.org use_env[key] = val 181955SN/A 1826121Snate@binkert.orgmain = Environment(ENV=use_env) 1836121Snate@binkert.orgmain.root = Dir(".") # The current directory (where this file lives). 1846121Snate@binkert.orgmain.srcdir = Dir("src") # The source directory 1851533SN/A 1866655Snate@binkert.org# add useful python code PYTHONPATH so it can be used by subprocesses 1876655Snate@binkert.org# as well 1886655Snate@binkert.orgmain.AppendENVPath('PYTHONPATH', extra_python_paths) 1896655Snate@binkert.org 1905871Snate@binkert.org######################################################################## 1915871Snate@binkert.org# 1925863Snate@binkert.org# Mercurial Stuff. 1935871Snate@binkert.org# 1945871Snate@binkert.org# If the M5 directory is a mercurial repository, we should do some 1955871Snate@binkert.org# extra things. 1965871Snate@binkert.org# 1975871Snate@binkert.org######################################################################## 1985863Snate@binkert.org 1996121Snate@binkert.orghgdir = main.root.Dir(".hg") 2005863Snate@binkert.org 2015871Snate@binkert.orgmercurial_style_message = """ 2024678Snate@binkert.orgYou're missing the M5 style hook. 2034678Snate@binkert.orgPlease install the hook so we can ensure that all code fits a common style. 2044678Snate@binkert.org 2054678Snate@binkert.orgAll you'd need to do is add the following lines to your repository .hg/hgrc 2064678Snate@binkert.orgor your personal .hgrc 2074678Snate@binkert.org---------------- 2084678Snate@binkert.org 2094678Snate@binkert.org[extensions] 2104678Snate@binkert.orgstyle = %s/util/style.py 2114678Snate@binkert.org 2124678Snate@binkert.org[hooks] 2137827Snate@binkert.orgpretxncommit.style = python:style.check_style 2147827Snate@binkert.orgpre-qrefresh.style = python:style.check_style 2156121Snate@binkert.org""" % (main.root) 2164678Snate@binkert.org 2175871Snate@binkert.orgmercurial_bin_not_found = """ 2185871Snate@binkert.orgMercurial binary cannot be found, unfortunately this means that we 2195871Snate@binkert.orgcannot easily determine the version of M5 that you are running and 2205871Snate@binkert.orgthis makes error messages more difficult to collect. Please consider 2215871Snate@binkert.orginstalling mercurial if you choose to post an error message 2225871Snate@binkert.org""" 2235871Snate@binkert.org 2245871Snate@binkert.orgmercurial_lib_not_found = """ 2255871Snate@binkert.orgMercurial libraries cannot be found, ignoring style hook 2265871Snate@binkert.orgIf you are actually a M5 developer, please fix this and 2275871Snate@binkert.orgrun the style hook. It is important. 2285871Snate@binkert.org""" 2295871Snate@binkert.org 2305990Ssaidi@eecs.umich.eduhg_info = "Unknown" 2315871Snate@binkert.orgif hgdir.exists(): 2325871Snate@binkert.org # 1) Grab repository revision if we know it. 2335871Snate@binkert.org cmd = "hg id -n -i -t -b" 2344678Snate@binkert.org try: 2356654Snate@binkert.org hg_info = readCommand(cmd, cwd=main.root.abspath).strip() 2365871Snate@binkert.org except OSError: 2375871Snate@binkert.org print mercurial_bin_not_found 2385871Snate@binkert.org 2395871Snate@binkert.org # 2) Ensure that the style hook is in place. 2405871Snate@binkert.org try: 2415871Snate@binkert.org ui = None 2428120Sgblack@eecs.umich.edu if GetOption('ignore_style'): 2435871Snate@binkert.org from mercurial import ui 2445871Snate@binkert.org ui = ui.ui() 2454678Snate@binkert.org except ImportError: 2465871Snate@binkert.org print mercurial_lib_not_found 2474678Snate@binkert.org 2485871Snate@binkert.org if ui is not None: 2495871Snate@binkert.org ui.readconfig(hgdir.File('hgrc').abspath) 2505871Snate@binkert.org style_hook = ui.config('hooks', 'pretxncommit.style', None) 2515871Snate@binkert.org 2525871Snate@binkert.org if not style_hook: 2535871Snate@binkert.org print mercurial_style_message 2545871Snate@binkert.org sys.exit(1) 2555871Snate@binkert.orgelse: 2565871Snate@binkert.org print ".hg directory not found" 2576121Snate@binkert.org 2586121Snate@binkert.orgmain['HG_INFO'] = hg_info 2595863Snate@binkert.org 260955SN/A################################################### 261955SN/A# 2622632Sstever@eecs.umich.edu# Figure out which configurations to set up based on the path(s) of 2632632Sstever@eecs.umich.edu# the target(s). 264955SN/A# 265955SN/A################################################### 266955SN/A 267955SN/A# Find default configuration & binary. 2685863Snate@binkert.orgDefault(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA_SE/m5.debug')) 269955SN/A 2702632Sstever@eecs.umich.edu# helper function: find last occurrence of element in list 2712632Sstever@eecs.umich.edudef rfind(l, elt, offs = -1): 2722632Sstever@eecs.umich.edu for i in range(len(l)+offs, 0, -1): 2732632Sstever@eecs.umich.edu if l[i] == elt: 2742632Sstever@eecs.umich.edu return i 2752632Sstever@eecs.umich.edu raise ValueError, "element not found" 2762632Sstever@eecs.umich.edu 2772632Sstever@eecs.umich.edu# Each target must have 'build' in the interior of the path; the 2782632Sstever@eecs.umich.edu# directory below this will determine the build parameters. For 2792632Sstever@eecs.umich.edu# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we 2802632Sstever@eecs.umich.edu# recognize that ALPHA_SE specifies the configuration because it 2812632Sstever@eecs.umich.edu# follow 'build' in the bulid path. 2822632Sstever@eecs.umich.edu 2833718Sstever@eecs.umich.edu# Generate absolute paths to targets so we can see where the build dir is 2843718Sstever@eecs.umich.eduif COMMAND_LINE_TARGETS: 2853718Sstever@eecs.umich.edu # Ask SCons which directory it was invoked from 2863718Sstever@eecs.umich.edu launch_dir = GetLaunchDir() 2873718Sstever@eecs.umich.edu # Make targets relative to invocation directory 2885863Snate@binkert.org abs_targets = [ normpath(joinpath(launch_dir, str(x))) for x in \ 2895863Snate@binkert.org COMMAND_LINE_TARGETS] 2903718Sstever@eecs.umich.eduelse: 2913718Sstever@eecs.umich.edu # Default targets are relative to root of tree 2926121Snate@binkert.org abs_targets = [ normpath(joinpath(main.root.abspath, str(x))) for x in \ 2935863Snate@binkert.org DEFAULT_TARGETS] 2943718Sstever@eecs.umich.edu 2953718Sstever@eecs.umich.edu 2962634Sstever@eecs.umich.edu# Generate a list of the unique build roots and configs that the 2972634Sstever@eecs.umich.edu# collected targets reference. 2985863Snate@binkert.orgvariant_paths = [] 2992638Sstever@eecs.umich.edubuild_root = None 3002632Sstever@eecs.umich.edufor t in abs_targets: 3012632Sstever@eecs.umich.edu path_dirs = t.split('/') 3022632Sstever@eecs.umich.edu try: 3032632Sstever@eecs.umich.edu build_top = rfind(path_dirs, 'build', -2) 3042632Sstever@eecs.umich.edu except: 3052632Sstever@eecs.umich.edu print "Error: no non-leaf 'build' dir found on target path", t 3061858SN/A Exit(1) 3073716Sstever@eecs.umich.edu this_build_root = joinpath('/',*path_dirs[:build_top+1]) 3082638Sstever@eecs.umich.edu if not build_root: 3092638Sstever@eecs.umich.edu build_root = this_build_root 3102638Sstever@eecs.umich.edu else: 3112638Sstever@eecs.umich.edu if this_build_root != build_root: 3122638Sstever@eecs.umich.edu print "Error: build targets not under same build root\n"\ 3132638Sstever@eecs.umich.edu " %s\n %s" % (build_root, this_build_root) 3142638Sstever@eecs.umich.edu Exit(1) 3155863Snate@binkert.org variant_path = joinpath('/',*path_dirs[:build_top+2]) 3165863Snate@binkert.org if variant_path not in variant_paths: 3175863Snate@binkert.org variant_paths.append(variant_path) 318955SN/A 3195341Sstever@gmail.com# Make sure build_root exists (might not if this is the first build there) 3205341Sstever@gmail.comif not isdir(build_root): 3215863Snate@binkert.org mkdir(build_root) 3227756SAli.Saidi@ARM.commain['BUILDROOT'] = build_root 3235341Sstever@gmail.com 3246121Snate@binkert.orgExport('main') 3254494Ssaidi@eecs.umich.edu 3266121Snate@binkert.orgmain.SConsignFile(joinpath(build_root, "sconsign")) 3271105SN/A 3282667Sstever@eecs.umich.edu# Default duplicate option is to use hard links, but this messes up 3292667Sstever@eecs.umich.edu# when you use emacs to edit a file in the target dir, as emacs moves 3302667Sstever@eecs.umich.edu# file to file~ then copies to file, breaking the link. Symbolic 3312667Sstever@eecs.umich.edu# (soft) links work better. 3326121Snate@binkert.orgmain.SetOption('duplicate', 'soft-copy') 3332667Sstever@eecs.umich.edu 3345341Sstever@gmail.com# 3355863Snate@binkert.org# Set up global sticky variables... these are common to an entire build 3365341Sstever@gmail.com# tree (not specific to a particular build like ALPHA_SE) 3375341Sstever@gmail.com# 3385341Sstever@gmail.com 3395863Snate@binkert.org# Variable validators & converters for global sticky variables 3405341Sstever@gmail.comdef PathListMakeAbsolute(val): 3415341Sstever@gmail.com if not val: 3425341Sstever@gmail.com return val 3435863Snate@binkert.org f = lambda p: abspath(expanduser(p)) 3445341Sstever@gmail.com return ':'.join(map(f, val.split(':'))) 3455341Sstever@gmail.com 3465341Sstever@gmail.comdef PathListAllExist(key, val, env): 3475341Sstever@gmail.com if not val: 3485341Sstever@gmail.com return 3495341Sstever@gmail.com paths = val.split(':') 3505341Sstever@gmail.com for path in paths: 3515341Sstever@gmail.com if not isdir(path): 3525341Sstever@gmail.com raise SCons.Errors.UserError("Path does not exist: '%s'" % path) 3535341Sstever@gmail.com 3548120Sgblack@eecs.umich.eduglobal_vars_file = joinpath(build_root, 'variables.global') 3555341Sstever@gmail.com 3568120Sgblack@eecs.umich.eduglobal_vars = Variables(global_vars_file, args=ARGUMENTS) 3575341Sstever@gmail.com 3588120Sgblack@eecs.umich.eduglobal_vars.AddVariables( 3596121Snate@binkert.org ('CC', 'C compiler', environ.get('CC', main['CC'])), 3606121Snate@binkert.org ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])), 3615397Ssaidi@eecs.umich.edu ('BATCH', 'Use batch pool for build and tests', False), 3625397Ssaidi@eecs.umich.edu ('BATCH_CMD', 'Batch pool submission command name', 'qdo'), 3637727SAli.Saidi@ARM.com ('M5_BUILD_CACHE', 'Cache built objects in this directory', False), 3645341Sstever@gmail.com ('EXTRAS', 'Add Extra directories to the compilation', '', 3656168Snate@binkert.org PathListAllExist, PathListMakeAbsolute), 3666168Snate@binkert.org ) 3675341Sstever@gmail.com 3688120Sgblack@eecs.umich.edu# Update main environment with values from ARGUMENTS & global_vars_file 3698120Sgblack@eecs.umich.eduglobal_vars.Update(main) 3708120Sgblack@eecs.umich.eduhelp_texts["global_vars"] += global_vars.GenerateHelpText(main) 3716814Sgblack@eecs.umich.edu 3725863Snate@binkert.org# Save sticky variable settings back to current variables file 3738120Sgblack@eecs.umich.eduglobal_vars.Save(global_vars_file, main) 3745341Sstever@gmail.com 3755863Snate@binkert.org# Parse EXTRAS variable to build list of all directories where we're 3765341Sstever@gmail.com# look for sources etc. This list is exported as base_dir_list. 3776121Snate@binkert.orgbase_dir = main.srcdir.abspath 3786121Snate@binkert.orgif main['EXTRAS']: 3796121Snate@binkert.org extras_dir_list = main['EXTRAS'].split(':') 3805742Snate@binkert.orgelse: 3815742Snate@binkert.org extras_dir_list = [] 3825341Sstever@gmail.com 3835742Snate@binkert.orgExport('base_dir') 3845742Snate@binkert.orgExport('extras_dir_list') 3855341Sstever@gmail.com 3866017Snate@binkert.org# the ext directory should be on the #includes path 3876121Snate@binkert.orgmain.Append(CPPPATH=[Dir('ext')]) 3886017Snate@binkert.org 3897816Ssteve.reinhardt@amd.comdef strip_build_path(path, env): 3907756SAli.Saidi@ARM.com path = str(path) 3917756SAli.Saidi@ARM.com variant_base = env['BUILDROOT'] + os.path.sep 3927756SAli.Saidi@ARM.com if path.startswith(variant_base): 3937756SAli.Saidi@ARM.com path = path[len(variant_base):] 3947756SAli.Saidi@ARM.com elif path.startswith('build/'): 3957756SAli.Saidi@ARM.com path = path[6:] 3967756SAli.Saidi@ARM.com return path 3977756SAli.Saidi@ARM.com 3987816Ssteve.reinhardt@amd.com# Generate a string of the form: 3997816Ssteve.reinhardt@amd.com# common/path/prefix/src1, src2 -> tgt1, tgt2 4007816Ssteve.reinhardt@amd.com# to print while building. 4017816Ssteve.reinhardt@amd.comclass Transform(object): 4027816Ssteve.reinhardt@amd.com # all specific color settings should be here and nowhere else 4037816Ssteve.reinhardt@amd.com tool_color = termcap.Normal 4047816Ssteve.reinhardt@amd.com pfx_color = termcap.Yellow 4057816Ssteve.reinhardt@amd.com srcs_color = termcap.Yellow + termcap.Bold 4067816Ssteve.reinhardt@amd.com arrow_color = termcap.Blue + termcap.Bold 4077816Ssteve.reinhardt@amd.com tgts_color = termcap.Yellow + termcap.Bold 4087756SAli.Saidi@ARM.com 4097816Ssteve.reinhardt@amd.com def __init__(self, tool, max_sources=99): 4107816Ssteve.reinhardt@amd.com self.format = self.tool_color + (" [%8s] " % tool) \ 4117816Ssteve.reinhardt@amd.com + self.pfx_color + "%s" \ 4127816Ssteve.reinhardt@amd.com + self.srcs_color + "%s" \ 4137816Ssteve.reinhardt@amd.com + self.arrow_color + " -> " \ 4147816Ssteve.reinhardt@amd.com + self.tgts_color + "%s" \ 4157816Ssteve.reinhardt@amd.com + termcap.Normal 4167816Ssteve.reinhardt@amd.com self.max_sources = max_sources 4177816Ssteve.reinhardt@amd.com 4187816Ssteve.reinhardt@amd.com def __call__(self, target, source, env, for_signature=None): 4197816Ssteve.reinhardt@amd.com # truncate source list according to max_sources param 4207816Ssteve.reinhardt@amd.com source = source[0:self.max_sources] 4217816Ssteve.reinhardt@amd.com def strip(f): 4227816Ssteve.reinhardt@amd.com return strip_build_path(str(f), env) 4237816Ssteve.reinhardt@amd.com if len(source) > 0: 4247816Ssteve.reinhardt@amd.com srcs = map(strip, source) 4257816Ssteve.reinhardt@amd.com else: 4267816Ssteve.reinhardt@amd.com srcs = [''] 4277816Ssteve.reinhardt@amd.com tgts = map(strip, target) 4287816Ssteve.reinhardt@amd.com # surprisingly, os.path.commonprefix is a dumb char-by-char string 4297816Ssteve.reinhardt@amd.com # operation that has nothing to do with paths. 4307816Ssteve.reinhardt@amd.com com_pfx = os.path.commonprefix(srcs + tgts) 4317816Ssteve.reinhardt@amd.com com_pfx_len = len(com_pfx) 4327816Ssteve.reinhardt@amd.com if com_pfx: 4337816Ssteve.reinhardt@amd.com # do some cleanup and sanity checking on common prefix 4347816Ssteve.reinhardt@amd.com if com_pfx[-1] == ".": 4357816Ssteve.reinhardt@amd.com # prefix matches all but file extension: ok 4367816Ssteve.reinhardt@amd.com # back up one to change 'foo.cc -> o' to 'foo.cc -> .o' 4377816Ssteve.reinhardt@amd.com com_pfx = com_pfx[0:-1] 4387816Ssteve.reinhardt@amd.com elif com_pfx[-1] == "/": 4397816Ssteve.reinhardt@amd.com # common prefix is directory path: OK 4407816Ssteve.reinhardt@amd.com pass 4417816Ssteve.reinhardt@amd.com else: 4427816Ssteve.reinhardt@amd.com src0_len = len(srcs[0]) 4437816Ssteve.reinhardt@amd.com tgt0_len = len(tgts[0]) 4447816Ssteve.reinhardt@amd.com if src0_len == com_pfx_len: 4457816Ssteve.reinhardt@amd.com # source is a substring of target, OK 4467816Ssteve.reinhardt@amd.com pass 4477816Ssteve.reinhardt@amd.com elif tgt0_len == com_pfx_len: 4487816Ssteve.reinhardt@amd.com # target is a substring of source, need to back up to 4497816Ssteve.reinhardt@amd.com # avoid empty string on RHS of arrow 4507816Ssteve.reinhardt@amd.com sep_idx = com_pfx.rfind(".") 4517816Ssteve.reinhardt@amd.com if sep_idx != -1: 4527816Ssteve.reinhardt@amd.com com_pfx = com_pfx[0:sep_idx] 4537816Ssteve.reinhardt@amd.com else: 4547816Ssteve.reinhardt@amd.com com_pfx = '' 4557816Ssteve.reinhardt@amd.com elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".": 4567816Ssteve.reinhardt@amd.com # still splitting at file extension: ok 4577816Ssteve.reinhardt@amd.com pass 4587816Ssteve.reinhardt@amd.com else: 4597816Ssteve.reinhardt@amd.com # probably a fluke; ignore it 4607816Ssteve.reinhardt@amd.com com_pfx = '' 4617816Ssteve.reinhardt@amd.com # recalculate length in case com_pfx was modified 4627816Ssteve.reinhardt@amd.com com_pfx_len = len(com_pfx) 4637816Ssteve.reinhardt@amd.com def fmt(files): 4647816Ssteve.reinhardt@amd.com f = map(lambda s: s[com_pfx_len:], files) 4657816Ssteve.reinhardt@amd.com return ', '.join(f) 4667816Ssteve.reinhardt@amd.com return self.format % (com_pfx, fmt(srcs), fmt(tgts)) 4677816Ssteve.reinhardt@amd.com 4687816Ssteve.reinhardt@amd.comExport('Transform') 4697816Ssteve.reinhardt@amd.com 4707756SAli.Saidi@ARM.com 4718120Sgblack@eecs.umich.eduif GetOption('verbose'): 4727756SAli.Saidi@ARM.com def MakeAction(action, string, *args, **kwargs): 4737756SAli.Saidi@ARM.com return Action(action, *args, **kwargs) 4747756SAli.Saidi@ARM.comelse: 4757756SAli.Saidi@ARM.com MakeAction = Action 4767816Ssteve.reinhardt@amd.com main['CCCOMSTR'] = Transform("CC") 4777816Ssteve.reinhardt@amd.com main['CXXCOMSTR'] = Transform("CXX") 4787816Ssteve.reinhardt@amd.com main['ASCOMSTR'] = Transform("AS") 4797816Ssteve.reinhardt@amd.com main['SWIGCOMSTR'] = Transform("SWIG") 4807816Ssteve.reinhardt@amd.com main['ARCOMSTR'] = Transform("AR", 0) 4817816Ssteve.reinhardt@amd.com main['LINKCOMSTR'] = Transform("LINK", 0) 4827816Ssteve.reinhardt@amd.com main['RANLIBCOMSTR'] = Transform("RANLIB", 0) 4837816Ssteve.reinhardt@amd.com main['M4COMSTR'] = Transform("M4") 4847816Ssteve.reinhardt@amd.com main['SHCCCOMSTR'] = Transform("SHCC") 4857816Ssteve.reinhardt@amd.com main['SHCXXCOMSTR'] = Transform("SHCXX") 4867756SAli.Saidi@ARM.comExport('MakeAction') 4877756SAli.Saidi@ARM.com 4886654Snate@binkert.orgCXX_version = readCommand([main['CXX'],'--version'], exception=False) 4896654Snate@binkert.orgCXX_V = readCommand([main['CXX'],'-V'], exception=False) 4905871Snate@binkert.org 4916121Snate@binkert.orgmain['GCC'] = CXX_version and CXX_version.find('g++') >= 0 4926121Snate@binkert.orgmain['SUNCC'] = CXX_V and CXX_V.find('Sun C++') >= 0 4936121Snate@binkert.orgmain['ICC'] = CXX_V and CXX_V.find('Intel') >= 0 4946121Snate@binkert.orgif main['GCC'] + main['SUNCC'] + main['ICC'] > 1: 4953940Ssaidi@eecs.umich.edu print 'Error: How can we have two at the same time?' 4963918Ssaidi@eecs.umich.edu Exit(1) 4973918Ssaidi@eecs.umich.edu 4981858SN/A# Set up default C++ compiler flags 4996121Snate@binkert.orgif main['GCC']: 5007739Sgblack@eecs.umich.edu main.Append(CCFLAGS=['-pipe']) 5017739Sgblack@eecs.umich.edu main.Append(CCFLAGS=['-fno-strict-aliasing']) 5026143Snate@binkert.org main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef']) 5037739Sgblack@eecs.umich.edu main.Append(CXXFLAGS=['-Wno-deprecated']) 5047618SAli.Saidi@arm.com # Read the GCC version to check for versions with bugs 5057618SAli.Saidi@arm.com # Note CCVERSION doesn't work here because it is run with the CC 5067618SAli.Saidi@arm.com # before we override it from the command line 5077618SAli.Saidi@arm.com gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False) 5087618SAli.Saidi@arm.com if not compareVersions(gcc_version, '4.4.1') or \ 5097618SAli.Saidi@arm.com not compareVersions(gcc_version, '4.4.2'): 5107618SAli.Saidi@arm.com print 'Info: Tree vectorizer in GCC 4.4.1 & 4.4.2 is buggy, disabling.' 5117739Sgblack@eecs.umich.edu main.Append(CCFLAGS=['-fno-tree-vectorize']) 5126121Snate@binkert.orgelif main['ICC']: 5133940Ssaidi@eecs.umich.edu pass #Fix me... add warning flags once we clean up icc warnings 5146121Snate@binkert.orgelif main['SUNCC']: 5157739Sgblack@eecs.umich.edu main.Append(CCFLAGS=['-Qoption ccfe']) 5167739Sgblack@eecs.umich.edu main.Append(CCFLAGS=['-features=gcc']) 5177739Sgblack@eecs.umich.edu main.Append(CCFLAGS=['-features=extensions']) 5187739Sgblack@eecs.umich.edu main.Append(CCFLAGS=['-library=stlport4']) 5197739Sgblack@eecs.umich.edu main.Append(CCFLAGS=['-xar']) 5207739Sgblack@eecs.umich.edu #main.Append(CCFLAGS=['-instances=semiexplicit']) 5213918Ssaidi@eecs.umich.eduelse: 5223918Ssaidi@eecs.umich.edu print 'Error: Don\'t know what compiler options to use for your compiler.' 5233940Ssaidi@eecs.umich.edu print ' Please fix SConstruct and src/SConscript and try again.' 5243918Ssaidi@eecs.umich.edu Exit(1) 5253918Ssaidi@eecs.umich.edu 5266157Snate@binkert.org# Set up common yacc/bison flags (needed for Ruby) 5276157Snate@binkert.orgmain['YACCFLAGS'] = '-d' 5286157Snate@binkert.orgmain['YACCHXXFILESUFFIX'] = '.hh' 5296157Snate@binkert.org 5305397Ssaidi@eecs.umich.edu# Do this after we save setting back, or else we'll tack on an 5315397Ssaidi@eecs.umich.edu# extra 'qdo' every time we run scons. 5326121Snate@binkert.orgif main['BATCH']: 5336121Snate@binkert.org main['CC'] = main['BATCH_CMD'] + ' ' + main['CC'] 5346121Snate@binkert.org main['CXX'] = main['BATCH_CMD'] + ' ' + main['CXX'] 5356121Snate@binkert.org main['AS'] = main['BATCH_CMD'] + ' ' + main['AS'] 5366121Snate@binkert.org main['AR'] = main['BATCH_CMD'] + ' ' + main['AR'] 5376121Snate@binkert.org main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB'] 5385397Ssaidi@eecs.umich.edu 5391851SN/Aif sys.platform == 'cygwin': 5401851SN/A # cygwin has some header file issues... 5417739Sgblack@eecs.umich.edu main.Append(CCFLAGS=["-Wno-uninitialized"]) 542955SN/A 5433053Sstever@eecs.umich.edu# Check for SWIG 5446121Snate@binkert.orgif not main.has_key('SWIG'): 5453053Sstever@eecs.umich.edu print 'Error: SWIG utility not found.' 5463053Sstever@eecs.umich.edu print ' Please install (see http://www.swig.org) and retry.' 5473053Sstever@eecs.umich.edu Exit(1) 5483053Sstever@eecs.umich.edu 5493053Sstever@eecs.umich.edu# Check for appropriate SWIG version 5506654Snate@binkert.orgswig_version = readCommand(('swig', '-version'), exception='').split() 5513053Sstever@eecs.umich.edu# First 3 words should be "SWIG Version x.y.z" 5524742Sstever@eecs.umich.eduif len(swig_version) < 3 or \ 5534742Sstever@eecs.umich.edu swig_version[0] != 'SWIG' or swig_version[1] != 'Version': 5543053Sstever@eecs.umich.edu print 'Error determining SWIG version.' 5553053Sstever@eecs.umich.edu Exit(1) 5563053Sstever@eecs.umich.edu 5573053Sstever@eecs.umich.edumin_swig_version = '1.3.28' 5586654Snate@binkert.orgif compareVersions(swig_version[2], min_swig_version) < 0: 5593053Sstever@eecs.umich.edu print 'Error: SWIG version', min_swig_version, 'or newer required.' 5603053Sstever@eecs.umich.edu print ' Installed version:', swig_version[2] 5613053Sstever@eecs.umich.edu Exit(1) 5623053Sstever@eecs.umich.edu 5632667Sstever@eecs.umich.edu# Set up SWIG flags & scanner 5644554Sbinkertn@umich.eduswig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS') 5656121Snate@binkert.orgmain.Append(SWIGFLAGS=swig_flags) 5662667Sstever@eecs.umich.edu 5674554Sbinkertn@umich.edu# filter out all existing swig scanners, they mess up the dependency 5684554Sbinkertn@umich.edu# stuff for some reason 5694554Sbinkertn@umich.eduscanners = [] 5706121Snate@binkert.orgfor scanner in main['SCANNERS']: 5714554Sbinkertn@umich.edu skeys = scanner.skeys 5724554Sbinkertn@umich.edu if skeys == '.i': 5734554Sbinkertn@umich.edu continue 5744781Snate@binkert.org 5754554Sbinkertn@umich.edu if isinstance(skeys, (list, tuple)) and '.i' in skeys: 5764554Sbinkertn@umich.edu continue 5772667Sstever@eecs.umich.edu 5784554Sbinkertn@umich.edu scanners.append(scanner) 5794554Sbinkertn@umich.edu 5804554Sbinkertn@umich.edu# add the new swig scanner that we like better 5814554Sbinkertn@umich.edufrom SCons.Scanner import ClassicCPP as CPPScanner 5822667Sstever@eecs.umich.eduswig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")' 5834554Sbinkertn@umich.eduscanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re)) 5842667Sstever@eecs.umich.edu 5854554Sbinkertn@umich.edu# replace the scanners list that has what we want 5866121Snate@binkert.orgmain['SCANNERS'] = scanners 5872667Sstever@eecs.umich.edu 5885522Snate@binkert.org# Add a custom Check function to the Configure context so that we can 5895522Snate@binkert.org# figure out if the compiler adds leading underscores to global 5905522Snate@binkert.org# variables. This is needed for the autogenerated asm files that we 5915522Snate@binkert.org# use for embedding the python code. 5925522Snate@binkert.orgdef CheckLeading(context): 5935522Snate@binkert.org context.Message("Checking for leading underscore in global variables...") 5945522Snate@binkert.org # 1) Define a global variable called x from asm so the C compiler 5955522Snate@binkert.org # won't change the symbol at all. 5965522Snate@binkert.org # 2) Declare that variable. 5975522Snate@binkert.org # 3) Use the variable 5985522Snate@binkert.org # 5995522Snate@binkert.org # If the compiler prepends an underscore, this will successfully 6005522Snate@binkert.org # link because the external symbol 'x' will be called '_x' which 6015522Snate@binkert.org # was defined by the asm statement. If the compiler does not 6025522Snate@binkert.org # prepend an underscore, this will not successfully link because 6035522Snate@binkert.org # '_x' will have been defined by assembly, while the C portion of 6045522Snate@binkert.org # the code will be trying to use 'x' 6055522Snate@binkert.org ret = context.TryLink(''' 6065522Snate@binkert.org asm(".globl _x; _x: .byte 0"); 6075522Snate@binkert.org extern int x; 6085522Snate@binkert.org int main() { return x; } 6095522Snate@binkert.org ''', extension=".c") 6105522Snate@binkert.org context.env.Append(LEADING_UNDERSCORE=ret) 6115522Snate@binkert.org context.Result(ret) 6125522Snate@binkert.org return ret 6135522Snate@binkert.org 6142638Sstever@eecs.umich.edu# Platform-specific configuration. Note again that we assume that all 6152638Sstever@eecs.umich.edu# builds under a given build root run on the same host platform. 6166121Snate@binkert.orgconf = Configure(main, 6173716Sstever@eecs.umich.edu conf_dir = joinpath(build_root, '.scons_config'), 6185522Snate@binkert.org log_file = joinpath(build_root, 'scons_config.log'), 6195522Snate@binkert.org custom_tests = { 'CheckLeading' : CheckLeading }) 6205522Snate@binkert.org 6215522Snate@binkert.org# Check for leading underscores. Don't really need to worry either 6225522Snate@binkert.org# way so don't need to check the return code. 6235522Snate@binkert.orgconf.CheckLeading() 6241858SN/A 6255227Ssaidi@eecs.umich.edu# Check if we should compile a 64 bit binary on Mac OS X/Darwin 6265227Ssaidi@eecs.umich.edutry: 6275227Ssaidi@eecs.umich.edu import platform 6285227Ssaidi@eecs.umich.edu uname = platform.uname() 6296654Snate@binkert.org if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0: 6306654Snate@binkert.org if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]): 6317769SAli.Saidi@ARM.com main.Append(CCFLAGS=['-arch', 'x86_64']) 6327769SAli.Saidi@ARM.com main.Append(CFLAGS=['-arch', 'x86_64']) 6337769SAli.Saidi@ARM.com main.Append(LINKFLAGS=['-arch', 'x86_64']) 6347769SAli.Saidi@ARM.com main.Append(ASFLAGS=['-arch', 'x86_64']) 6355227Ssaidi@eecs.umich.eduexcept: 6365227Ssaidi@eecs.umich.edu pass 6375227Ssaidi@eecs.umich.edu 6385204Sstever@gmail.com# Recent versions of scons substitute a "Null" object for Configure() 6395204Sstever@gmail.com# when configuration isn't necessary, e.g., if the "--help" option is 6405204Sstever@gmail.com# present. Unfortuantely this Null object always returns false, 6415204Sstever@gmail.com# breaking all our configuration checks. We replace it with our own 6425204Sstever@gmail.com# more optimistic null object that returns True instead. 6435204Sstever@gmail.comif not conf: 6445204Sstever@gmail.com def NullCheck(*args, **kwargs): 6455204Sstever@gmail.com return True 6465204Sstever@gmail.com 6475204Sstever@gmail.com class NullConf: 6485204Sstever@gmail.com def __init__(self, env): 6495204Sstever@gmail.com self.env = env 6505204Sstever@gmail.com def Finish(self): 6515204Sstever@gmail.com return self.env 6525204Sstever@gmail.com def __getattr__(self, mname): 6535204Sstever@gmail.com return NullCheck 6545204Sstever@gmail.com 6556121Snate@binkert.org conf = NullConf(main) 6565204Sstever@gmail.com 6573118Sstever@eecs.umich.edu# Find Python include and library directories for embedding the 6583118Sstever@eecs.umich.edu# interpreter. For consistency, we will use the same Python 6593118Sstever@eecs.umich.edu# installation used to run scons (and thus this script). If you want 6603118Sstever@eecs.umich.edu# to link in an alternate version, see above for instructions on how 6613118Sstever@eecs.umich.edu# to invoke scons with a different copy of the Python interpreter. 6625863Snate@binkert.orgfrom distutils import sysconfig 6633118Sstever@eecs.umich.edu 6645863Snate@binkert.orgpy_getvar = sysconfig.get_config_var 6653118Sstever@eecs.umich.edu 6667457Snate@binkert.orgpy_debug = getattr(sys, 'pydebug', False) 6677457Snate@binkert.orgpy_version = 'python' + py_getvar('VERSION') + (py_debug and "_d" or "") 6685863Snate@binkert.org 6695863Snate@binkert.orgpy_general_include = sysconfig.get_python_inc() 6705863Snate@binkert.orgpy_platform_include = sysconfig.get_python_inc(plat_specific=True) 6715863Snate@binkert.orgpy_includes = [ py_general_include ] 6725863Snate@binkert.orgif py_platform_include != py_general_include: 6735863Snate@binkert.org py_includes.append(py_platform_include) 6745863Snate@binkert.org 6756003Snate@binkert.orgpy_lib_path = [ py_getvar('LIBDIR') ] 6765863Snate@binkert.org# add the prefix/lib/pythonX.Y/config dir, but only if there is no 6775863Snate@binkert.org# shared library in prefix/lib/. 6785863Snate@binkert.orgif not py_getvar('Py_ENABLE_SHARED'): 6796120Snate@binkert.org py_lib_path.append(py_getvar('LIBPL')) 6805863Snate@binkert.org 6815863Snate@binkert.orgpy_libs = [] 6825863Snate@binkert.orgfor lib in py_getvar('LIBS').split() + py_getvar('SYSLIBS').split(): 6836120Snate@binkert.org assert lib.startswith('-l') 6846120Snate@binkert.org lib = lib[2:] 6855863Snate@binkert.org if lib not in py_libs: 6865863Snate@binkert.org py_libs.append(lib) 6876120Snate@binkert.orgpy_libs.append(py_version) 6885863Snate@binkert.org 6896121Snate@binkert.orgmain.Append(CPPPATH=py_includes) 6906121Snate@binkert.orgmain.Append(LIBPATH=py_lib_path) 6915863Snate@binkert.org 6927727SAli.Saidi@ARM.com# Cache build files in the supplied directory. 6937727SAli.Saidi@ARM.comif main['M5_BUILD_CACHE']: 6947727SAli.Saidi@ARM.com print 'Using build cache located at', main['M5_BUILD_CACHE'] 6957727SAli.Saidi@ARM.com CacheDir(main['M5_BUILD_CACHE']) 6967727SAli.Saidi@ARM.com 6977727SAli.Saidi@ARM.com 6985863Snate@binkert.org# verify that this stuff works 6993118Sstever@eecs.umich.eduif not conf.CheckHeader('Python.h', '<>'): 7005863Snate@binkert.org print "Error: can't find Python.h header in", py_includes 7013118Sstever@eecs.umich.edu Exit(1) 7023118Sstever@eecs.umich.edu 7035863Snate@binkert.orgfor lib in py_libs: 7045863Snate@binkert.org if not conf.CheckLib(lib): 7055863Snate@binkert.org print "Error: can't find library %s required by python" % lib 7065863Snate@binkert.org Exit(1) 7073118Sstever@eecs.umich.edu 7083483Ssaidi@eecs.umich.edu# On Solaris you need to use libsocket for socket ops 7093494Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'): 7103494Ssaidi@eecs.umich.edu if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'): 7113483Ssaidi@eecs.umich.edu print "Can't find library with socket calls (e.g. accept())" 7123483Ssaidi@eecs.umich.edu Exit(1) 7133483Ssaidi@eecs.umich.edu 7143053Sstever@eecs.umich.edu# Check for zlib. If the check passes, libz will be automatically 7153053Sstever@eecs.umich.edu# added to the LIBS environment variable. 7163918Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'): 7173053Sstever@eecs.umich.edu print 'Error: did not find needed zlib compression library '\ 7183053Sstever@eecs.umich.edu 'and/or zlib.h header file.' 7193053Sstever@eecs.umich.edu print ' Please install zlib and try again.' 7203053Sstever@eecs.umich.edu Exit(1) 7213053Sstever@eecs.umich.edu 7227840Snate@binkert.org# Check for librt. 7237865Sgblack@eecs.umich.eduhave_posix_clock = \ 7247865Sgblack@eecs.umich.edu conf.CheckLibWithHeader(None, 'time.h', 'C', 7257865Sgblack@eecs.umich.edu 'clock_nanosleep(0,0,NULL,NULL);') or \ 7267865Sgblack@eecs.umich.edu conf.CheckLibWithHeader('rt', 'time.h', 'C', 7277865Sgblack@eecs.umich.edu 'clock_nanosleep(0,0,NULL,NULL);') 7287840Snate@binkert.org 7297840Snate@binkert.orgif not have_posix_clock: 7307840Snate@binkert.org print "Can't find library for POSIX clocks." 7317840Snate@binkert.org 7321858SN/A# Check for <fenv.h> (C99 FP environment control) 7331858SN/Ahave_fenv = conf.CheckHeader('fenv.h', '<>') 7341858SN/Aif not have_fenv: 7351858SN/A print "Warning: Header file <fenv.h> not found." 7361858SN/A print " This host has no IEEE FP rounding mode control." 7371858SN/A 7385863Snate@binkert.org###################################################################### 7395863Snate@binkert.org# 7401859SN/A# Check for mysql. 7415863Snate@binkert.org# 7421858SN/Amysql_config = WhereIs('mysql_config') 7435863Snate@binkert.orghave_mysql = bool(mysql_config) 7441858SN/A 7451859SN/A# Check MySQL version. 7461859SN/Aif have_mysql: 7476654Snate@binkert.org mysql_version = readCommand(mysql_config + ' --version') 7483053Sstever@eecs.umich.edu min_mysql_version = '4.1' 7496654Snate@binkert.org if compareVersions(mysql_version, min_mysql_version) < 0: 7503053Sstever@eecs.umich.edu print 'Warning: MySQL', min_mysql_version, 'or newer required.' 7513053Sstever@eecs.umich.edu print ' Version', mysql_version, 'detected.' 7521859SN/A have_mysql = False 7531859SN/A 7541859SN/A# Set up mysql_config commands. 7551859SN/Aif have_mysql: 7561859SN/A mysql_config_include = mysql_config + ' --include' 7571859SN/A if os.system(mysql_config_include + ' > /dev/null') != 0: 7581859SN/A # older mysql_config versions don't support --include, use 7591859SN/A # --cflags instead 7601862SN/A mysql_config_include = mysql_config + ' --cflags | sed s/\\\'//g' 7611859SN/A # This seems to work in all versions 7621859SN/A mysql_config_libs = mysql_config + ' --libs' 7631859SN/A 7645863Snate@binkert.org###################################################################### 7655863Snate@binkert.org# 7665863Snate@binkert.org# Finish the configuration 7675863Snate@binkert.org# 7686121Snate@binkert.orgmain = conf.Finish() 7691858SN/A 7705863Snate@binkert.org###################################################################### 7715863Snate@binkert.org# 7725863Snate@binkert.org# Collect all non-global variables 7735863Snate@binkert.org# 7745863Snate@binkert.org 7752139SN/A# Define the universe of supported ISAs 7764202Sbinkertn@umich.eduall_isa_list = [ ] 7774202Sbinkertn@umich.eduExport('all_isa_list') 7782139SN/A 7796994Snate@binkert.orgclass CpuModel(object): 7806994Snate@binkert.org '''The CpuModel class encapsulates everything the ISA parser needs to 7816994Snate@binkert.org know about a particular CPU model.''' 7826994Snate@binkert.org 7836994Snate@binkert.org # Dict of available CPU model objects. Accessible as CpuModel.dict. 7846994Snate@binkert.org dict = {} 7856994Snate@binkert.org list = [] 7866994Snate@binkert.org defaults = [] 7876994Snate@binkert.org 7886994Snate@binkert.org # Constructor. Automatically adds models to CpuModel.dict. 7896994Snate@binkert.org def __init__(self, name, filename, includes, strings, default=False): 7906994Snate@binkert.org self.name = name # name of model 7916994Snate@binkert.org self.filename = filename # filename for output exec code 7926994Snate@binkert.org self.includes = includes # include files needed in exec file 7936994Snate@binkert.org # The 'strings' dict holds all the per-CPU symbols we can 7946994Snate@binkert.org # substitute into templates etc. 7956994Snate@binkert.org self.strings = strings 7966994Snate@binkert.org 7976994Snate@binkert.org # This cpu is enabled by default 7986994Snate@binkert.org self.default = default 7996994Snate@binkert.org 8006994Snate@binkert.org # Add self to dict 8016994Snate@binkert.org if name in CpuModel.dict: 8026994Snate@binkert.org raise AttributeError, "CpuModel '%s' already registered" % name 8036994Snate@binkert.org CpuModel.dict[name] = self 8046994Snate@binkert.org CpuModel.list.append(name) 8056994Snate@binkert.org 8066994Snate@binkert.orgExport('CpuModel') 8072155SN/A 8085863Snate@binkert.org# Sticky variables get saved in the variables file so they persist from 8091869SN/A# one invocation to the next (unless overridden, in which case the new 8101869SN/A# value becomes sticky). 8115863Snate@binkert.orgsticky_vars = Variables(args=ARGUMENTS) 8125863Snate@binkert.orgExport('sticky_vars') 8134202Sbinkertn@umich.edu 8146108Snate@binkert.org# Sticky variables that should be exported 8156108Snate@binkert.orgexport_vars = [] 8166108Snate@binkert.orgExport('export_vars') 8176108Snate@binkert.org 8184202Sbinkertn@umich.edu# Walk the tree and execute all SConsopts scripts that wil add to the 8195863Snate@binkert.org# above variables 8205742Snate@binkert.orgfor bdir in [ base_dir ] + extras_dir_list: 8215742Snate@binkert.org for root, dirs, files in os.walk(bdir): 8225341Sstever@gmail.com if 'SConsopts' in files: 8235342Sstever@gmail.com print "Reading", joinpath(root, 'SConsopts') 8245342Sstever@gmail.com SConscript(joinpath(root, 'SConsopts')) 8254202Sbinkertn@umich.edu 8264202Sbinkertn@umich.eduall_isa_list.sort() 8274202Sbinkertn@umich.edu 8285863Snate@binkert.orgsticky_vars.AddVariables( 8295863Snate@binkert.org EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list), 8305863Snate@binkert.org BoolVariable('FULL_SYSTEM', 'Full-system support', False), 8316994Snate@binkert.org ListVariable('CPU_MODELS', 'CPU models', 8326994Snate@binkert.org sorted(n for n,m in CpuModel.dict.iteritems() if m.default), 8336994Snate@binkert.org sorted(CpuModel.list)), 8345863Snate@binkert.org BoolVariable('NO_FAST_ALLOC', 'Disable fast object allocator', False), 8355863Snate@binkert.org BoolVariable('FAST_ALLOC_DEBUG', 'Enable fast object allocator debugging', 8365863Snate@binkert.org False), 8375863Snate@binkert.org BoolVariable('FAST_ALLOC_STATS', 'Enable fast object allocator statistics', 8385863Snate@binkert.org False), 8395863Snate@binkert.org BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger', 8405863Snate@binkert.org False), 8415863Snate@binkert.org BoolVariable('SS_COMPATIBLE_FP', 8425863Snate@binkert.org 'Make floating-point results compatible with SimpleScalar', 8435863Snate@binkert.org False), 8445863Snate@binkert.org BoolVariable('USE_SSE2', 8455863Snate@binkert.org 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts', 8465863Snate@binkert.org False), 8475863Snate@binkert.org BoolVariable('USE_MYSQL', 'Use MySQL for stats output', have_mysql), 8487840Snate@binkert.org BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock), 8495863Snate@binkert.org BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv), 8505863Snate@binkert.org BoolVariable('USE_CHECKER', 'Use checker for detailed CPU models', False), 8515952Ssaidi@eecs.umich.edu BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False), 8527450Sstever@gmail.com BoolVariable('RUBY', 'Build with Ruby', False), 8531869SN/A ) 8541858SN/A 8555863Snate@binkert.org# These variables get exported to #defines in config/*.hh (see src/SConscript). 8566108Snate@binkert.orgexport_vars += ['FULL_SYSTEM', 'USE_FENV', 'USE_MYSQL', 8576108Snate@binkert.org 'NO_FAST_ALLOC', 'FAST_ALLOC_DEBUG', 'FAST_ALLOC_STATS', 8587840Snate@binkert.org 'SS_COMPATIBLE_FP', 'USE_CHECKER', 'TARGET_ISA', 'CP_ANNOTATE', 8597840Snate@binkert.org 'USE_POSIX_CLOCK' ] 8601858SN/A 861955SN/A################################################### 862955SN/A# 8631869SN/A# Define a SCons builder for configuration flag headers. 8641869SN/A# 8651869SN/A################################################### 8661869SN/A 8671869SN/A# This function generates a config header file that #defines the 8685863Snate@binkert.org# variable symbol to the current variable setting (0 or 1). The source 8695863Snate@binkert.org# operands are the name of the variable and a Value node containing the 8705863Snate@binkert.org# value of the variable. 8711869SN/Adef build_config_file(target, source, env): 8725863Snate@binkert.org (variable, value) = [s.get_contents() for s in source] 8731869SN/A f = file(str(target[0]), 'w') 8745863Snate@binkert.org print >> f, '#define', variable, value 8751869SN/A f.close() 8761869SN/A return None 8771869SN/A 8781869SN/A# Generate the message to be printed when building the config file. 8791869SN/Adef build_config_file_string(target, source, env): 8805863Snate@binkert.org (variable, value) = [s.get_contents() for s in source] 8815863Snate@binkert.org return "Defining %s as %s in %s." % (variable, value, target[0]) 8821869SN/A 8831869SN/A# Combine the two functions into a scons Action object. 8841869SN/Aconfig_action = Action(build_config_file, build_config_file_string) 8851869SN/A 8861869SN/A# The emitter munges the source & target node lists to reflect what 8871869SN/A# we're really doing. 8881869SN/Adef config_emitter(target, source, env): 8895863Snate@binkert.org # extract variable name from Builder arg 8905863Snate@binkert.org variable = str(target[0]) 8911869SN/A # True target is config header file 8925863Snate@binkert.org target = joinpath('config', variable.lower() + '.hh') 8935863Snate@binkert.org val = env[variable] 8943356Sbinkertn@umich.edu if isinstance(val, bool): 8953356Sbinkertn@umich.edu # Force value to 0/1 8963356Sbinkertn@umich.edu val = int(val) 8973356Sbinkertn@umich.edu elif isinstance(val, str): 8983356Sbinkertn@umich.edu val = '"' + val + '"' 8994781Snate@binkert.org 9005863Snate@binkert.org # Sources are variable name & value (packaged in SCons Value nodes) 9015863Snate@binkert.org return ([target], [Value(variable), Value(val)]) 9021869SN/A 9031869SN/Aconfig_builder = Builder(emitter = config_emitter, action = config_action) 9041869SN/A 9056121Snate@binkert.orgmain.Append(BUILDERS = { 'ConfigFile' : config_builder }) 9061869SN/A 9072638Sstever@eecs.umich.edu# libelf build is shared across all configs in the build root. 9086121Snate@binkert.orgmain.SConscript('ext/libelf/SConscript', 9096121Snate@binkert.org variant_dir = joinpath(build_root, 'libelf')) 9102638Sstever@eecs.umich.edu 9115749Scws3k@cs.virginia.edu# gzstream build is shared across all configs in the build root. 9126121Snate@binkert.orgmain.SConscript('ext/gzstream/SConscript', 9136121Snate@binkert.org variant_dir = joinpath(build_root, 'gzstream')) 9145749Scws3k@cs.virginia.edu 9151869SN/A################################################### 9161869SN/A# 9173546Sgblack@eecs.umich.edu# This function is used to set up a directory with switching headers 9183546Sgblack@eecs.umich.edu# 9193546Sgblack@eecs.umich.edu################################################### 9203546Sgblack@eecs.umich.edu 9216121Snate@binkert.orgmain['ALL_ISA_LIST'] = all_isa_list 9225863Snate@binkert.orgdef make_switching_dir(dname, switch_headers, env): 9233546Sgblack@eecs.umich.edu # Generate the header. target[0] is the full path of the output 9243546Sgblack@eecs.umich.edu # header to generate. 'source' is a dummy variable, since we get the 9253546Sgblack@eecs.umich.edu # list of ISAs from env['ALL_ISA_LIST']. 9263546Sgblack@eecs.umich.edu def gen_switch_hdr(target, source, env): 9274781Snate@binkert.org fname = str(target[0]) 9284781Snate@binkert.org f = open(fname, 'w') 9296658Snate@binkert.org isa = env['TARGET_ISA'].lower() 9306658Snate@binkert.org print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname)) 9314781Snate@binkert.org f.close() 9323546Sgblack@eecs.umich.edu 9333546Sgblack@eecs.umich.edu # Build SCons Action object. 'varlist' specifies env vars that this 9343546Sgblack@eecs.umich.edu # action depends on; when env['ALL_ISA_LIST'] changes these actions 9353546Sgblack@eecs.umich.edu # should get re-executed. 9367756SAli.Saidi@ARM.com switch_hdr_action = MakeAction(gen_switch_hdr, 9377816Ssteve.reinhardt@amd.com Transform("GENERATE"), varlist=['ALL_ISA_LIST']) 9383546Sgblack@eecs.umich.edu 9393546Sgblack@eecs.umich.edu # Instantiate actions for each header 9403546Sgblack@eecs.umich.edu for hdr in switch_headers: 9413546Sgblack@eecs.umich.edu env.Command(hdr, [], switch_hdr_action) 9424202Sbinkertn@umich.eduExport('make_switching_dir') 9433546Sgblack@eecs.umich.edu 9443546Sgblack@eecs.umich.edu################################################### 9453546Sgblack@eecs.umich.edu# 946955SN/A# Define build environments for selected configurations. 947955SN/A# 948955SN/A################################################### 949955SN/A 9505863Snate@binkert.orgfor variant_path in variant_paths: 9515863Snate@binkert.org print "Building in", variant_path 9525343Sstever@gmail.com 9535343Sstever@gmail.com # Make a copy of the build-root environment to use for this config. 9546121Snate@binkert.org env = main.Clone() 9555863Snate@binkert.org env['BUILDDIR'] = variant_path 9564773Snate@binkert.org 9575863Snate@binkert.org # variant_dir is the tail component of build path, and is used to 9582632Sstever@eecs.umich.edu # determine the build parameters (e.g., 'ALPHA_SE') 9595863Snate@binkert.org (build_root, variant_dir) = splitpath(variant_path) 9602023SN/A 9615863Snate@binkert.org # Set env variables according to the build directory config. 9625863Snate@binkert.org sticky_vars.files = [] 9635863Snate@binkert.org # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in 9645863Snate@binkert.org # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke 9655863Snate@binkert.org # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings. 9665863Snate@binkert.org current_vars_file = joinpath(build_root, 'variables', variant_dir) 9675863Snate@binkert.org if isfile(current_vars_file): 9685863Snate@binkert.org sticky_vars.files.append(current_vars_file) 9695863Snate@binkert.org print "Using saved variables file %s" % current_vars_file 9702632Sstever@eecs.umich.edu else: 9715863Snate@binkert.org # Build dir-specific variables file doesn't exist. 9722023SN/A 9732632Sstever@eecs.umich.edu # Make sure the directory is there so we can create it later 9745863Snate@binkert.org opt_dir = dirname(current_vars_file) 9755342Sstever@gmail.com if not isdir(opt_dir): 9765863Snate@binkert.org mkdir(opt_dir) 9772632Sstever@eecs.umich.edu 9785863Snate@binkert.org # Get default build variables from source tree. Variables are 9795863Snate@binkert.org # normally determined by name of $VARIANT_DIR, but can be 9802632Sstever@eecs.umich.edu # overriden by 'default=' arg on command line. 9818120Sgblack@eecs.umich.edu default = GetOption('default') 9828120Sgblack@eecs.umich.edu if not default: 9838120Sgblack@eecs.umich.edu default = variant_dir 9848120Sgblack@eecs.umich.edu default_vars_file = joinpath('build_opts', default) 9855863Snate@binkert.org if isfile(default_vars_file): 9865863Snate@binkert.org sticky_vars.files.append(default_vars_file) 9875863Snate@binkert.org print "Variables file %s not found,\n using defaults in %s" \ 9885863Snate@binkert.org % (current_vars_file, default_vars_file) 9892632Sstever@eecs.umich.edu else: 9905863Snate@binkert.org print "Error: cannot find variables file %s or %s" \ 9915863Snate@binkert.org % (current_vars_file, default_vars_file) 9922632Sstever@eecs.umich.edu Exit(1) 9931888SN/A 9945863Snate@binkert.org # Apply current variable settings to env 9955863Snate@binkert.org sticky_vars.Update(env) 9961858SN/A 9978120Sgblack@eecs.umich.edu help_texts["local_vars"] += \ 9988120Sgblack@eecs.umich.edu "Build variables for %s:\n" % variant_dir \ 9997756SAli.Saidi@ARM.com + sticky_vars.GenerateHelpText(env) 10002598SN/A 10015863Snate@binkert.org # Process variable settings. 10021858SN/A 10031858SN/A if not have_fenv and env['USE_FENV']: 10041858SN/A print "Warning: <fenv.h> not available; " \ 10055863Snate@binkert.org "forcing USE_FENV to False in", variant_dir + "." 10061858SN/A env['USE_FENV'] = False 10071858SN/A 10081858SN/A if not env['USE_FENV']: 10095863Snate@binkert.org print "Warning: No IEEE FP rounding mode control in", variant_dir + "." 10101871SN/A print " FP results may deviate slightly from other platforms." 10111858SN/A 10121858SN/A if env['EFENCE']: 10131858SN/A env.Append(LIBS=['efence']) 10141858SN/A 10151858SN/A if env['USE_MYSQL']: 10161858SN/A if not have_mysql: 10171858SN/A print "Warning: MySQL not available; " \ 10185863Snate@binkert.org "forcing USE_MYSQL to False in", variant_dir + "." 10191858SN/A env['USE_MYSQL'] = False 10201858SN/A else: 10215863Snate@binkert.org print "Compiling in", variant_dir, "with MySQL support." 10221859SN/A env.ParseConfig(mysql_config_libs) 10231859SN/A env.ParseConfig(mysql_config_include) 10241869SN/A 10255863Snate@binkert.org # Save sticky variable settings back to current variables file 10265863Snate@binkert.org sticky_vars.Save(current_vars_file, env) 10271869SN/A 10281965SN/A if env['USE_SSE2']: 10297739Sgblack@eecs.umich.edu env.Append(CCFLAGS=['-msse2']) 10301965SN/A 10312761Sstever@eecs.umich.edu # The src/SConscript file sets up the build rules in 'env' according 10325863Snate@binkert.org # to the configured variables. It returns a list of environments, 10331869SN/A # one for each variant build (debug, opt, etc.) 10345863Snate@binkert.org envList = SConscript('src/SConscript', variant_dir = variant_path, 10352667Sstever@eecs.umich.edu exports = 'env') 10361869SN/A 10371869SN/A # Set up the regression tests for each build. 10382929Sktlim@umich.edu for e in envList: 10392929Sktlim@umich.edu SConscript('tests/SConscript', 10405863Snate@binkert.org variant_dir = joinpath(variant_path, 'tests', e.Label), 10412929Sktlim@umich.edu exports = { 'env' : e }, duplicate = False) 1042955SN/A 10438120Sgblack@eecs.umich.edu# base help text 10448120Sgblack@eecs.umich.eduHelp(''' 10458120Sgblack@eecs.umich.eduUsage: scons [scons options] [build variables] [target(s)] 10468120Sgblack@eecs.umich.edu 10478120Sgblack@eecs.umich.eduExtra scons options: 10488120Sgblack@eecs.umich.edu%(options)s 10498120Sgblack@eecs.umich.edu 10508120Sgblack@eecs.umich.eduGlobal build variables: 10518120Sgblack@eecs.umich.edu%(global_vars)s 10528120Sgblack@eecs.umich.edu 10538120Sgblack@eecs.umich.edu%(local_vars)s 10548120Sgblack@eecs.umich.edu''' % help_texts) 1055