SConstruct revision 9551:f867e530f39b
12815Ssaidi@eecs.umich.edu# -*- mode:python -*- 2131Sstever@eecs.umich.edu 32815Ssaidi@eecs.umich.edu# Copyright (c) 2011 Advanced Micro Devices, Inc. 42815Ssaidi@eecs.umich.edu# Copyright (c) 2009 The Hewlett-Packard Development Company 52815Ssaidi@eecs.umich.edu# Copyright (c) 2004-2005 The Regents of The University of Michigan 62815Ssaidi@eecs.umich.edu# All rights reserved. 72815Ssaidi@eecs.umich.edu# 82815Ssaidi@eecs.umich.edu# Redistribution and use in source and binary forms, with or without 92815Ssaidi@eecs.umich.edu# modification, are permitted provided that the following conditions are 102815Ssaidi@eecs.umich.edu# met: redistributions of source code must retain the above copyright 11131Sstever@eecs.umich.edu# notice, this list of conditions and the following disclaimer; 12131Sstever@eecs.umich.edu# redistributions in binary form must reproduce the above copyright 13131Sstever@eecs.umich.edu# notice, this list of conditions and the following disclaimer in the 14131Sstever@eecs.umich.edu# documentation and/or other materials provided with the distribution; 151905Sstever@eecs.umich.edu# neither the name of the copyright holders nor the names of its 162815Ssaidi@eecs.umich.edu# contributors may be used to endorse or promote products derived from 172815Ssaidi@eecs.umich.edu# this software without specific prior written permission. 182815Ssaidi@eecs.umich.edu# 192815Ssaidi@eecs.umich.edu# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 202815Ssaidi@eecs.umich.edu# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21131Sstever@eecs.umich.edu# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 221905Sstever@eecs.umich.edu# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 231905Sstever@eecs.umich.edu# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 242815Ssaidi@eecs.umich.edu# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 251905Sstever@eecs.umich.edu# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 261905Sstever@eecs.umich.edu# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 271905Sstever@eecs.umich.edu# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 281905Sstever@eecs.umich.edu# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 291905Sstever@eecs.umich.edu# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 301905Sstever@eecs.umich.edu# 311905Sstever@eecs.umich.edu# Authors: Steve Reinhardt 321905Sstever@eecs.umich.edu# Nathan Binkert 331905Sstever@eecs.umich.edu 341905Sstever@eecs.umich.edu################################################### 351905Sstever@eecs.umich.edu# 361905Sstever@eecs.umich.edu# SCons top-level build description (SConstruct) file. 371905Sstever@eecs.umich.edu# 381905Sstever@eecs.umich.edu# While in this directory ('gem5'), just type 'scons' to build the default 391905Sstever@eecs.umich.edu# configuration (see below), or type 'scons build/<CONFIG>/<binary>' 402815Ssaidi@eecs.umich.edu# to build some other configuration (e.g., 'build/ALPHA/gem5.opt' for 412815Ssaidi@eecs.umich.edu# the optimized full-system version). 422815Ssaidi@eecs.umich.edu# 431028Ssaidi@eecs.umich.edu# You can build gem5 in a different directory as long as there is a 441028Ssaidi@eecs.umich.edu# 'build/<CONFIG>' somewhere along the target path. The build system 45# expects that all configs under the same build directory are being 46# built for the same host system. 47# 48# Examples: 49# 50# The following two commands are equivalent. The '-u' option tells 51# scons to search up the directory tree for this SConstruct file. 52# % cd <path-to-src>/gem5 ; scons build/ALPHA/gem5.debug 53# % cd <path-to-src>/gem5/build/ALPHA; scons -u gem5.debug 54# 55# The following two commands are equivalent and demonstrate building 56# in a directory outside of the source tree. The '-C' option tells 57# scons to chdir to the specified directory to find this SConstruct 58# file. 59# % cd <path-to-src>/gem5 ; scons /local/foo/build/ALPHA/gem5.debug 60# % cd /local/foo/build/ALPHA; scons -C <path-to-src>/gem5 gem5.debug 61# 62# You can use 'scons -H' to print scons options. If you're in this 63# 'gem5' directory (or use -u or -C to tell scons where to find this 64# file), you can use 'scons -h' to print all the gem5-specific build 65# options as well. 66# 67################################################### 68 69# Check for recent-enough Python and SCons versions. 70try: 71 # Really old versions of scons only take two options for the 72 # function, so check once without the revision and once with the 73 # revision, the first instance will fail for stuff other than 74 # 0.98, and the second will fail for 0.98.0 75 EnsureSConsVersion(0, 98) 76 EnsureSConsVersion(0, 98, 1) 77except SystemExit, e: 78 print """ 79For more details, see: 80 http://gem5.org/Dependencies 81""" 82 raise 83 84# We ensure the python version early because we have stuff that 85# requires python 2.4 86try: 87 EnsurePythonVersion(2, 4) 88except SystemExit, e: 89 print """ 90You can use a non-default installation of the Python interpreter by 91either (1) rearranging your PATH so that scons finds the non-default 92'python' first or (2) explicitly invoking an alternative interpreter 93on the scons script. 94 95For more details, see: 96 http://gem5.org/wiki/index.php/Using_a_non-default_Python_installation 97""" 98 raise 99 100# Global Python includes 101import os 102import re 103import subprocess 104import sys 105 106from os import mkdir, environ 107from os.path import abspath, basename, dirname, expanduser, normpath 108from os.path import exists, isdir, isfile 109from os.path import join as joinpath, split as splitpath 110 111# SCons includes 112import SCons 113import SCons.Node 114 115extra_python_paths = [ 116 Dir('src/python').srcnode().abspath, # gem5 includes 117 Dir('ext/ply').srcnode().abspath, # ply is used by several files 118 ] 119 120sys.path[1:1] = extra_python_paths 121 122from m5.util import compareVersions, readCommand 123from m5.util.terminal import get_termcap 124 125help_texts = { 126 "options" : "", 127 "global_vars" : "", 128 "local_vars" : "" 129} 130 131Export("help_texts") 132 133 134# There's a bug in scons in that (1) by default, the help texts from 135# AddOption() are supposed to be displayed when you type 'scons -h' 136# and (2) you can override the help displayed by 'scons -h' using the 137# Help() function, but these two features are incompatible: once 138# you've overridden the help text using Help(), there's no way to get 139# at the help texts from AddOptions. See: 140# http://scons.tigris.org/issues/show_bug.cgi?id=2356 141# http://scons.tigris.org/issues/show_bug.cgi?id=2611 142# This hack lets us extract the help text from AddOptions and 143# re-inject it via Help(). Ideally someday this bug will be fixed and 144# we can just use AddOption directly. 145def AddLocalOption(*args, **kwargs): 146 col_width = 30 147 148 help = " " + ", ".join(args) 149 if "help" in kwargs: 150 length = len(help) 151 if length >= col_width: 152 help += "\n" + " " * col_width 153 else: 154 help += " " * (col_width - length) 155 help += kwargs["help"] 156 help_texts["options"] += help + "\n" 157 158 AddOption(*args, **kwargs) 159 160AddLocalOption('--colors', dest='use_colors', action='store_true', 161 help="Add color to abbreviated scons output") 162AddLocalOption('--no-colors', dest='use_colors', action='store_false', 163 help="Don't add color to abbreviated scons output") 164AddLocalOption('--default', dest='default', type='string', action='store', 165 help='Override which build_opts file to use for defaults') 166AddLocalOption('--ignore-style', dest='ignore_style', action='store_true', 167 help='Disable style checking hooks') 168AddLocalOption('--no-lto', dest='no_lto', action='store_true', 169 help='Disable Link-Time Optimization for fast') 170AddLocalOption('--update-ref', dest='update_ref', action='store_true', 171 help='Update test reference outputs') 172AddLocalOption('--verbose', dest='verbose', action='store_true', 173 help='Print full tool command lines') 174 175termcap = get_termcap(GetOption('use_colors')) 176 177######################################################################## 178# 179# Set up the main build environment. 180# 181######################################################################## 182use_vars = set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH', 183 'LIBRARY_PATH', 'PATH', 'PKG_CONFIG_PATH', 'PYTHONPATH', 184 'RANLIB', 'SWIG' ]) 185 186use_prefixes = [ 187 "M5", # M5 configuration (e.g., path to kernels) 188 "DISTCC_", # distcc (distributed compiler wrapper) configuration 189 "CCACHE_", # ccache (caching compiler wrapper) configuration 190 "CCC_", # clang static analyzer configuration 191 ] 192 193use_env = {} 194for key,val in os.environ.iteritems(): 195 if key in use_vars or \ 196 any([key.startswith(prefix) for prefix in use_prefixes]): 197 use_env[key] = val 198 199main = Environment(ENV=use_env) 200main.Decider('MD5-timestamp') 201main.root = Dir(".") # The current directory (where this file lives). 202main.srcdir = Dir("src") # The source directory 203 204main_dict_keys = main.Dictionary().keys() 205 206# Check that we have a C/C++ compiler 207if not ('CC' in main_dict_keys and 'CXX' in main_dict_keys): 208 print "No C++ compiler installed (package g++ on Ubuntu and RedHat)" 209 Exit(1) 210 211# Check that swig is present 212if not 'SWIG' in main_dict_keys: 213 print "swig is not installed (package swig on Ubuntu and RedHat)" 214 Exit(1) 215 216# add useful python code PYTHONPATH so it can be used by subprocesses 217# as well 218main.AppendENVPath('PYTHONPATH', extra_python_paths) 219 220######################################################################## 221# 222# Mercurial Stuff. 223# 224# If the gem5 directory is a mercurial repository, we should do some 225# extra things. 226# 227######################################################################## 228 229hgdir = main.root.Dir(".hg") 230 231mercurial_style_message = """ 232You're missing the gem5 style hook, which automatically checks your code 233against the gem5 style rules on hg commit and qrefresh commands. This 234script will now install the hook in your .hg/hgrc file. 235Press enter to continue, or ctrl-c to abort: """ 236 237mercurial_style_hook = """ 238# The following lines were automatically added by gem5/SConstruct 239# to provide the gem5 style-checking hooks 240[extensions] 241style = %s/util/style.py 242 243[hooks] 244pretxncommit.style = python:style.check_style 245pre-qrefresh.style = python:style.check_style 246# End of SConstruct additions 247 248""" % (main.root.abspath) 249 250mercurial_lib_not_found = """ 251Mercurial libraries cannot be found, ignoring style hook. If 252you are a gem5 developer, please fix this and run the style 253hook. It is important. 254""" 255 256# Check for style hook and prompt for installation if it's not there. 257# Skip this if --ignore-style was specified, there's no .hg dir to 258# install a hook in, or there's no interactive terminal to prompt. 259if not GetOption('ignore_style') and hgdir.exists() and sys.stdin.isatty(): 260 style_hook = True 261 try: 262 from mercurial import ui 263 ui = ui.ui() 264 ui.readconfig(hgdir.File('hgrc').abspath) 265 style_hook = ui.config('hooks', 'pretxncommit.style', None) and \ 266 ui.config('hooks', 'pre-qrefresh.style', None) 267 except ImportError: 268 print mercurial_lib_not_found 269 270 if not style_hook: 271 print mercurial_style_message, 272 # continue unless user does ctrl-c/ctrl-d etc. 273 try: 274 raw_input() 275 except: 276 print "Input exception, exiting scons.\n" 277 sys.exit(1) 278 hgrc_path = '%s/.hg/hgrc' % main.root.abspath 279 print "Adding style hook to", hgrc_path, "\n" 280 try: 281 hgrc = open(hgrc_path, 'a') 282 hgrc.write(mercurial_style_hook) 283 hgrc.close() 284 except: 285 print "Error updating", hgrc_path 286 sys.exit(1) 287 288 289################################################### 290# 291# Figure out which configurations to set up based on the path(s) of 292# the target(s). 293# 294################################################### 295 296# Find default configuration & binary. 297Default(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug')) 298 299# helper function: find last occurrence of element in list 300def rfind(l, elt, offs = -1): 301 for i in range(len(l)+offs, 0, -1): 302 if l[i] == elt: 303 return i 304 raise ValueError, "element not found" 305 306# Take a list of paths (or SCons Nodes) and return a list with all 307# paths made absolute and ~-expanded. Paths will be interpreted 308# relative to the launch directory unless a different root is provided 309def makePathListAbsolute(path_list, root=GetLaunchDir()): 310 return [abspath(joinpath(root, expanduser(str(p)))) 311 for p in path_list] 312 313# Each target must have 'build' in the interior of the path; the 314# directory below this will determine the build parameters. For 315# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we 316# recognize that ALPHA_SE specifies the configuration because it 317# follow 'build' in the build path. 318 319# The funky assignment to "[:]" is needed to replace the list contents 320# in place rather than reassign the symbol to a new list, which 321# doesn't work (obviously!). 322BUILD_TARGETS[:] = makePathListAbsolute(BUILD_TARGETS) 323 324# Generate a list of the unique build roots and configs that the 325# collected targets reference. 326variant_paths = [] 327build_root = None 328for t in BUILD_TARGETS: 329 path_dirs = t.split('/') 330 try: 331 build_top = rfind(path_dirs, 'build', -2) 332 except: 333 print "Error: no non-leaf 'build' dir found on target path", t 334 Exit(1) 335 this_build_root = joinpath('/',*path_dirs[:build_top+1]) 336 if not build_root: 337 build_root = this_build_root 338 else: 339 if this_build_root != build_root: 340 print "Error: build targets not under same build root\n"\ 341 " %s\n %s" % (build_root, this_build_root) 342 Exit(1) 343 variant_path = joinpath('/',*path_dirs[:build_top+2]) 344 if variant_path not in variant_paths: 345 variant_paths.append(variant_path) 346 347# Make sure build_root exists (might not if this is the first build there) 348if not isdir(build_root): 349 mkdir(build_root) 350main['BUILDROOT'] = build_root 351 352Export('main') 353 354main.SConsignFile(joinpath(build_root, "sconsign")) 355 356# Default duplicate option is to use hard links, but this messes up 357# when you use emacs to edit a file in the target dir, as emacs moves 358# file to file~ then copies to file, breaking the link. Symbolic 359# (soft) links work better. 360main.SetOption('duplicate', 'soft-copy') 361 362# 363# Set up global sticky variables... these are common to an entire build 364# tree (not specific to a particular build like ALPHA_SE) 365# 366 367global_vars_file = joinpath(build_root, 'variables.global') 368 369global_vars = Variables(global_vars_file, args=ARGUMENTS) 370 371global_vars.AddVariables( 372 ('CC', 'C compiler', environ.get('CC', main['CC'])), 373 ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])), 374 ('SWIG', 'SWIG tool', environ.get('SWIG', main['SWIG'])), 375 ('PROTOC', 'protoc tool', environ.get('PROTOC', 'protoc')), 376 ('BATCH', 'Use batch pool for build and tests', False), 377 ('BATCH_CMD', 'Batch pool submission command name', 'qdo'), 378 ('M5_BUILD_CACHE', 'Cache built objects in this directory', False), 379 ('EXTRAS', 'Add extra directories to the compilation', '') 380 ) 381 382# Update main environment with values from ARGUMENTS & global_vars_file 383global_vars.Update(main) 384help_texts["global_vars"] += global_vars.GenerateHelpText(main) 385 386# Save sticky variable settings back to current variables file 387global_vars.Save(global_vars_file, main) 388 389# Parse EXTRAS variable to build list of all directories where we're 390# look for sources etc. This list is exported as extras_dir_list. 391base_dir = main.srcdir.abspath 392if main['EXTRAS']: 393 extras_dir_list = makePathListAbsolute(main['EXTRAS'].split(':')) 394else: 395 extras_dir_list = [] 396 397Export('base_dir') 398Export('extras_dir_list') 399 400# the ext directory should be on the #includes path 401main.Append(CPPPATH=[Dir('ext')]) 402 403def strip_build_path(path, env): 404 path = str(path) 405 variant_base = env['BUILDROOT'] + os.path.sep 406 if path.startswith(variant_base): 407 path = path[len(variant_base):] 408 elif path.startswith('build/'): 409 path = path[6:] 410 return path 411 412# Generate a string of the form: 413# common/path/prefix/src1, src2 -> tgt1, tgt2 414# to print while building. 415class Transform(object): 416 # all specific color settings should be here and nowhere else 417 tool_color = termcap.Normal 418 pfx_color = termcap.Yellow 419 srcs_color = termcap.Yellow + termcap.Bold 420 arrow_color = termcap.Blue + termcap.Bold 421 tgts_color = termcap.Yellow + termcap.Bold 422 423 def __init__(self, tool, max_sources=99): 424 self.format = self.tool_color + (" [%8s] " % tool) \ 425 + self.pfx_color + "%s" \ 426 + self.srcs_color + "%s" \ 427 + self.arrow_color + " -> " \ 428 + self.tgts_color + "%s" \ 429 + termcap.Normal 430 self.max_sources = max_sources 431 432 def __call__(self, target, source, env, for_signature=None): 433 # truncate source list according to max_sources param 434 source = source[0:self.max_sources] 435 def strip(f): 436 return strip_build_path(str(f), env) 437 if len(source) > 0: 438 srcs = map(strip, source) 439 else: 440 srcs = [''] 441 tgts = map(strip, target) 442 # surprisingly, os.path.commonprefix is a dumb char-by-char string 443 # operation that has nothing to do with paths. 444 com_pfx = os.path.commonprefix(srcs + tgts) 445 com_pfx_len = len(com_pfx) 446 if com_pfx: 447 # do some cleanup and sanity checking on common prefix 448 if com_pfx[-1] == ".": 449 # prefix matches all but file extension: ok 450 # back up one to change 'foo.cc -> o' to 'foo.cc -> .o' 451 com_pfx = com_pfx[0:-1] 452 elif com_pfx[-1] == "/": 453 # common prefix is directory path: OK 454 pass 455 else: 456 src0_len = len(srcs[0]) 457 tgt0_len = len(tgts[0]) 458 if src0_len == com_pfx_len: 459 # source is a substring of target, OK 460 pass 461 elif tgt0_len == com_pfx_len: 462 # target is a substring of source, need to back up to 463 # avoid empty string on RHS of arrow 464 sep_idx = com_pfx.rfind(".") 465 if sep_idx != -1: 466 com_pfx = com_pfx[0:sep_idx] 467 else: 468 com_pfx = '' 469 elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".": 470 # still splitting at file extension: ok 471 pass 472 else: 473 # probably a fluke; ignore it 474 com_pfx = '' 475 # recalculate length in case com_pfx was modified 476 com_pfx_len = len(com_pfx) 477 def fmt(files): 478 f = map(lambda s: s[com_pfx_len:], files) 479 return ', '.join(f) 480 return self.format % (com_pfx, fmt(srcs), fmt(tgts)) 481 482Export('Transform') 483 484# enable the regression script to use the termcap 485main['TERMCAP'] = termcap 486 487if GetOption('verbose'): 488 def MakeAction(action, string, *args, **kwargs): 489 return Action(action, *args, **kwargs) 490else: 491 MakeAction = Action 492 main['CCCOMSTR'] = Transform("CC") 493 main['CXXCOMSTR'] = Transform("CXX") 494 main['ASCOMSTR'] = Transform("AS") 495 main['SWIGCOMSTR'] = Transform("SWIG") 496 main['ARCOMSTR'] = Transform("AR", 0) 497 main['LINKCOMSTR'] = Transform("LINK", 0) 498 main['RANLIBCOMSTR'] = Transform("RANLIB", 0) 499 main['M4COMSTR'] = Transform("M4") 500 main['SHCCCOMSTR'] = Transform("SHCC") 501 main['SHCXXCOMSTR'] = Transform("SHCXX") 502Export('MakeAction') 503 504# Initialize the Link-Time Optimization (LTO) flags 505main['LTO_CCFLAGS'] = [] 506main['LTO_LDFLAGS'] = [] 507 508CXX_version = readCommand([main['CXX'],'--version'], exception=False) 509CXX_V = readCommand([main['CXX'],'-V'], exception=False) 510 511main['GCC'] = CXX_version and CXX_version.find('g++') >= 0 512main['CLANG'] = CXX_version and CXX_version.find('clang') >= 0 513if main['GCC'] + main['CLANG'] > 1: 514 print 'Error: How can we have two at the same time?' 515 Exit(1) 516 517# Set up default C++ compiler flags 518if main['GCC']: 519 # Check for a supported version of gcc, >= 4.4 is needed for c++0x 520 # support. See http://gcc.gnu.org/projects/cxx0x.html for details 521 gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False) 522 if compareVersions(gcc_version, "4.4") < 0: 523 print 'Error: gcc version 4.4 or newer required.' 524 print ' Installed version:', gcc_version 525 Exit(1) 526 527 main['GCC_VERSION'] = gcc_version 528 main.Append(CCFLAGS=['-pipe']) 529 main.Append(CCFLAGS=['-fno-strict-aliasing']) 530 main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef']) 531 main.Append(CXXFLAGS=['-Wmissing-field-initializers']) 532 main.Append(CXXFLAGS=['-std=c++0x']) 533 534 # Check for versions with bugs 535 if not compareVersions(gcc_version, '4.4.1') or \ 536 not compareVersions(gcc_version, '4.4.2'): 537 print 'Info: Tree vectorizer in GCC 4.4.1 & 4.4.2 is buggy, disabling.' 538 main.Append(CCFLAGS=['-fno-tree-vectorize']) 539 540 # LTO support is only really working properly from 4.6 and beyond 541 if compareVersions(gcc_version, '4.6') >= 0: 542 # Add the appropriate Link-Time Optimization (LTO) flags 543 # unless LTO is explicitly turned off. Note that these flags 544 # are only used by the fast target. 545 if not GetOption('no_lto'): 546 # Pass the LTO flag when compiling to produce GIMPLE 547 # output, we merely create the flags here and only append 548 # them later/ 549 main['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')] 550 551 # Use the same amount of jobs for LTO as we are running 552 # scons with, we hardcode the use of the linker plugin 553 # which requires either gold or GNU ld >= 2.21 554 main['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs'), 555 '-fuse-linker-plugin'] 556 557elif main['CLANG']: 558 # Check for a supported version of clang, >= 2.9 is needed to 559 # support similar features as gcc 4.4. See 560 # http://clang.llvm.org/cxx_status.html for details 561 clang_version_re = re.compile(".* version (\d+\.\d+)") 562 clang_version_match = clang_version_re.match(CXX_version) 563 if (clang_version_match): 564 clang_version = clang_version_match.groups()[0] 565 if compareVersions(clang_version, "2.9") < 0: 566 print 'Error: clang version 2.9 or newer required.' 567 print ' Installed version:', clang_version 568 Exit(1) 569 else: 570 print 'Error: Unable to determine clang version.' 571 Exit(1) 572 573 main.Append(CCFLAGS=['-pipe']) 574 main.Append(CCFLAGS=['-fno-strict-aliasing']) 575 main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef']) 576 main.Append(CCFLAGS=['-Wno-tautological-compare']) 577 main.Append(CCFLAGS=['-Wno-self-assign']) 578 # Ruby makes frequent use of extraneous parantheses in the printing 579 # of if-statements 580 main.Append(CCFLAGS=['-Wno-parentheses']) 581 main.Append(CXXFLAGS=['-Wmissing-field-initializers']) 582 main.Append(CXXFLAGS=['-std=c++0x']) 583 # On Mac OS X/Darwin we need to also use libc++ (part of XCode) as 584 # opposed to libstdc++ to make the transition from TR1 to 585 # C++11. See http://libcxx.llvm.org. However, clang has chosen a 586 # strict implementation of the C++11 standard, and does not allow 587 # incomplete types in template arguments (besides unique_ptr and 588 # shared_ptr), and the libc++ STL containers create problems in 589 # combination with the current gem5 code. For now, we stick with 590 # libstdc++ and use the TR1 namespace. 591 # if sys.platform == "darwin": 592 # main.Append(CXXFLAGS=['-stdlib=libc++']) 593 594else: 595 print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal, 596 print "Don't know what compiler options to use for your compiler." 597 print termcap.Yellow + ' compiler:' + termcap.Normal, main['CXX'] 598 print termcap.Yellow + ' version:' + termcap.Normal, 599 if not CXX_version: 600 print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\ 601 termcap.Normal 602 else: 603 print CXX_version.replace('\n', '<nl>') 604 print " If you're trying to use a compiler other than GCC" 605 print " or clang, there appears to be something wrong with your" 606 print " environment." 607 print " " 608 print " If you are trying to use a compiler other than those listed" 609 print " above you will need to ease fix SConstruct and " 610 print " src/SConscript to support that compiler." 611 Exit(1) 612 613# Set up common yacc/bison flags (needed for Ruby) 614main['YACCFLAGS'] = '-d' 615main['YACCHXXFILESUFFIX'] = '.hh' 616 617# Do this after we save setting back, or else we'll tack on an 618# extra 'qdo' every time we run scons. 619if main['BATCH']: 620 main['CC'] = main['BATCH_CMD'] + ' ' + main['CC'] 621 main['CXX'] = main['BATCH_CMD'] + ' ' + main['CXX'] 622 main['AS'] = main['BATCH_CMD'] + ' ' + main['AS'] 623 main['AR'] = main['BATCH_CMD'] + ' ' + main['AR'] 624 main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB'] 625 626if sys.platform == 'cygwin': 627 # cygwin has some header file issues... 628 main.Append(CCFLAGS=["-Wno-uninitialized"]) 629 630# Check for the protobuf compiler 631protoc_version = readCommand([main['PROTOC'], '--version'], 632 exception='').split() 633 634# First two words should be "libprotoc x.y.z" 635if len(protoc_version) < 2 or protoc_version[0] != 'libprotoc': 636 print termcap.Yellow + termcap.Bold + \ 637 'Warning: Protocol buffer compiler (protoc) not found.\n' + \ 638 ' Please install protobuf-compiler for tracing support.' + \ 639 termcap.Normal 640 main['PROTOC'] = False 641else: 642 # Based on the availability of the compress stream wrappers, 643 # require 2.1.0 644 min_protoc_version = '2.1.0' 645 if compareVersions(protoc_version[1], min_protoc_version) < 0: 646 print termcap.Yellow + termcap.Bold + \ 647 'Warning: protoc version', min_protoc_version, \ 648 'or newer required.\n' + \ 649 ' Installed version:', protoc_version[1], \ 650 termcap.Normal 651 main['PROTOC'] = False 652 else: 653 # Attempt to determine the appropriate include path and 654 # library path using pkg-config, that means we also need to 655 # check for pkg-config. Note that it is possible to use 656 # protobuf without the involvement of pkg-config. Later on we 657 # check go a library config check and at that point the test 658 # will fail if libprotobuf cannot be found. 659 if readCommand(['pkg-config', '--version'], exception=''): 660 try: 661 # Attempt to establish what linking flags to add for protobuf 662 # using pkg-config 663 main.ParseConfig('pkg-config --cflags --libs-only-L protobuf') 664 except: 665 print termcap.Yellow + termcap.Bold + \ 666 'Warning: pkg-config could not get protobuf flags.' + \ 667 termcap.Normal 668 669# Check for SWIG 670if not main.has_key('SWIG'): 671 print 'Error: SWIG utility not found.' 672 print ' Please install (see http://www.swig.org) and retry.' 673 Exit(1) 674 675# Check for appropriate SWIG version 676swig_version = readCommand([main['SWIG'], '-version'], exception='').split() 677# First 3 words should be "SWIG Version x.y.z" 678if len(swig_version) < 3 or \ 679 swig_version[0] != 'SWIG' or swig_version[1] != 'Version': 680 print 'Error determining SWIG version.' 681 Exit(1) 682 683min_swig_version = '1.3.34' 684if compareVersions(swig_version[2], min_swig_version) < 0: 685 print 'Error: SWIG version', min_swig_version, 'or newer required.' 686 print ' Installed version:', swig_version[2] 687 Exit(1) 688 689# Set up SWIG flags & scanner 690swig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS') 691main.Append(SWIGFLAGS=swig_flags) 692 693# filter out all existing swig scanners, they mess up the dependency 694# stuff for some reason 695scanners = [] 696for scanner in main['SCANNERS']: 697 skeys = scanner.skeys 698 if skeys == '.i': 699 continue 700 701 if isinstance(skeys, (list, tuple)) and '.i' in skeys: 702 continue 703 704 scanners.append(scanner) 705 706# add the new swig scanner that we like better 707from SCons.Scanner import ClassicCPP as CPPScanner 708swig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")' 709scanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re)) 710 711# replace the scanners list that has what we want 712main['SCANNERS'] = scanners 713 714# Add a custom Check function to the Configure context so that we can 715# figure out if the compiler adds leading underscores to global 716# variables. This is needed for the autogenerated asm files that we 717# use for embedding the python code. 718def CheckLeading(context): 719 context.Message("Checking for leading underscore in global variables...") 720 # 1) Define a global variable called x from asm so the C compiler 721 # won't change the symbol at all. 722 # 2) Declare that variable. 723 # 3) Use the variable 724 # 725 # If the compiler prepends an underscore, this will successfully 726 # link because the external symbol 'x' will be called '_x' which 727 # was defined by the asm statement. If the compiler does not 728 # prepend an underscore, this will not successfully link because 729 # '_x' will have been defined by assembly, while the C portion of 730 # the code will be trying to use 'x' 731 ret = context.TryLink(''' 732 asm(".globl _x; _x: .byte 0"); 733 extern int x; 734 int main() { return x; } 735 ''', extension=".c") 736 context.env.Append(LEADING_UNDERSCORE=ret) 737 context.Result(ret) 738 return ret 739 740# Platform-specific configuration. Note again that we assume that all 741# builds under a given build root run on the same host platform. 742conf = Configure(main, 743 conf_dir = joinpath(build_root, '.scons_config'), 744 log_file = joinpath(build_root, 'scons_config.log'), 745 custom_tests = { 'CheckLeading' : CheckLeading }) 746 747# Check for leading underscores. Don't really need to worry either 748# way so don't need to check the return code. 749conf.CheckLeading() 750 751# Check if we should compile a 64 bit binary on Mac OS X/Darwin 752try: 753 import platform 754 uname = platform.uname() 755 if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0: 756 if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]): 757 main.Append(CCFLAGS=['-arch', 'x86_64']) 758 main.Append(CFLAGS=['-arch', 'x86_64']) 759 main.Append(LINKFLAGS=['-arch', 'x86_64']) 760 main.Append(ASFLAGS=['-arch', 'x86_64']) 761except: 762 pass 763 764# Recent versions of scons substitute a "Null" object for Configure() 765# when configuration isn't necessary, e.g., if the "--help" option is 766# present. Unfortuantely this Null object always returns false, 767# breaking all our configuration checks. We replace it with our own 768# more optimistic null object that returns True instead. 769if not conf: 770 def NullCheck(*args, **kwargs): 771 return True 772 773 class NullConf: 774 def __init__(self, env): 775 self.env = env 776 def Finish(self): 777 return self.env 778 def __getattr__(self, mname): 779 return NullCheck 780 781 conf = NullConf(main) 782 783# Find Python include and library directories for embedding the 784# interpreter. For consistency, we will use the same Python 785# installation used to run scons (and thus this script). If you want 786# to link in an alternate version, see above for instructions on how 787# to invoke scons with a different copy of the Python interpreter. 788from distutils import sysconfig 789 790py_getvar = sysconfig.get_config_var 791 792py_debug = getattr(sys, 'pydebug', False) 793py_version = 'python' + py_getvar('VERSION') + (py_debug and "_d" or "") 794 795py_general_include = sysconfig.get_python_inc() 796py_platform_include = sysconfig.get_python_inc(plat_specific=True) 797py_includes = [ py_general_include ] 798if py_platform_include != py_general_include: 799 py_includes.append(py_platform_include) 800 801py_lib_path = [ py_getvar('LIBDIR') ] 802# add the prefix/lib/pythonX.Y/config dir, but only if there is no 803# shared library in prefix/lib/. 804if not py_getvar('Py_ENABLE_SHARED'): 805 py_lib_path.append(py_getvar('LIBPL')) 806 807py_libs = [] 808for lib in py_getvar('LIBS').split() + py_getvar('SYSLIBS').split(): 809 if not lib.startswith('-l'): 810 # Python requires some special flags to link (e.g. -framework 811 # common on OS X systems), assume appending preserves order 812 main.Append(LINKFLAGS=[lib]) 813 else: 814 lib = lib[2:] 815 if lib not in py_libs: 816 py_libs.append(lib) 817py_libs.append(py_version) 818 819main.Append(CPPPATH=py_includes) 820main.Append(LIBPATH=py_lib_path) 821 822# Cache build files in the supplied directory. 823if main['M5_BUILD_CACHE']: 824 print 'Using build cache located at', main['M5_BUILD_CACHE'] 825 CacheDir(main['M5_BUILD_CACHE']) 826 827 828# verify that this stuff works 829if not conf.CheckHeader('Python.h', '<>'): 830 print "Error: can't find Python.h header in", py_includes 831 print "Install Python headers (package python-dev on Ubuntu and RedHat)" 832 Exit(1) 833 834for lib in py_libs: 835 if not conf.CheckLib(lib): 836 print "Error: can't find library %s required by python" % lib 837 Exit(1) 838 839# On Solaris you need to use libsocket for socket ops 840if not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'): 841 if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'): 842 print "Can't find library with socket calls (e.g. accept())" 843 Exit(1) 844 845# Check for zlib. If the check passes, libz will be automatically 846# added to the LIBS environment variable. 847if not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'): 848 print 'Error: did not find needed zlib compression library '\ 849 'and/or zlib.h header file.' 850 print ' Please install zlib and try again.' 851 Exit(1) 852 853# If we have the protobuf compiler, also make sure we have the 854# development libraries. If the check passes, libprotobuf will be 855# automatically added to the LIBS environment variable. After 856# this, we can use the HAVE_PROTOBUF flag to determine if we have 857# got both protoc and libprotobuf available. 858main['HAVE_PROTOBUF'] = main['PROTOC'] and \ 859 conf.CheckLibWithHeader('protobuf', 'google/protobuf/message.h', 860 'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;') 861 862# If we have the compiler but not the library, print another warning. 863if main['PROTOC'] and not main['HAVE_PROTOBUF']: 864 print termcap.Yellow + termcap.Bold + \ 865 'Warning: did not find protocol buffer library and/or headers.\n' + \ 866 ' Please install libprotobuf-dev for tracing support.' + \ 867 termcap.Normal 868 869# Check for librt. 870have_posix_clock = \ 871 conf.CheckLibWithHeader(None, 'time.h', 'C', 872 'clock_nanosleep(0,0,NULL,NULL);') or \ 873 conf.CheckLibWithHeader('rt', 'time.h', 'C', 874 'clock_nanosleep(0,0,NULL,NULL);') 875 876if conf.CheckLib('tcmalloc_minimal'): 877 have_tcmalloc = True 878else: 879 have_tcmalloc = False 880 print termcap.Yellow + termcap.Bold + \ 881 "You can get a 12% performance improvement by installing tcmalloc "\ 882 "(libgoogle-perftools-dev package on Ubuntu or RedHat)." + \ 883 termcap.Normal 884 885if not have_posix_clock: 886 print "Can't find library for POSIX clocks." 887 888# Check for <fenv.h> (C99 FP environment control) 889have_fenv = conf.CheckHeader('fenv.h', '<>') 890if not have_fenv: 891 print "Warning: Header file <fenv.h> not found." 892 print " This host has no IEEE FP rounding mode control." 893 894###################################################################### 895# 896# Finish the configuration 897# 898main = conf.Finish() 899 900###################################################################### 901# 902# Collect all non-global variables 903# 904 905# Define the universe of supported ISAs 906all_isa_list = [ ] 907Export('all_isa_list') 908 909class CpuModel(object): 910 '''The CpuModel class encapsulates everything the ISA parser needs to 911 know about a particular CPU model.''' 912 913 # Dict of available CPU model objects. Accessible as CpuModel.dict. 914 dict = {} 915 list = [] 916 defaults = [] 917 918 # Constructor. Automatically adds models to CpuModel.dict. 919 def __init__(self, name, filename, includes, strings, default=False): 920 self.name = name # name of model 921 self.filename = filename # filename for output exec code 922 self.includes = includes # include files needed in exec file 923 # The 'strings' dict holds all the per-CPU symbols we can 924 # substitute into templates etc. 925 self.strings = strings 926 927 # This cpu is enabled by default 928 self.default = default 929 930 # Add self to dict 931 if name in CpuModel.dict: 932 raise AttributeError, "CpuModel '%s' already registered" % name 933 CpuModel.dict[name] = self 934 CpuModel.list.append(name) 935 936Export('CpuModel') 937 938# Sticky variables get saved in the variables file so they persist from 939# one invocation to the next (unless overridden, in which case the new 940# value becomes sticky). 941sticky_vars = Variables(args=ARGUMENTS) 942Export('sticky_vars') 943 944# Sticky variables that should be exported 945export_vars = [] 946Export('export_vars') 947 948# For Ruby 949all_protocols = [] 950Export('all_protocols') 951protocol_dirs = [] 952Export('protocol_dirs') 953slicc_includes = [] 954Export('slicc_includes') 955 956# Walk the tree and execute all SConsopts scripts that wil add to the 957# above variables 958if not GetOption('verbose'): 959 print "Reading SConsopts" 960for bdir in [ base_dir ] + extras_dir_list: 961 if not isdir(bdir): 962 print "Error: directory '%s' does not exist" % bdir 963 Exit(1) 964 for root, dirs, files in os.walk(bdir): 965 if 'SConsopts' in files: 966 if GetOption('verbose'): 967 print "Reading", joinpath(root, 'SConsopts') 968 SConscript(joinpath(root, 'SConsopts')) 969 970all_isa_list.sort() 971 972sticky_vars.AddVariables( 973 EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list), 974 ListVariable('CPU_MODELS', 'CPU models', 975 sorted(n for n,m in CpuModel.dict.iteritems() if m.default), 976 sorted(CpuModel.list)), 977 BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger', 978 False), 979 BoolVariable('SS_COMPATIBLE_FP', 980 'Make floating-point results compatible with SimpleScalar', 981 False), 982 BoolVariable('USE_SSE2', 983 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts', 984 False), 985 BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock), 986 BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv), 987 BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False), 988 EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None', 989 all_protocols), 990 ) 991 992# These variables get exported to #defines in config/*.hh (see src/SConscript). 993export_vars += ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'CP_ANNOTATE', 994 'USE_POSIX_CLOCK', 'PROTOCOL', 'HAVE_PROTOBUF'] 995 996################################################### 997# 998# Define a SCons builder for configuration flag headers. 999# 1000################################################### 1001 1002# This function generates a config header file that #defines the 1003# variable symbol to the current variable setting (0 or 1). The source 1004# operands are the name of the variable and a Value node containing the 1005# value of the variable. 1006def build_config_file(target, source, env): 1007 (variable, value) = [s.get_contents() for s in source] 1008 f = file(str(target[0]), 'w') 1009 print >> f, '#define', variable, value 1010 f.close() 1011 return None 1012 1013# Combine the two functions into a scons Action object. 1014config_action = MakeAction(build_config_file, Transform("CONFIG H", 2)) 1015 1016# The emitter munges the source & target node lists to reflect what 1017# we're really doing. 1018def config_emitter(target, source, env): 1019 # extract variable name from Builder arg 1020 variable = str(target[0]) 1021 # True target is config header file 1022 target = joinpath('config', variable.lower() + '.hh') 1023 val = env[variable] 1024 if isinstance(val, bool): 1025 # Force value to 0/1 1026 val = int(val) 1027 elif isinstance(val, str): 1028 val = '"' + val + '"' 1029 1030 # Sources are variable name & value (packaged in SCons Value nodes) 1031 return ([target], [Value(variable), Value(val)]) 1032 1033config_builder = Builder(emitter = config_emitter, action = config_action) 1034 1035main.Append(BUILDERS = { 'ConfigFile' : config_builder }) 1036 1037# libelf build is shared across all configs in the build root. 1038main.SConscript('ext/libelf/SConscript', 1039 variant_dir = joinpath(build_root, 'libelf')) 1040 1041# gzstream build is shared across all configs in the build root. 1042main.SConscript('ext/gzstream/SConscript', 1043 variant_dir = joinpath(build_root, 'gzstream')) 1044 1045# libfdt build is shared across all configs in the build root. 1046main.SConscript('ext/libfdt/SConscript', 1047 variant_dir = joinpath(build_root, 'libfdt')) 1048 1049################################################### 1050# 1051# This function is used to set up a directory with switching headers 1052# 1053################################################### 1054 1055main['ALL_ISA_LIST'] = all_isa_list 1056def make_switching_dir(dname, switch_headers, env): 1057 # Generate the header. target[0] is the full path of the output 1058 # header to generate. 'source' is a dummy variable, since we get the 1059 # list of ISAs from env['ALL_ISA_LIST']. 1060 def gen_switch_hdr(target, source, env): 1061 fname = str(target[0]) 1062 f = open(fname, 'w') 1063 isa = env['TARGET_ISA'].lower() 1064 print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname)) 1065 f.close() 1066 1067 # Build SCons Action object. 'varlist' specifies env vars that this 1068 # action depends on; when env['ALL_ISA_LIST'] changes these actions 1069 # should get re-executed. 1070 switch_hdr_action = MakeAction(gen_switch_hdr, 1071 Transform("GENERATE"), varlist=['ALL_ISA_LIST']) 1072 1073 # Instantiate actions for each header 1074 for hdr in switch_headers: 1075 env.Command(hdr, [], switch_hdr_action) 1076Export('make_switching_dir') 1077 1078################################################### 1079# 1080# Define build environments for selected configurations. 1081# 1082################################################### 1083 1084for variant_path in variant_paths: 1085 print "Building in", variant_path 1086 1087 # Make a copy of the build-root environment to use for this config. 1088 env = main.Clone() 1089 env['BUILDDIR'] = variant_path 1090 1091 # variant_dir is the tail component of build path, and is used to 1092 # determine the build parameters (e.g., 'ALPHA_SE') 1093 (build_root, variant_dir) = splitpath(variant_path) 1094 1095 # Set env variables according to the build directory config. 1096 sticky_vars.files = [] 1097 # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in 1098 # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke 1099 # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings. 1100 current_vars_file = joinpath(build_root, 'variables', variant_dir) 1101 if isfile(current_vars_file): 1102 sticky_vars.files.append(current_vars_file) 1103 print "Using saved variables file %s" % current_vars_file 1104 else: 1105 # Build dir-specific variables file doesn't exist. 1106 1107 # Make sure the directory is there so we can create it later 1108 opt_dir = dirname(current_vars_file) 1109 if not isdir(opt_dir): 1110 mkdir(opt_dir) 1111 1112 # Get default build variables from source tree. Variables are 1113 # normally determined by name of $VARIANT_DIR, but can be 1114 # overridden by '--default=' arg on command line. 1115 default = GetOption('default') 1116 opts_dir = joinpath(main.root.abspath, 'build_opts') 1117 if default: 1118 default_vars_files = [joinpath(build_root, 'variables', default), 1119 joinpath(opts_dir, default)] 1120 else: 1121 default_vars_files = [joinpath(opts_dir, variant_dir)] 1122 existing_files = filter(isfile, default_vars_files) 1123 if existing_files: 1124 default_vars_file = existing_files[0] 1125 sticky_vars.files.append(default_vars_file) 1126 print "Variables file %s not found,\n using defaults in %s" \ 1127 % (current_vars_file, default_vars_file) 1128 else: 1129 print "Error: cannot find variables file %s or " \ 1130 "default file(s) %s" \ 1131 % (current_vars_file, ' or '.join(default_vars_files)) 1132 Exit(1) 1133 1134 # Apply current variable settings to env 1135 sticky_vars.Update(env) 1136 1137 help_texts["local_vars"] += \ 1138 "Build variables for %s:\n" % variant_dir \ 1139 + sticky_vars.GenerateHelpText(env) 1140 1141 # Process variable settings. 1142 1143 if not have_fenv and env['USE_FENV']: 1144 print "Warning: <fenv.h> not available; " \ 1145 "forcing USE_FENV to False in", variant_dir + "." 1146 env['USE_FENV'] = False 1147 1148 if not env['USE_FENV']: 1149 print "Warning: No IEEE FP rounding mode control in", variant_dir + "." 1150 print " FP results may deviate slightly from other platforms." 1151 1152 if env['EFENCE']: 1153 env.Append(LIBS=['efence']) 1154 1155 # Save sticky variable settings back to current variables file 1156 sticky_vars.Save(current_vars_file, env) 1157 1158 if env['USE_SSE2']: 1159 env.Append(CCFLAGS=['-msse2']) 1160 1161 if have_tcmalloc: 1162 env.Append(LIBS=['tcmalloc_minimal']) 1163 1164 # The src/SConscript file sets up the build rules in 'env' according 1165 # to the configured variables. It returns a list of environments, 1166 # one for each variant build (debug, opt, etc.) 1167 envList = SConscript('src/SConscript', variant_dir = variant_path, 1168 exports = 'env') 1169 1170 # Set up the regression tests for each build. 1171 for e in envList: 1172 SConscript('tests/SConscript', 1173 variant_dir = joinpath(variant_path, 'tests', e.Label), 1174 exports = { 'env' : e }, duplicate = False) 1175 1176# base help text 1177Help(''' 1178Usage: scons [scons options] [build variables] [target(s)] 1179 1180Extra scons options: 1181%(options)s 1182 1183Global build variables: 1184%(global_vars)s 1185 1186%(local_vars)s 1187''' % help_texts) 1188