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