SConstruct

   1 # -*- mode:python -*-
   2
   3 # Copyright (c) 2004-2005 The Regents of The University of Michigan
   4 # All rights reserved.
   5 #
   6 # Redistribution and use in source and binary forms, with or without
   7 # modification, are permitted provided that the following conditions are
   8 # met: redistributions of source code must retain the above copyright
   9 # notice, this list of conditions and the following disclaimer;
  10 # redistributions in binary form must reproduce the above copyright
  11 # notice, this list of conditions and the following disclaimer in the
  12 # documentation and/or other materials provided with the distribution;
  13 # neither the name of the copyright holders nor the names of its
  14 # contributors may be used to endorse or promote products derived from
  15 # this software without specific prior written permission.
  16 #
  17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  20 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  21 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 #
  29 # Authors: Steve Reinhardt
  30
  31 ###################################################
  32 #
  33 # SCons top-level build description (SConstruct) file.
  34 #
  35 # While in this directory ('m5'), just type 'scons' to build the default
  36 # configuration (see below), or type 'scons build/<CONFIG>/<binary>'
  37 # to build some other configuration (e.g., 'build/ALPHA_FS/m5.opt' for
  38 # the optimized full-system version).
  39 #
  40 # You can build M5 in a different directory as long as there is a
  41 # 'build/<CONFIG>' somewhere along the target path.  The build system
  42 # expects that all configs under the same build directory are being
  43 # built for the same host system.
  44 #
  45 # Examples:
  46 #
  47 #   The following two commands are equivalent.  The '-u' option tells
  48 #   scons to search up the directory tree for this SConstruct file.
  49 #   % cd <path-to-src>/m5 ; scons build/ALPHA_FS/m5.debug
  50 #   % cd <path-to-src>/m5/build/ALPHA_FS; scons -u m5.debug
  51 #
  52 #   The following two commands are equivalent and demonstrate building
  53 #   in a directory outside of the source tree.  The '-C' option tells
  54 #   scons to chdir to the specified directory to find this SConstruct
  55 #   file.
  56 #   % cd <path-to-src>/m5 ; scons /local/foo/build/ALPHA_FS/m5.debug
  57 #   % cd /local/foo/build/ALPHA_FS; scons -C <path-to-src>/m5 m5.debug
  58 #
  59 # You can use 'scons -H' to print scons options.  If you're in this
  60 # 'm5' directory (or use -u or -C to tell scons where to find this
  61 # file), you can use 'scons -h' to print all the M5-specific build
  62 # options as well.
  63 #
  64 ###################################################
  65
  66 import sys
  67 import os
  68 import subprocess
  69
  70 from os.path import isdir, join as joinpath
  71
  72 # Check for recent-enough Python and SCons versions.  If your system's
  73 # default installation of Python is not recent enough, you can use a
  74 # non-default installation of the Python interpreter by either (1)
  75 # rearranging your PATH so that scons finds the non-default 'python'
  76 # first or (2) explicitly invoking an alternative interpreter on the
  77 # scons script, e.g., "/usr/local/bin/python2.4 `which scons` [args]".
  78 EnsurePythonVersion(2,4)
  79
  80 # Ironically, SCons 0.96 dies if you give EnsureSconsVersion a
  81 # 3-element version number.
  82 min_scons_version = (0,96,91)
  83 try:
  84     EnsureSConsVersion(*min_scons_version)
  85 except:
  86     print "Error checking current SCons version."
  87     print "SCons", ".".join(map(str,min_scons_version)), "or greater required."
  88     Exit(2)
  89
  90
  91 # The absolute path to the current directory (where this file lives).
  92 ROOT = Dir('.').abspath
  93
  94 # Path to the M5 source tree.
  95 SRCDIR = joinpath(ROOT, 'src')
  96
  97 # tell python where to find m5 python code
  98 sys.path.append(joinpath(ROOT, 'src/python'))
  99
 100 def check_style_hook(ui):
 101     ui.readconfig(joinpath(ROOT, '.hg', 'hgrc'))
 102     style_hook = ui.config('hooks', 'pretxncommit.style', None)
 103
 104     if not style_hook:
 105         print """\
 106 You're missing the M5 style hook.
 107 Please install the hook so we can ensure that all code fits a common style.
 108
 109 All you'd need to do is add the following lines to your repository .hg/hgrc
 110 or your personal .hgrc
 111 ----------------
 112
 113 [extensions]
 114 style = %s/util/style.py
 115
 116 [hooks]
 117 pretxncommit.style = python:style.check_whitespace
 118 """ % (ROOT)
 119         sys.exit(1)
 120
 121 if isdir(joinpath(ROOT, '.hg')):
 122     try:
 123         from mercurial import ui
 124         check_style_hook(ui.ui())
 125     except ImportError:
 126         pass
 127
 128 ###################################################
 129 #
 130 # Figure out which configurations to set up based on the path(s) of
 131 # the target(s).
 132 #
 133 ###################################################
 134
 135 # Find default configuration & binary.
 136 Default(os.environ.get('M5_DEFAULT_BINARY', 'build/ALPHA_SE/m5.debug'))
 137
 138 # helper function: find last occurrence of element in list
 139 def rfind(l, elt, offs = -1):
 140     for i in range(len(l)+offs, 0, -1):
 141         if l[i] == elt:
 142             return i
 143     raise ValueError, "element not found"
 144
 145 # helper function: compare dotted version numbers.
 146 # E.g., compare_version('1.3.25', '1.4.1')
 147 # returns -1, 0, 1 if v1 is <, ==, > v2
 148 def compare_versions(v1, v2):
 149     # Convert dotted strings to lists
 150     v1 = map(int, v1.split('.'))
 151     v2 = map(int, v2.split('.'))
 152     # Compare corresponding elements of lists
 153     for n1,n2 in zip(v1, v2):
 154         if n1 < n2: return -1
 155         if n1 > n2: return  1
 156     # all corresponding values are equal... see if one has extra values
 157     if len(v1) < len(v2): return -1
 158     if len(v1) > len(v2): return  1
 159     return 0
 160
 161 # Each target must have 'build' in the interior of the path; the
 162 # directory below this will determine the build parameters.  For
 163 # example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
 164 # recognize that ALPHA_SE specifies the configuration because it
 165 # follow 'build' in the bulid path.
 166
 167 # Generate absolute paths to targets so we can see where the build dir is
 168 if COMMAND_LINE_TARGETS:
 169     # Ask SCons which directory it was invoked from
 170     launch_dir = GetLaunchDir()
 171     # Make targets relative to invocation directory
 172     abs_targets = map(lambda x: os.path.normpath(joinpath(launch_dir, str(x))),
 173                       COMMAND_LINE_TARGETS)
 174 else:
 175     # Default targets are relative to root of tree
 176     abs_targets = map(lambda x: os.path.normpath(joinpath(ROOT, str(x))),
 177                       DEFAULT_TARGETS)
 178
 179
 180 # Generate a list of the unique build roots and configs that the
 181 # collected targets reference.
 182 build_paths = []
 183 build_root = None
 184 for t in abs_targets:
 185     path_dirs = t.split('/')
 186     try:
 187         build_top = rfind(path_dirs, 'build', -2)
 188     except:
 189         print "Error: no non-leaf 'build' dir found on target path", t
 190         Exit(1)
 191     this_build_root = joinpath('/',*path_dirs[:build_top+1])
 192     if not build_root:
 193         build_root = this_build_root
 194     else:
 195         if this_build_root != build_root:
 196             print "Error: build targets not under same build root\n"\
 197                   "  %s\n  %s" % (build_root, this_build_root)
 198             Exit(1)
 199     build_path = joinpath('/',*path_dirs[:build_top+2])
 200     if build_path not in build_paths:
 201         build_paths.append(build_path)
 202
 203 ###################################################
 204 #
 205 # Set up the default build environment.  This environment is copied
 206 # and modified according to each selected configuration.
 207 #
 208 ###################################################
 209
 210 env = Environment(ENV = os.environ,  # inherit user's environment vars
 211                   ROOT = ROOT,
 212                   SRCDIR = SRCDIR)
 213
 214 #Parse CC/CXX early so that we use the correct compiler for
 215 # to test for dependencies/versions/libraries/includes
 216 if ARGUMENTS.get('CC', None):
 217     env['CC'] = ARGUMENTS.get('CC')
 218
 219 if ARGUMENTS.get('CXX', None):
 220     env['CXX'] = ARGUMENTS.get('CXX')
 221
 222 Export('env')
 223
 224 env.SConsignFile(joinpath(build_root,"sconsign"))
 225
 226 # Default duplicate option is to use hard links, but this messes up
 227 # when you use emacs to edit a file in the target dir, as emacs moves
 228 # file to file~ then copies to file, breaking the link.  Symbolic
 229 # (soft) links work better.
 230 env.SetOption('duplicate', 'soft-copy')
 231
 232 # I waffle on this setting... it does avoid a few painful but
 233 # unnecessary builds, but it also seems to make trivial builds take
 234 # noticeably longer.
 235 if False:
 236     env.TargetSignatures('content')
 237
 238 # M5_PLY is used by isa_parser.py to find the PLY package.
 239 env.Append(ENV = { 'M5_PLY' : Dir('ext/ply') })
 240 env['GCC'] = False
 241 env['SUNCC'] = False
 242 env['ICC'] = False
 243 env['GCC'] = subprocess.Popen(env['CXX'] + ' --version', shell=True,
 244         stdout=subprocess.PIPE, stderr=subprocess.STDOUT,
 245         close_fds=True).communicate()[0].find('GCC') >= 0
 246 env['SUNCC'] = subprocess.Popen(env['CXX'] + ' -V', shell=True,
 247         stdout=subprocess.PIPE, stderr=subprocess.STDOUT,
 248         close_fds=True).communicate()[0].find('Sun C++') >= 0
 249 env['ICC'] = subprocess.Popen(env['CXX'] + ' -V', shell=True,
 250         stdout=subprocess.PIPE, stderr=subprocess.STDOUT,
 251         close_fds=True).communicate()[0].find('Intel') >= 0
 252 if env['GCC'] + env['SUNCC'] + env['ICC'] > 1:
 253     print 'Error: How can we have two at the same time?'
 254     Exit(1)
 255
 256
 257 # Set up default C++ compiler flags
 258 if env['GCC']:
 259     env.Append(CCFLAGS='-pipe')
 260     env.Append(CCFLAGS='-fno-strict-aliasing')
 261     env.Append(CCFLAGS=Split('-Wall -Wno-sign-compare -Werror -Wundef'))
 262 elif env['ICC']:
 263     pass #Fix me... add warning flags once we clean up icc warnings
 264 elif env['SUNCC']:
 265     env.Append(CCFLAGS='-Qoption ccfe')
 266     env.Append(CCFLAGS='-features=gcc')
 267     env.Append(CCFLAGS='-features=extensions')
 268     env.Append(CCFLAGS='-library=stlport4')
 269     env.Append(CCFLAGS='-xar')
 270 #    env.Append(CCFLAGS='-instances=semiexplicit')
 271 else:
 272     print 'Error: Don\'t know what compiler options to use for your compiler.'
 273     print '       Please fix SConstruct and src/SConscript and try again.'
 274     Exit(1)
 275
 276 if sys.platform == 'cygwin':
 277     # cygwin has some header file issues...
 278     env.Append(CCFLAGS=Split("-Wno-uninitialized"))
 279 env.Append(CPPPATH=[Dir('ext/dnet')])
 280
 281 # Check for SWIG
 282 if not env.has_key('SWIG'):
 283     print 'Error: SWIG utility not found.'
 284     print '       Please install (see http://www.swig.org) and retry.'
 285     Exit(1)
 286
 287 # Check for appropriate SWIG version
 288 swig_version = os.popen('swig -version').read().split()
 289 # First 3 words should be "SWIG Version x.y.z"
 290 if swig_version[0] != 'SWIG' or swig_version[1] != 'Version':
 291     print 'Error determining SWIG version.'
 292     Exit(1)
 293
 294 min_swig_version = '1.3.28'
 295 if compare_versions(swig_version[2], min_swig_version) < 0:
 296     print 'Error: SWIG version', min_swig_version, 'or newer required.'
 297     print '       Installed version:', swig_version[2]
 298     Exit(1)
 299
 300 # Set up SWIG flags & scanner
 301 swig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
 302 env.Append(SWIGFLAGS=swig_flags)
 303
 304 # filter out all existing swig scanners, they mess up the dependency
 305 # stuff for some reason
 306 scanners = []
 307 for scanner in env['SCANNERS']:
 308     skeys = scanner.skeys
 309     if skeys == '.i':
 310         continue
 311
 312     if isinstance(skeys, (list, tuple)) and '.i' in skeys:
 313         continue
 314
 315     scanners.append(scanner)
 316
 317 # add the new swig scanner that we like better
 318 from SCons.Scanner import ClassicCPP as CPPScanner
 319 swig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
 320 scanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re))
 321
 322 # replace the scanners list that has what we want
 323 env['SCANNERS'] = scanners
 324
 325 # Platform-specific configuration.  Note again that we assume that all
 326 # builds under a given build root run on the same host platform.
 327 conf = Configure(env,
 328                  conf_dir = joinpath(build_root, '.scons_config'),
 329                  log_file = joinpath(build_root, 'scons_config.log'))
 330
 331 # Find Python include and library directories for embedding the
 332 # interpreter.  For consistency, we will use the same Python
 333 # installation used to run scons (and thus this script).  If you want
 334 # to link in an alternate version, see above for instructions on how
 335 # to invoke scons with a different copy of the Python interpreter.
 336
 337 # Get brief Python version name (e.g., "python2.4") for locating
 338 # include & library files
 339 py_version_name = 'python' + sys.version[:3]
 340
 341 # include path, e.g. /usr/local/include/python2.4
 342 py_header_path = joinpath(sys.exec_prefix, 'include', py_version_name)
 343 env.Append(CPPPATH = py_header_path)
 344 # verify that it works
 345 if not conf.CheckHeader('Python.h', '<>'):
 346     print "Error: can't find Python.h header in", py_header_path
 347     Exit(1)
 348
 349 # add library path too if it's not in the default place
 350 py_lib_path = None
 351 if sys.exec_prefix != '/usr':
 352     py_lib_path = joinpath(sys.exec_prefix, 'lib')
 353 elif sys.platform == 'cygwin':
 354     # cygwin puts the .dll in /bin for some reason
 355     py_lib_path = '/bin'
 356 if py_lib_path:
 357     env.Append(LIBPATH = py_lib_path)
 358     print 'Adding', py_lib_path, 'to LIBPATH for', py_version_name
 359 if not conf.CheckLib(py_version_name):
 360     print "Error: can't find Python library", py_version_name
 361     Exit(1)
 362
 363 # On Solaris you need to use libsocket for socket ops
 364 if not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
 365    if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
 366        print "Can't find library with socket calls (e.g. accept())"
 367        Exit(1)
 368
 369 # Check for zlib.  If the check passes, libz will be automatically
 370 # added to the LIBS environment variable.
 371 if not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
 372     print 'Error: did not find needed zlib compression library '\
 373           'and/or zlib.h header file.'
 374     print '       Please install zlib and try again.'
 375     Exit(1)
 376
 377 # Check for <fenv.h> (C99 FP environment control)
 378 have_fenv = conf.CheckHeader('fenv.h', '<>')
 379 if not have_fenv:
 380     print "Warning: Header file <fenv.h> not found."
 381     print "         This host has no IEEE FP rounding mode control."
 382
 383 # Check for mysql.
 384 mysql_config = WhereIs('mysql_config')
 385 have_mysql = mysql_config != None
 386
 387 # Check MySQL version.
 388 if have_mysql:
 389     mysql_version = os.popen(mysql_config + ' --version').read()
 390     min_mysql_version = '4.1'
 391     if compare_versions(mysql_version, min_mysql_version) < 0:
 392         print 'Warning: MySQL', min_mysql_version, 'or newer required.'
 393         print '         Version', mysql_version, 'detected.'
 394         have_mysql = False
 395
 396 # Set up mysql_config commands.
 397 if have_mysql:
 398     mysql_config_include = mysql_config + ' --include'
 399     if os.system(mysql_config_include + ' > /dev/null') != 0:
 400         # older mysql_config versions don't support --include, use
 401         # --cflags instead
 402         mysql_config_include = mysql_config + ' --cflags | sed s/\\\'//g'
 403     # This seems to work in all versions
 404     mysql_config_libs = mysql_config + ' --libs'
 405
 406 env = conf.Finish()
 407
 408 # Define the universe of supported ISAs
 409 all_isa_list = [ ]
 410 Export('all_isa_list')
 411
 412 # Define the universe of supported CPU models
 413 all_cpu_list = [ ]
 414 default_cpus = [ ]
 415 Export('all_cpu_list', 'default_cpus')
 416
 417 # Sticky options get saved in the options file so they persist from
 418 # one invocation to the next (unless overridden, in which case the new
 419 # value becomes sticky).
 420 sticky_opts = Options(args=ARGUMENTS)
 421 Export('sticky_opts')
 422
 423 # Non-sticky options only apply to the current build.
 424 nonsticky_opts = Options(args=ARGUMENTS)
 425 Export('nonsticky_opts')
 426
 427 # Walk the tree and execute all SConsopts scripts that wil add to the
 428 # above options
 429 for root, dirs, files in os.walk('.'):
 430     if 'SConsopts' in files:
 431         SConscript(os.path.join(root, 'SConsopts'))
 432
 433 all_isa_list.sort()
 434 all_cpu_list.sort()
 435 default_cpus.sort()
 436
 437 sticky_opts.AddOptions(
 438     EnumOption('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list),
 439     BoolOption('FULL_SYSTEM', 'Full-system support', False),
 440     # There's a bug in scons 0.96.1 that causes ListOptions with list
 441     # values (more than one value) not to be able to be restored from
 442     # a saved option file.  If this causes trouble then upgrade to
 443     # scons 0.96.90 or later.
 444     ListOption('CPU_MODELS', 'CPU models', default_cpus, all_cpu_list),
 445     BoolOption('NO_FAST_ALLOC', 'Disable fast object allocator', False),
 446     BoolOption('EFENCE', 'Link with Electric Fence malloc debugger',
 447                False),
 448     BoolOption('SS_COMPATIBLE_FP',
 449                'Make floating-point results compatible with SimpleScalar',
 450                False),
 451     BoolOption('USE_SSE2',
 452                'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
 453                False),
 454     BoolOption('USE_MYSQL', 'Use MySQL for stats output', have_mysql),
 455     BoolOption('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
 456     BoolOption('USE_CHECKER', 'Use checker for detailed CPU models', False),
 457     ('CC', 'C compiler', os.environ.get('CC', env['CC'])),
 458     ('CXX', 'C++ compiler', os.environ.get('CXX', env['CXX'])),
 459     BoolOption('BATCH', 'Use batch pool for build and tests', False),
 460     ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
 461     ('PYTHONHOME',
 462      'Override the default PYTHONHOME for this system (use with caution)',
 463      '%s:%s' % (sys.prefix, sys.exec_prefix))
 464     )
 465
 466 nonsticky_opts.AddOptions(
 467     BoolOption('update_ref', 'Update test reference outputs', False)
 468     )
 469
 470 # These options get exported to #defines in config/*.hh (see src/SConscript).
 471 env.ExportOptions = ['FULL_SYSTEM', 'ALPHA_TLASER', 'USE_FENV', \
 472                      'USE_MYSQL', 'NO_FAST_ALLOC', 'SS_COMPATIBLE_FP', \
 473                      'USE_CHECKER', 'PYTHONHOME', 'TARGET_ISA']
 474
 475 # Define a handy 'no-op' action
 476 def no_action(target, source, env):
 477     return 0
 478
 479 env.NoAction = Action(no_action, None)
 480
 481 ###################################################
 482 #
 483 # Define a SCons builder for configuration flag headers.
 484 #
 485 ###################################################
 486
 487 # This function generates a config header file that #defines the
 488 # option symbol to the current option setting (0 or 1).  The source
 489 # operands are the name of the option and a Value node containing the
 490 # value of the option.
 491 def build_config_file(target, source, env):
 492     (option, value) = [s.get_contents() for s in source]
 493     f = file(str(target[0]), 'w')
 494     print >> f, '#define', option, value
 495     f.close()
 496     return None
 497
 498 # Generate the message to be printed when building the config file.
 499 def build_config_file_string(target, source, env):
 500     (option, value) = [s.get_contents() for s in source]
 501     return "Defining %s as %s in %s." % (option, value, target[0])
 502
 503 # Combine the two functions into a scons Action object.
 504 config_action = Action(build_config_file, build_config_file_string)
 505
 506 # The emitter munges the source & target node lists to reflect what
 507 # we're really doing.
 508 def config_emitter(target, source, env):
 509     # extract option name from Builder arg
 510     option = str(target[0])
 511     # True target is config header file
 512     target = joinpath('config', option.lower() + '.hh')
 513     val = env[option]
 514     if isinstance(val, bool):
 515         # Force value to 0/1
 516         val = int(val)
 517     elif isinstance(val, str):
 518         val = '"' + val + '"'
 519
 520     # Sources are option name & value (packaged in SCons Value nodes)
 521     return ([target], [Value(option), Value(val)])
 522
 523 config_builder = Builder(emitter = config_emitter, action = config_action)
 524
 525 env.Append(BUILDERS = { 'ConfigFile' : config_builder })
 526
 527 ###################################################
 528 #
 529 # Define a SCons builder for copying files.  This is used by the
 530 # Python zipfile code in src/python/SConscript, but is placed up here
 531 # since it's potentially more generally applicable.
 532 #
 533 ###################################################
 534
 535 copy_builder = Builder(action = Copy("$TARGET", "$SOURCE"))
 536
 537 env.Append(BUILDERS = { 'CopyFile' : copy_builder })
 538
 539 ###################################################
 540 #
 541 # Define a simple SCons builder to concatenate files.
 542 #
 543 # Used to append the Python zip archive to the executable.
 544 #
 545 ###################################################
 546
 547 concat_builder = Builder(action = Action(['cat $SOURCES > $TARGET',
 548                                           'chmod +x $TARGET']))
 549
 550 env.Append(BUILDERS = { 'Concat' : concat_builder })
 551
 552
 553 # base help text
 554 help_text = '''
 555 Usage: scons [scons options] [build options] [target(s)]
 556
 557 '''
 558
 559 # libelf build is shared across all configs in the build root.
 560 env.SConscript('ext/libelf/SConscript',
 561                build_dir = joinpath(build_root, 'libelf'),
 562                exports = 'env')
 563
 564 ###################################################
 565 #
 566 # This function is used to set up a directory with switching headers
 567 #
 568 ###################################################
 569
 570 env['ALL_ISA_LIST'] = all_isa_list
 571 def make_switching_dir(dirname, switch_headers, env):
 572     # Generate the header.  target[0] is the full path of the output
 573     # header to generate.  'source' is a dummy variable, since we get the
 574     # list of ISAs from env['ALL_ISA_LIST'].
 575     def gen_switch_hdr(target, source, env):
 576         fname = str(target[0])
 577         basename = os.path.basename(fname)
 578         f = open(fname, 'w')
 579         f.write('#include "arch/isa_specific.hh"\n')
 580         cond = '#if'
 581         for isa in all_isa_list:
 582             f.write('%s THE_ISA == %s_ISA\n#include "%s/%s/%s"\n'
 583                     % (cond, isa.upper(), dirname, isa, basename))
 584             cond = '#elif'
 585         f.write('#else\n#error "THE_ISA not set"\n#endif\n')
 586         f.close()
 587         return 0
 588
 589     # String to print when generating header
 590     def gen_switch_hdr_string(target, source, env):
 591         return "Generating switch header " + str(target[0])
 592
 593     # Build SCons Action object. 'varlist' specifies env vars that this
 594     # action depends on; when env['ALL_ISA_LIST'] changes these actions
 595     # should get re-executed.
 596     switch_hdr_action = Action(gen_switch_hdr, gen_switch_hdr_string,
 597                                varlist=['ALL_ISA_LIST'])
 598
 599     # Instantiate actions for each header
 600     for hdr in switch_headers:
 601         env.Command(hdr, [], switch_hdr_action)
 602 Export('make_switching_dir')
 603
 604 ###################################################
 605 #
 606 # Define build environments for selected configurations.
 607 #
 608 ###################################################
 609
 610 # rename base env
 611 base_env = env
 612
 613 for build_path in build_paths:
 614     print "Building in", build_path
 615     # build_dir is the tail component of build path, and is used to
 616     # determine the build parameters (e.g., 'ALPHA_SE')
 617     (build_root, build_dir) = os.path.split(build_path)
 618     # Make a copy of the build-root environment to use for this config.
 619     env = base_env.Copy()
 620
 621     # Set env options according to the build directory config.
 622     sticky_opts.files = []
 623     # Options for $BUILD_ROOT/$BUILD_DIR are stored in
 624     # $BUILD_ROOT/options/$BUILD_DIR so you can nuke
 625     # $BUILD_ROOT/$BUILD_DIR without losing your options settings.
 626     current_opts_file = joinpath(build_root, 'options', build_dir)
 627     if os.path.isfile(current_opts_file):
 628         sticky_opts.files.append(current_opts_file)
 629         print "Using saved options file %s" % current_opts_file
 630     else:
 631         # Build dir-specific options file doesn't exist.
 632
 633         # Make sure the directory is there so we can create it later
 634         opt_dir = os.path.dirname(current_opts_file)
 635         if not os.path.isdir(opt_dir):
 636             os.mkdir(opt_dir)
 637
 638         # Get default build options from source tree.  Options are
 639         # normally determined by name of $BUILD_DIR, but can be
 640         # overriden by 'default=' arg on command line.
 641         default_opts_file = joinpath('build_opts',
 642                                      ARGUMENTS.get('default', build_dir))
 643         if os.path.isfile(default_opts_file):
 644             sticky_opts.files.append(default_opts_file)
 645             print "Options file %s not found,\n  using defaults in %s" \
 646                   % (current_opts_file, default_opts_file)
 647         else:
 648             print "Error: cannot find options file %s or %s" \
 649                   % (current_opts_file, default_opts_file)
 650             Exit(1)
 651
 652     # Apply current option settings to env
 653     sticky_opts.Update(env)
 654     nonsticky_opts.Update(env)
 655
 656     help_text += "Sticky options for %s:\n" % build_dir \
 657                  + sticky_opts.GenerateHelpText(env) \
 658                  + "\nNon-sticky options for %s:\n" % build_dir \
 659                  + nonsticky_opts.GenerateHelpText(env)
 660
 661     # Process option settings.
 662
 663     if not have_fenv and env['USE_FENV']:
 664         print "Warning: <fenv.h> not available; " \
 665               "forcing USE_FENV to False in", build_dir + "."
 666         env['USE_FENV'] = False
 667
 668     if not env['USE_FENV']:
 669         print "Warning: No IEEE FP rounding mode control in", build_dir + "."
 670         print "         FP results may deviate slightly from other platforms."
 671
 672     if env['EFENCE']:
 673         env.Append(LIBS=['efence'])
 674
 675     if env['USE_MYSQL']:
 676         if not have_mysql:
 677             print "Warning: MySQL not available; " \
 678                   "forcing USE_MYSQL to False in", build_dir + "."
 679             env['USE_MYSQL'] = False
 680         else:
 681             print "Compiling in", build_dir, "with MySQL support."
 682             env.ParseConfig(mysql_config_libs)
 683             env.ParseConfig(mysql_config_include)
 684
 685     # Save sticky option settings back to current options file
 686     sticky_opts.Save(current_opts_file, env)
 687
 688     # Do this after we save setting back, or else we'll tack on an
 689     # extra 'qdo' every time we run scons.
 690     if env['BATCH']:
 691         env['CC']  = env['BATCH_CMD'] + ' ' + env['CC']
 692         env['CXX'] = env['BATCH_CMD'] + ' ' + env['CXX']
 693
 694     if env['USE_SSE2']:
 695         env.Append(CCFLAGS='-msse2')
 696
 697     # The src/SConscript file sets up the build rules in 'env' according
 698     # to the configured options.  It returns a list of environments,
 699     # one for each variant build (debug, opt, etc.)
 700     envList = SConscript('src/SConscript', build_dir = build_path,
 701                          exports = 'env')
 702
 703     # Set up the regression tests for each build.
 704     for e in envList:
 705         SConscript('tests/SConscript',
 706                    build_dir = joinpath(build_path, 'tests', e.Label),
 707                    exports = { 'env' : e }, duplicate = False)
 708
 709 Help(help_text)
 710
 711
 712 ###################################################
 713 #
 714 # Let SCons do its thing.  At this point SCons will use the defined
 715 # build environments to build the requested targets.
 716 #
 717 ###################################################
 718