SConstruct revision 8483
15390SN/A# -*- mode:python -*- 25443SN/A 35390SN/A# Copyright (c) 2011 Advanced Micro Devices, Inc. 45390SN/A# Copyright (c) 2009 The Hewlett-Packard Development Company 55390SN/A# Copyright (c) 2004-2005 The Regents of The University of Michigan 65390SN/A# All rights reserved. 75390SN/A# 85390SN/A# Redistribution and use in source and binary forms, with or without 95390SN/A# modification, are permitted provided that the following conditions are 105390SN/A# met: redistributions of source code must retain the above copyright 115390SN/A# notice, this list of conditions and the following disclaimer; 125390SN/A# redistributions in binary form must reproduce the above copyright 135390SN/A# notice, this list of conditions and the following disclaimer in the 145390SN/A# documentation and/or other materials provided with the distribution; 155390SN/A# neither the name of the copyright holders nor the names of its 165390SN/A# contributors may be used to endorse or promote products derived from 175390SN/A# this software without specific prior written permission. 185390SN/A# 195390SN/A# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 205390SN/A# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 215390SN/A# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 225390SN/A# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 235390SN/A# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 245390SN/A# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 255390SN/A# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 265390SN/A# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 275390SN/A# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 285390SN/A# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 295390SN/A# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 305390SN/A# 315636Sgblack@eecs.umich.edu# Authors: Steve Reinhardt 325636Sgblack@eecs.umich.edu# Nathan Binkert 335390SN/A 345443SN/A################################################### 3514290Sgabeblack@google.com# 365636Sgblack@eecs.umich.edu# SCons top-level build description (SConstruct) file. 375636Sgblack@eecs.umich.edu# 385443SN/A# While in this directory ('m5'), just type 'scons' to build the default 395390SN/A# configuration (see below), or type 'scons build/<CONFIG>/<binary>' 405390SN/A# to build some other configuration (e.g., 'build/ALPHA_FS/m5.opt' for 415390SN/A# the optimized full-system version). 425636Sgblack@eecs.umich.edu# 435390SN/A# You can build M5 in a different directory as long as there is a 445636Sgblack@eecs.umich.edu# 'build/<CONFIG>' somewhere along the target path. The build system 455636Sgblack@eecs.umich.edu# expects that all configs under the same build directory are being 465642Sgblack@eecs.umich.edu# built for the same host system. 475642Sgblack@eecs.umich.edu# 485642Sgblack@eecs.umich.edu# Examples: 495642Sgblack@eecs.umich.edu# 505642Sgblack@eecs.umich.edu# The following two commands are equivalent. The '-u' option tells 515642Sgblack@eecs.umich.edu# scons to search up the directory tree for this SConstruct file. 525642Sgblack@eecs.umich.edu# % cd <path-to-src>/m5 ; scons build/ALPHA_FS/m5.debug 535642Sgblack@eecs.umich.edu# % cd <path-to-src>/m5/build/ALPHA_FS; scons -u m5.debug 545642Sgblack@eecs.umich.edu# 555642Sgblack@eecs.umich.edu# The following two commands are equivalent and demonstrate building 565642Sgblack@eecs.umich.edu# in a directory outside of the source tree. The '-C' option tells 575642Sgblack@eecs.umich.edu# scons to chdir to the specified directory to find this SConstruct 585642Sgblack@eecs.umich.edu# file. 595642Sgblack@eecs.umich.edu# % cd <path-to-src>/m5 ; scons /local/foo/build/ALPHA_FS/m5.debug 605642Sgblack@eecs.umich.edu# % cd /local/foo/build/ALPHA_FS; scons -C <path-to-src>/m5 m5.debug 615642Sgblack@eecs.umich.edu# 625642Sgblack@eecs.umich.edu# You can use 'scons -H' to print scons options. If you're in this 6311320Ssteve.reinhardt@amd.com# 'm5' directory (or use -u or -C to tell scons where to find this 645642Sgblack@eecs.umich.edu# file), you can use 'scons -h' to print all the M5-specific build 655390SN/A# options as well. 6614290Sgabeblack@google.com# 6711320Ssteve.reinhardt@amd.com################################################### 685642Sgblack@eecs.umich.edu 695390SN/A# Check for recent-enough Python and SCons versions. 705636Sgblack@eecs.umich.edutry: 715636Sgblack@eecs.umich.edu # Really old versions of scons only take two options for the 725636Sgblack@eecs.umich.edu # function, so check once without the revision and once with the 7314290Sgabeblack@google.com # revision, the first instance will fail for stuff other than 7414290Sgabeblack@google.com # 0.98, and the second will fail for 0.98.0 7514290Sgabeblack@google.com EnsureSConsVersion(0, 98) 7614290Sgabeblack@google.com EnsureSConsVersion(0, 98, 1) 7714290Sgabeblack@google.comexcept SystemExit, e: 7814290Sgabeblack@google.com print """ 7914290Sgabeblack@google.comFor more details, see: 8014290Sgabeblack@google.com http://m5sim.org/wiki/index.php/Compiling_M5 8114290Sgabeblack@google.com""" 825636Sgblack@eecs.umich.edu raise 835636Sgblack@eecs.umich.edu 845636Sgblack@eecs.umich.edu# We ensure the python version early because we have stuff that 855636Sgblack@eecs.umich.edu# requires python 2.4 865636Sgblack@eecs.umich.edutry: 875636Sgblack@eecs.umich.edu EnsurePythonVersion(2, 4) 889808Sstever@gmail.comexcept SystemExit, e: 8914290Sgabeblack@google.com print """ 905636Sgblack@eecs.umich.eduYou can use a non-default installation of the Python interpreter by 9114290Sgabeblack@google.comeither (1) rearranging your PATH so that scons finds the non-default 9214290Sgabeblack@google.com'python' first or (2) explicitly invoking an alternative interpreter 9314290Sgabeblack@google.comon the scons script. 9414290Sgabeblack@google.com 955636Sgblack@eecs.umich.eduFor more details, see: 9611175Sandreas.hansson@arm.com http://m5sim.org/wiki/index.php/Using_a_non-default_Python_installation 975390SN/A""" 9811175Sandreas.hansson@arm.com raise 995636Sgblack@eecs.umich.edu 1005636Sgblack@eecs.umich.edu# Global Python includes 1015636Sgblack@eecs.umich.eduimport os 1025636Sgblack@eecs.umich.eduimport re 1035636Sgblack@eecs.umich.eduimport subprocess 1045636Sgblack@eecs.umich.eduimport sys 1055636Sgblack@eecs.umich.edu 1065636Sgblack@eecs.umich.edufrom os import mkdir, environ 1075636Sgblack@eecs.umich.edufrom os.path import abspath, basename, dirname, expanduser, normpath 1085636Sgblack@eecs.umich.edufrom os.path import exists, isdir, isfile 1095636Sgblack@eecs.umich.edufrom os.path import join as joinpath, split as splitpath 1105636Sgblack@eecs.umich.edu 1115636Sgblack@eecs.umich.edu# SCons includes 1125636Sgblack@eecs.umich.eduimport SCons 1135636Sgblack@eecs.umich.eduimport SCons.Node 1145636Sgblack@eecs.umich.edu 1155636Sgblack@eecs.umich.eduextra_python_paths = [ 1165636Sgblack@eecs.umich.edu Dir('src/python').srcnode().abspath, # M5 includes 1175636Sgblack@eecs.umich.edu Dir('ext/ply').srcnode().abspath, # ply is used by several files 1185636Sgblack@eecs.umich.edu ] 1195636Sgblack@eecs.umich.edu 1205636Sgblack@eecs.umich.edusys.path[1:1] = extra_python_paths 1215636Sgblack@eecs.umich.edu 1225636Sgblack@eecs.umich.edufrom m5.util import compareVersions, readCommand 1237903Shestness@cs.utexas.edu 12411168Sandreas.hansson@arm.comhelp_texts = { 12511168Sandreas.hansson@arm.com "options" : "", 12610905Sandreas.sandberg@arm.com "global_vars" : "", 12711175Sandreas.hansson@arm.com "local_vars" : "" 1287903Shestness@cs.utexas.edu} 1295390SN/A 1305390SN/AExport("help_texts") 1317811Ssteve.reinhardt@amd.com 1325390SN/Adef AddM5Option(*args, **kwargs): 1335390SN/A col_width = 30 134 135 help = " " + ", ".join(args) 136 if "help" in kwargs: 137 length = len(help) 138 if length >= col_width: 139 help += "\n" + " " * col_width 140 else: 141 help += " " * (col_width - length) 142 help += kwargs["help"] 143 help_texts["options"] += help + "\n" 144 145 AddOption(*args, **kwargs) 146 147AddM5Option('--colors', dest='use_colors', action='store_true', 148 help="Add color to abbreviated scons output") 149AddM5Option('--no-colors', dest='use_colors', action='store_false', 150 help="Don't add color to abbreviated scons output") 151AddM5Option('--default', dest='default', type='string', action='store', 152 help='Override which build_opts file to use for defaults') 153AddM5Option('--ignore-style', dest='ignore_style', action='store_true', 154 help='Disable style checking hooks') 155AddM5Option('--update-ref', dest='update_ref', action='store_true', 156 help='Update test reference outputs') 157AddM5Option('--verbose', dest='verbose', action='store_true', 158 help='Print full tool command lines') 159 160use_colors = GetOption('use_colors') 161if use_colors: 162 from m5.util.terminal import termcap 163elif use_colors is None: 164 # option unspecified; default behavior is to use colors iff isatty 165 from m5.util.terminal import tty_termcap as termcap 166else: 167 from m5.util.terminal import no_termcap as termcap 168 169######################################################################## 170# 171# Set up the main build environment. 172# 173######################################################################## 174use_vars = set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH', 'PATH', 175 'PYTHONPATH', 'RANLIB' ]) 176 177use_env = {} 178for key,val in os.environ.iteritems(): 179 if key in use_vars or key.startswith("M5"): 180 use_env[key] = val 181 182main = Environment(ENV=use_env) 183main.root = Dir(".") # The current directory (where this file lives). 184main.srcdir = Dir("src") # The source directory 185 186# add useful python code PYTHONPATH so it can be used by subprocesses 187# as well 188main.AppendENVPath('PYTHONPATH', extra_python_paths) 189 190######################################################################## 191# 192# Mercurial Stuff. 193# 194# If the M5 directory is a mercurial repository, we should do some 195# extra things. 196# 197######################################################################## 198 199hgdir = main.root.Dir(".hg") 200 201mercurial_style_message = """ 202You're missing the gem5 style hook, which automatically checks your code 203against the gem5 style rules on hg commit and qrefresh commands. This 204script will now install the hook in your .hg/hgrc file. 205Press enter to continue, or ctrl-c to abort: """ 206 207mercurial_style_hook = """ 208# The following lines were automatically added by gem5/SConstruct 209# to provide the gem5 style-checking hooks 210[extensions] 211style = %s/util/style.py 212 213[hooks] 214pretxncommit.style = python:style.check_style 215pre-qrefresh.style = python:style.check_style 216# End of SConstruct additions 217 218""" % (main.root.abspath) 219 220mercurial_lib_not_found = """ 221Mercurial libraries cannot be found, ignoring style hook. If 222you are a gem5 developer, please fix this and run the style 223hook. It is important. 224""" 225 226# Check for style hook and prompt for installation if it's not there. 227# Skip this if --ignore-style was specified, there's no .hg dir to 228# install a hook in, or there's no interactive terminal to prompt. 229if not GetOption('ignore_style') and hgdir.exists() and sys.stdin.isatty(): 230 style_hook = True 231 try: 232 from mercurial import ui 233 ui = ui.ui() 234 ui.readconfig(hgdir.File('hgrc').abspath) 235 style_hook = ui.config('hooks', 'pretxncommit.style', None) and \ 236 ui.config('hooks', 'pre-qrefresh.style', None) 237 except ImportError: 238 print mercurial_lib_not_found 239 240 if not style_hook: 241 print mercurial_style_message, 242 # continue unless user does ctrl-c/ctrl-d etc. 243 try: 244 raw_input() 245 except: 246 print "Input exception, exiting scons.\n" 247 sys.exit(1) 248 hgrc_path = '%s/.hg/hgrc' % main.root.abspath 249 print "Adding style hook to", hgrc_path, "\n" 250 try: 251 hgrc = open(hgrc_path, 'a') 252 hgrc.write(mercurial_style_hook) 253 hgrc.close() 254 except: 255 print "Error updating", hgrc_path 256 sys.exit(1) 257 258 259################################################### 260# 261# Figure out which configurations to set up based on the path(s) of 262# the target(s). 263# 264################################################### 265 266# Find default configuration & binary. 267Default(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA_SE/m5.debug')) 268 269# helper function: find last occurrence of element in list 270def rfind(l, elt, offs = -1): 271 for i in range(len(l)+offs, 0, -1): 272 if l[i] == elt: 273 return i 274 raise ValueError, "element not found" 275 276# Take a list of paths (or SCons Nodes) and return a list with all 277# paths made absolute and ~-expanded. Paths will be interpreted 278# relative to the launch directory unless a different root is provided 279def makePathListAbsolute(path_list, root=GetLaunchDir()): 280 return [abspath(joinpath(root, expanduser(str(p)))) 281 for p in path_list] 282 283# Each target must have 'build' in the interior of the path; the 284# directory below this will determine the build parameters. For 285# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we 286# recognize that ALPHA_SE specifies the configuration because it 287# follow 'build' in the build path. 288 289# The funky assignment to "[:]" is needed to replace the list contents 290# in place rather than reassign the symbol to a new list, which 291# doesn't work (obviously!). 292BUILD_TARGETS[:] = makePathListAbsolute(BUILD_TARGETS) 293 294# Generate a list of the unique build roots and configs that the 295# collected targets reference. 296variant_paths = [] 297build_root = None 298for t in BUILD_TARGETS: 299 path_dirs = t.split('/') 300 try: 301 build_top = rfind(path_dirs, 'build', -2) 302 except: 303 print "Error: no non-leaf 'build' dir found on target path", t 304 Exit(1) 305 this_build_root = joinpath('/',*path_dirs[:build_top+1]) 306 if not build_root: 307 build_root = this_build_root 308 else: 309 if this_build_root != build_root: 310 print "Error: build targets not under same build root\n"\ 311 " %s\n %s" % (build_root, this_build_root) 312 Exit(1) 313 variant_path = joinpath('/',*path_dirs[:build_top+2]) 314 if variant_path not in variant_paths: 315 variant_paths.append(variant_path) 316 317# Make sure build_root exists (might not if this is the first build there) 318if not isdir(build_root): 319 mkdir(build_root) 320main['BUILDROOT'] = build_root 321 322Export('main') 323 324main.SConsignFile(joinpath(build_root, "sconsign")) 325 326# Default duplicate option is to use hard links, but this messes up 327# when you use emacs to edit a file in the target dir, as emacs moves 328# file to file~ then copies to file, breaking the link. Symbolic 329# (soft) links work better. 330main.SetOption('duplicate', 'soft-copy') 331 332# 333# Set up global sticky variables... these are common to an entire build 334# tree (not specific to a particular build like ALPHA_SE) 335# 336 337global_vars_file = joinpath(build_root, 'variables.global') 338 339global_vars = Variables(global_vars_file, args=ARGUMENTS) 340 341global_vars.AddVariables( 342 ('CC', 'C compiler', environ.get('CC', main['CC'])), 343 ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])), 344 ('BATCH', 'Use batch pool for build and tests', False), 345 ('BATCH_CMD', 'Batch pool submission command name', 'qdo'), 346 ('M5_BUILD_CACHE', 'Cache built objects in this directory', False), 347 ('EXTRAS', 'Add extra directories to the compilation', '') 348 ) 349 350# Update main environment with values from ARGUMENTS & global_vars_file 351global_vars.Update(main) 352help_texts["global_vars"] += global_vars.GenerateHelpText(main) 353 354# Save sticky variable settings back to current variables file 355global_vars.Save(global_vars_file, main) 356 357# Parse EXTRAS variable to build list of all directories where we're 358# look for sources etc. This list is exported as extras_dir_list. 359base_dir = main.srcdir.abspath 360if main['EXTRAS']: 361 extras_dir_list = makePathListAbsolute(main['EXTRAS'].split(':')) 362else: 363 extras_dir_list = [] 364 365Export('base_dir') 366Export('extras_dir_list') 367 368# the ext directory should be on the #includes path 369main.Append(CPPPATH=[Dir('ext')]) 370 371def strip_build_path(path, env): 372 path = str(path) 373 variant_base = env['BUILDROOT'] + os.path.sep 374 if path.startswith(variant_base): 375 path = path[len(variant_base):] 376 elif path.startswith('build/'): 377 path = path[6:] 378 return path 379 380# Generate a string of the form: 381# common/path/prefix/src1, src2 -> tgt1, tgt2 382# to print while building. 383class Transform(object): 384 # all specific color settings should be here and nowhere else 385 tool_color = termcap.Normal 386 pfx_color = termcap.Yellow 387 srcs_color = termcap.Yellow + termcap.Bold 388 arrow_color = termcap.Blue + termcap.Bold 389 tgts_color = termcap.Yellow + termcap.Bold 390 391 def __init__(self, tool, max_sources=99): 392 self.format = self.tool_color + (" [%8s] " % tool) \ 393 + self.pfx_color + "%s" \ 394 + self.srcs_color + "%s" \ 395 + self.arrow_color + " -> " \ 396 + self.tgts_color + "%s" \ 397 + termcap.Normal 398 self.max_sources = max_sources 399 400 def __call__(self, target, source, env, for_signature=None): 401 # truncate source list according to max_sources param 402 source = source[0:self.max_sources] 403 def strip(f): 404 return strip_build_path(str(f), env) 405 if len(source) > 0: 406 srcs = map(strip, source) 407 else: 408 srcs = [''] 409 tgts = map(strip, target) 410 # surprisingly, os.path.commonprefix is a dumb char-by-char string 411 # operation that has nothing to do with paths. 412 com_pfx = os.path.commonprefix(srcs + tgts) 413 com_pfx_len = len(com_pfx) 414 if com_pfx: 415 # do some cleanup and sanity checking on common prefix 416 if com_pfx[-1] == ".": 417 # prefix matches all but file extension: ok 418 # back up one to change 'foo.cc -> o' to 'foo.cc -> .o' 419 com_pfx = com_pfx[0:-1] 420 elif com_pfx[-1] == "/": 421 # common prefix is directory path: OK 422 pass 423 else: 424 src0_len = len(srcs[0]) 425 tgt0_len = len(tgts[0]) 426 if src0_len == com_pfx_len: 427 # source is a substring of target, OK 428 pass 429 elif tgt0_len == com_pfx_len: 430 # target is a substring of source, need to back up to 431 # avoid empty string on RHS of arrow 432 sep_idx = com_pfx.rfind(".") 433 if sep_idx != -1: 434 com_pfx = com_pfx[0:sep_idx] 435 else: 436 com_pfx = '' 437 elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".": 438 # still splitting at file extension: ok 439 pass 440 else: 441 # probably a fluke; ignore it 442 com_pfx = '' 443 # recalculate length in case com_pfx was modified 444 com_pfx_len = len(com_pfx) 445 def fmt(files): 446 f = map(lambda s: s[com_pfx_len:], files) 447 return ', '.join(f) 448 return self.format % (com_pfx, fmt(srcs), fmt(tgts)) 449 450Export('Transform') 451 452 453if GetOption('verbose'): 454 def MakeAction(action, string, *args, **kwargs): 455 return Action(action, *args, **kwargs) 456else: 457 MakeAction = Action 458 main['CCCOMSTR'] = Transform("CC") 459 main['CXXCOMSTR'] = Transform("CXX") 460 main['ASCOMSTR'] = Transform("AS") 461 main['SWIGCOMSTR'] = Transform("SWIG") 462 main['ARCOMSTR'] = Transform("AR", 0) 463 main['LINKCOMSTR'] = Transform("LINK", 0) 464 main['RANLIBCOMSTR'] = Transform("RANLIB", 0) 465 main['M4COMSTR'] = Transform("M4") 466 main['SHCCCOMSTR'] = Transform("SHCC") 467 main['SHCXXCOMSTR'] = Transform("SHCXX") 468Export('MakeAction') 469 470CXX_version = readCommand([main['CXX'],'--version'], exception=False) 471CXX_V = readCommand([main['CXX'],'-V'], exception=False) 472 473main['GCC'] = CXX_version and CXX_version.find('g++') >= 0 474main['SUNCC'] = CXX_V and CXX_V.find('Sun C++') >= 0 475main['ICC'] = CXX_V and CXX_V.find('Intel') >= 0 476if main['GCC'] + main['SUNCC'] + main['ICC'] > 1: 477 print 'Error: How can we have two at the same time?' 478 Exit(1) 479 480# Set up default C++ compiler flags 481if main['GCC']: 482 main.Append(CCFLAGS=['-pipe']) 483 main.Append(CCFLAGS=['-fno-strict-aliasing']) 484 main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef']) 485 main.Append(CXXFLAGS=['-Wno-deprecated']) 486 # Read the GCC version to check for versions with bugs 487 # Note CCVERSION doesn't work here because it is run with the CC 488 # before we override it from the command line 489 gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False) 490 if not compareVersions(gcc_version, '4.4.1') or \ 491 not compareVersions(gcc_version, '4.4.2'): 492 print 'Info: Tree vectorizer in GCC 4.4.1 & 4.4.2 is buggy, disabling.' 493 main.Append(CCFLAGS=['-fno-tree-vectorize']) 494elif main['ICC']: 495 pass #Fix me... add warning flags once we clean up icc warnings 496elif main['SUNCC']: 497 main.Append(CCFLAGS=['-Qoption ccfe']) 498 main.Append(CCFLAGS=['-features=gcc']) 499 main.Append(CCFLAGS=['-features=extensions']) 500 main.Append(CCFLAGS=['-library=stlport4']) 501 main.Append(CCFLAGS=['-xar']) 502 #main.Append(CCFLAGS=['-instances=semiexplicit']) 503else: 504 print 'Error: Don\'t know what compiler options to use for your compiler.' 505 print ' Please fix SConstruct and src/SConscript and try again.' 506 Exit(1) 507 508# Set up common yacc/bison flags (needed for Ruby) 509main['YACCFLAGS'] = '-d' 510main['YACCHXXFILESUFFIX'] = '.hh' 511 512# Do this after we save setting back, or else we'll tack on an 513# extra 'qdo' every time we run scons. 514if main['BATCH']: 515 main['CC'] = main['BATCH_CMD'] + ' ' + main['CC'] 516 main['CXX'] = main['BATCH_CMD'] + ' ' + main['CXX'] 517 main['AS'] = main['BATCH_CMD'] + ' ' + main['AS'] 518 main['AR'] = main['BATCH_CMD'] + ' ' + main['AR'] 519 main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB'] 520 521if sys.platform == 'cygwin': 522 # cygwin has some header file issues... 523 main.Append(CCFLAGS=["-Wno-uninitialized"]) 524 525# Check for SWIG 526if not main.has_key('SWIG'): 527 print 'Error: SWIG utility not found.' 528 print ' Please install (see http://www.swig.org) and retry.' 529 Exit(1) 530 531# Check for appropriate SWIG version 532swig_version = readCommand(('swig', '-version'), exception='').split() 533# First 3 words should be "SWIG Version x.y.z" 534if len(swig_version) < 3 or \ 535 swig_version[0] != 'SWIG' or swig_version[1] != 'Version': 536 print 'Error determining SWIG version.' 537 Exit(1) 538 539min_swig_version = '1.3.28' 540if compareVersions(swig_version[2], min_swig_version) < 0: 541 print 'Error: SWIG version', min_swig_version, 'or newer required.' 542 print ' Installed version:', swig_version[2] 543 Exit(1) 544 545# Set up SWIG flags & scanner 546swig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS') 547main.Append(SWIGFLAGS=swig_flags) 548 549# filter out all existing swig scanners, they mess up the dependency 550# stuff for some reason 551scanners = [] 552for scanner in main['SCANNERS']: 553 skeys = scanner.skeys 554 if skeys == '.i': 555 continue 556 557 if isinstance(skeys, (list, tuple)) and '.i' in skeys: 558 continue 559 560 scanners.append(scanner) 561 562# add the new swig scanner that we like better 563from SCons.Scanner import ClassicCPP as CPPScanner 564swig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")' 565scanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re)) 566 567# replace the scanners list that has what we want 568main['SCANNERS'] = scanners 569 570# Add a custom Check function to the Configure context so that we can 571# figure out if the compiler adds leading underscores to global 572# variables. This is needed for the autogenerated asm files that we 573# use for embedding the python code. 574def CheckLeading(context): 575 context.Message("Checking for leading underscore in global variables...") 576 # 1) Define a global variable called x from asm so the C compiler 577 # won't change the symbol at all. 578 # 2) Declare that variable. 579 # 3) Use the variable 580 # 581 # If the compiler prepends an underscore, this will successfully 582 # link because the external symbol 'x' will be called '_x' which 583 # was defined by the asm statement. If the compiler does not 584 # prepend an underscore, this will not successfully link because 585 # '_x' will have been defined by assembly, while the C portion of 586 # the code will be trying to use 'x' 587 ret = context.TryLink(''' 588 asm(".globl _x; _x: .byte 0"); 589 extern int x; 590 int main() { return x; } 591 ''', extension=".c") 592 context.env.Append(LEADING_UNDERSCORE=ret) 593 context.Result(ret) 594 return ret 595 596# Platform-specific configuration. Note again that we assume that all 597# builds under a given build root run on the same host platform. 598conf = Configure(main, 599 conf_dir = joinpath(build_root, '.scons_config'), 600 log_file = joinpath(build_root, 'scons_config.log'), 601 custom_tests = { 'CheckLeading' : CheckLeading }) 602 603# Check for leading underscores. Don't really need to worry either 604# way so don't need to check the return code. 605conf.CheckLeading() 606 607# Check if we should compile a 64 bit binary on Mac OS X/Darwin 608try: 609 import platform 610 uname = platform.uname() 611 if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0: 612 if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]): 613 main.Append(CCFLAGS=['-arch', 'x86_64']) 614 main.Append(CFLAGS=['-arch', 'x86_64']) 615 main.Append(LINKFLAGS=['-arch', 'x86_64']) 616 main.Append(ASFLAGS=['-arch', 'x86_64']) 617except: 618 pass 619 620# Recent versions of scons substitute a "Null" object for Configure() 621# when configuration isn't necessary, e.g., if the "--help" option is 622# present. Unfortuantely this Null object always returns false, 623# breaking all our configuration checks. We replace it with our own 624# more optimistic null object that returns True instead. 625if not conf: 626 def NullCheck(*args, **kwargs): 627 return True 628 629 class NullConf: 630 def __init__(self, env): 631 self.env = env 632 def Finish(self): 633 return self.env 634 def __getattr__(self, mname): 635 return NullCheck 636 637 conf = NullConf(main) 638 639# Find Python include and library directories for embedding the 640# interpreter. For consistency, we will use the same Python 641# installation used to run scons (and thus this script). If you want 642# to link in an alternate version, see above for instructions on how 643# to invoke scons with a different copy of the Python interpreter. 644from distutils import sysconfig 645 646py_getvar = sysconfig.get_config_var 647 648py_debug = getattr(sys, 'pydebug', False) 649py_version = 'python' + py_getvar('VERSION') + (py_debug and "_d" or "") 650 651py_general_include = sysconfig.get_python_inc() 652py_platform_include = sysconfig.get_python_inc(plat_specific=True) 653py_includes = [ py_general_include ] 654if py_platform_include != py_general_include: 655 py_includes.append(py_platform_include) 656 657py_lib_path = [ py_getvar('LIBDIR') ] 658# add the prefix/lib/pythonX.Y/config dir, but only if there is no 659# shared library in prefix/lib/. 660if not py_getvar('Py_ENABLE_SHARED'): 661 py_lib_path.append(py_getvar('LIBPL')) 662 663py_libs = [] 664for lib in py_getvar('LIBS').split() + py_getvar('SYSLIBS').split(): 665 assert lib.startswith('-l') 666 lib = lib[2:] 667 if lib not in py_libs: 668 py_libs.append(lib) 669py_libs.append(py_version) 670 671main.Append(CPPPATH=py_includes) 672main.Append(LIBPATH=py_lib_path) 673 674# Cache build files in the supplied directory. 675if main['M5_BUILD_CACHE']: 676 print 'Using build cache located at', main['M5_BUILD_CACHE'] 677 CacheDir(main['M5_BUILD_CACHE']) 678 679 680# verify that this stuff works 681if not conf.CheckHeader('Python.h', '<>'): 682 print "Error: can't find Python.h header in", py_includes 683 Exit(1) 684 685for lib in py_libs: 686 if not conf.CheckLib(lib): 687 print "Error: can't find library %s required by python" % lib 688 Exit(1) 689 690# On Solaris you need to use libsocket for socket ops 691if not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'): 692 if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'): 693 print "Can't find library with socket calls (e.g. accept())" 694 Exit(1) 695 696# Check for zlib. If the check passes, libz will be automatically 697# added to the LIBS environment variable. 698if not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'): 699 print 'Error: did not find needed zlib compression library '\ 700 'and/or zlib.h header file.' 701 print ' Please install zlib and try again.' 702 Exit(1) 703 704# Check for librt. 705have_posix_clock = \ 706 conf.CheckLibWithHeader(None, 'time.h', 'C', 707 'clock_nanosleep(0,0,NULL,NULL);') or \ 708 conf.CheckLibWithHeader('rt', 'time.h', 'C', 709 'clock_nanosleep(0,0,NULL,NULL);') 710 711if not have_posix_clock: 712 print "Can't find library for POSIX clocks." 713 714# Check for <fenv.h> (C99 FP environment control) 715have_fenv = conf.CheckHeader('fenv.h', '<>') 716if not have_fenv: 717 print "Warning: Header file <fenv.h> not found." 718 print " This host has no IEEE FP rounding mode control." 719 720###################################################################### 721# 722# Finish the configuration 723# 724main = conf.Finish() 725 726###################################################################### 727# 728# Collect all non-global variables 729# 730 731# Define the universe of supported ISAs 732all_isa_list = [ ] 733Export('all_isa_list') 734 735class CpuModel(object): 736 '''The CpuModel class encapsulates everything the ISA parser needs to 737 know about a particular CPU model.''' 738 739 # Dict of available CPU model objects. Accessible as CpuModel.dict. 740 dict = {} 741 list = [] 742 defaults = [] 743 744 # Constructor. Automatically adds models to CpuModel.dict. 745 def __init__(self, name, filename, includes, strings, default=False): 746 self.name = name # name of model 747 self.filename = filename # filename for output exec code 748 self.includes = includes # include files needed in exec file 749 # The 'strings' dict holds all the per-CPU symbols we can 750 # substitute into templates etc. 751 self.strings = strings 752 753 # This cpu is enabled by default 754 self.default = default 755 756 # Add self to dict 757 if name in CpuModel.dict: 758 raise AttributeError, "CpuModel '%s' already registered" % name 759 CpuModel.dict[name] = self 760 CpuModel.list.append(name) 761 762Export('CpuModel') 763 764# Sticky variables get saved in the variables file so they persist from 765# one invocation to the next (unless overridden, in which case the new 766# value becomes sticky). 767sticky_vars = Variables(args=ARGUMENTS) 768Export('sticky_vars') 769 770# Sticky variables that should be exported 771export_vars = [] 772Export('export_vars') 773 774# Walk the tree and execute all SConsopts scripts that wil add to the 775# above variables 776if not GetOption('verbose'): 777 print "Reading SConsopts" 778for bdir in [ base_dir ] + extras_dir_list: 779 if not isdir(bdir): 780 print "Error: directory '%s' does not exist" % bdir 781 Exit(1) 782 for root, dirs, files in os.walk(bdir): 783 if 'SConsopts' in files: 784 if GetOption('verbose'): 785 print "Reading", joinpath(root, 'SConsopts') 786 SConscript(joinpath(root, 'SConsopts')) 787 788all_isa_list.sort() 789 790sticky_vars.AddVariables( 791 EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list), 792 BoolVariable('FULL_SYSTEM', 'Full-system support', False), 793 ListVariable('CPU_MODELS', 'CPU models', 794 sorted(n for n,m in CpuModel.dict.iteritems() if m.default), 795 sorted(CpuModel.list)), 796 BoolVariable('NO_FAST_ALLOC', 'Disable fast object allocator', False), 797 BoolVariable('FORCE_FAST_ALLOC', 798 'Enable fast object allocator, even for m5.debug', False), 799 BoolVariable('FAST_ALLOC_STATS', 'Enable fast object allocator statistics', 800 False), 801 BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger', 802 False), 803 BoolVariable('SS_COMPATIBLE_FP', 804 'Make floating-point results compatible with SimpleScalar', 805 False), 806 BoolVariable('USE_SSE2', 807 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts', 808 False), 809 BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock), 810 BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv), 811 BoolVariable('USE_CHECKER', 'Use checker for detailed CPU models', False), 812 BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False), 813 ) 814 815# These variables get exported to #defines in config/*.hh (see src/SConscript). 816export_vars += ['FULL_SYSTEM', 'USE_FENV', 817 'NO_FAST_ALLOC', 'FORCE_FAST_ALLOC', 'FAST_ALLOC_STATS', 818 'SS_COMPATIBLE_FP', 'USE_CHECKER', 'TARGET_ISA', 'CP_ANNOTATE', 819 'USE_POSIX_CLOCK' ] 820 821################################################### 822# 823# Define a SCons builder for configuration flag headers. 824# 825################################################### 826 827# This function generates a config header file that #defines the 828# variable symbol to the current variable setting (0 or 1). The source 829# operands are the name of the variable and a Value node containing the 830# value of the variable. 831def build_config_file(target, source, env): 832 (variable, value) = [s.get_contents() for s in source] 833 f = file(str(target[0]), 'w') 834 print >> f, '#define', variable, value 835 f.close() 836 return None 837 838# Combine the two functions into a scons Action object. 839config_action = MakeAction(build_config_file, Transform("CONFIG H", 2)) 840 841# The emitter munges the source & target node lists to reflect what 842# we're really doing. 843def config_emitter(target, source, env): 844 # extract variable name from Builder arg 845 variable = str(target[0]) 846 # True target is config header file 847 target = joinpath('config', variable.lower() + '.hh') 848 val = env[variable] 849 if isinstance(val, bool): 850 # Force value to 0/1 851 val = int(val) 852 elif isinstance(val, str): 853 val = '"' + val + '"' 854 855 # Sources are variable name & value (packaged in SCons Value nodes) 856 return ([target], [Value(variable), Value(val)]) 857 858config_builder = Builder(emitter = config_emitter, action = config_action) 859 860main.Append(BUILDERS = { 'ConfigFile' : config_builder }) 861 862# libelf build is shared across all configs in the build root. 863main.SConscript('ext/libelf/SConscript', 864 variant_dir = joinpath(build_root, 'libelf')) 865 866# gzstream build is shared across all configs in the build root. 867main.SConscript('ext/gzstream/SConscript', 868 variant_dir = joinpath(build_root, 'gzstream')) 869 870################################################### 871# 872# This function is used to set up a directory with switching headers 873# 874################################################### 875 876main['ALL_ISA_LIST'] = all_isa_list 877def make_switching_dir(dname, switch_headers, env): 878 # Generate the header. target[0] is the full path of the output 879 # header to generate. 'source' is a dummy variable, since we get the 880 # list of ISAs from env['ALL_ISA_LIST']. 881 def gen_switch_hdr(target, source, env): 882 fname = str(target[0]) 883 f = open(fname, 'w') 884 isa = env['TARGET_ISA'].lower() 885 print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname)) 886 f.close() 887 888 # Build SCons Action object. 'varlist' specifies env vars that this 889 # action depends on; when env['ALL_ISA_LIST'] changes these actions 890 # should get re-executed. 891 switch_hdr_action = MakeAction(gen_switch_hdr, 892 Transform("GENERATE"), varlist=['ALL_ISA_LIST']) 893 894 # Instantiate actions for each header 895 for hdr in switch_headers: 896 env.Command(hdr, [], switch_hdr_action) 897Export('make_switching_dir') 898 899################################################### 900# 901# Define build environments for selected configurations. 902# 903################################################### 904 905for variant_path in variant_paths: 906 print "Building in", variant_path 907 908 # Make a copy of the build-root environment to use for this config. 909 env = main.Clone() 910 env['BUILDDIR'] = variant_path 911 912 # variant_dir is the tail component of build path, and is used to 913 # determine the build parameters (e.g., 'ALPHA_SE') 914 (build_root, variant_dir) = splitpath(variant_path) 915 916 # Set env variables according to the build directory config. 917 sticky_vars.files = [] 918 # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in 919 # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke 920 # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings. 921 current_vars_file = joinpath(build_root, 'variables', variant_dir) 922 if isfile(current_vars_file): 923 sticky_vars.files.append(current_vars_file) 924 print "Using saved variables file %s" % current_vars_file 925 else: 926 # Build dir-specific variables file doesn't exist. 927 928 # Make sure the directory is there so we can create it later 929 opt_dir = dirname(current_vars_file) 930 if not isdir(opt_dir): 931 mkdir(opt_dir) 932 933 # Get default build variables from source tree. Variables are 934 # normally determined by name of $VARIANT_DIR, but can be 935 # overridden by '--default=' arg on command line. 936 default = GetOption('default') 937 opts_dir = joinpath(main.root.abspath, 'build_opts') 938 if default: 939 default_vars_files = [joinpath(build_root, 'variables', default), 940 joinpath(opts_dir, default)] 941 else: 942 default_vars_files = [joinpath(opts_dir, variant_dir)] 943 existing_files = filter(isfile, default_vars_files) 944 if existing_files: 945 default_vars_file = existing_files[0] 946 sticky_vars.files.append(default_vars_file) 947 print "Variables file %s not found,\n using defaults in %s" \ 948 % (current_vars_file, default_vars_file) 949 else: 950 print "Error: cannot find variables file %s or " \ 951 "default file(s) %s" \ 952 % (current_vars_file, ' or '.join(default_vars_files)) 953 Exit(1) 954 955 # Apply current variable settings to env 956 sticky_vars.Update(env) 957 958 help_texts["local_vars"] += \ 959 "Build variables for %s:\n" % variant_dir \ 960 + sticky_vars.GenerateHelpText(env) 961 962 # Process variable settings. 963 964 if not have_fenv and env['USE_FENV']: 965 print "Warning: <fenv.h> not available; " \ 966 "forcing USE_FENV to False in", variant_dir + "." 967 env['USE_FENV'] = False 968 969 if not env['USE_FENV']: 970 print "Warning: No IEEE FP rounding mode control in", variant_dir + "." 971 print " FP results may deviate slightly from other platforms." 972 973 if env['EFENCE']: 974 env.Append(LIBS=['efence']) 975 976 # Save sticky variable settings back to current variables file 977 sticky_vars.Save(current_vars_file, env) 978 979 if env['USE_SSE2']: 980 env.Append(CCFLAGS=['-msse2']) 981 982 if env['PROTOCOL'] != 'None': 983 env['RUBY'] = True 984 else: 985 env['RUBY'] = False 986 987 # The src/SConscript file sets up the build rules in 'env' according 988 # to the configured variables. It returns a list of environments, 989 # one for each variant build (debug, opt, etc.) 990 envList = SConscript('src/SConscript', variant_dir = variant_path, 991 exports = 'env') 992 993 # Set up the regression tests for each build. 994 for e in envList: 995 SConscript('tests/SConscript', 996 variant_dir = joinpath(variant_path, 'tests', e.Label), 997 exports = { 'env' : e }, duplicate = False) 998 999# base help text 1000Help(''' 1001Usage: scons [scons options] [build variables] [target(s)] 1002 1003Extra scons options: 1004%(options)s 1005 1006Global build variables: 1007%(global_vars)s 1008 1009%(local_vars)s 1010''' % help_texts) 1011