SConstruct

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