SConstruct

   1 # -*- mode:python -*-
   2
   3 # Copyright (c) 2013, 2015-2020 ARM Limited
   4 # All rights reserved.
   5 #
   6 # The license below extends only to copyright in the software and shall
   7 # not be construed as granting a license to any other intellectual
   8 # property including but not limited to intellectual property relating
   9 # to a hardware implementation of the functionality of the software
  10 # licensed hereunder.  You may use the software subject to the license
  11 # terms below provided that you ensure that this notice is replicated
  12 # unmodified and in its entirety in all distributions of the software,
  13 # modified or unmodified, in source code or in binary form.
  14 #
  15 # Copyright (c) 2011 Advanced Micro Devices, Inc.
  16 # Copyright (c) 2009 The Hewlett-Packard Development Company
  17 # Copyright (c) 2004-2005 The Regents of The University of Michigan
  18 # All rights reserved.
  19 #
  20 # Redistribution and use in source and binary forms, with or without
  21 # modification, are permitted provided that the following conditions are
  22 # met: redistributions of source code must retain the above copyright
  23 # notice, this list of conditions and the following disclaimer;
  24 # redistributions in binary form must reproduce the above copyright
  25 # notice, this list of conditions and the following disclaimer in the
  26 # documentation and/or other materials provided with the distribution;
  27 # neither the name of the copyright holders nor the names of its
  28 # contributors may be used to endorse or promote products derived from
  29 # this software without specific prior written permission.
  30 #
  31 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  32 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  33 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  34 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  35 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  36 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  37 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  38 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  39 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  40 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  41 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  42
  43 ###################################################
  44 #
  45 # SCons top-level build description (SConstruct) file.
  46 #
  47 # While in this directory ('gem5'), just type 'scons' to build the default
  48 # configuration (see below), or type 'scons build/<CONFIG>/<binary>'
  49 # to build some other configuration (e.g., 'build/X86/gem5.opt' for
  50 # the optimized full-system version).
  51 #
  52 # You can build gem5 in a different directory as long as there is a
  53 # 'build/<CONFIG>' somewhere along the target path.  The build system
  54 # expects that all configs under the same build directory are being
  55 # built for the same host system.
  56 #
  57 # Examples:
  58 #
  59 #   The following two commands are equivalent.  The '-u' option tells
  60 #   scons to search up the directory tree for this SConstruct file.
  61 #   % cd <path-to-src>/gem5 ; scons build/X86/gem5.debug
  62 #   % cd <path-to-src>/gem5/build/X86; scons -u gem5.debug
  63 #
  64 #   The following two commands are equivalent and demonstrate building
  65 #   in a directory outside of the source tree.  The '-C' option tells
  66 #   scons to chdir to the specified directory to find this SConstruct
  67 #   file.
  68 #   % cd <path-to-src>/gem5 ; scons /local/foo/build/X86/gem5.debug
  69 #   % cd /local/foo/build/X86; scons -C <path-to-src>/gem5 gem5.debug
  70 #
  71 # You can use 'scons -H' to print scons options.  If you're in this
  72 # 'gem5' directory (or use -u or -C to tell scons where to find this
  73 # file), you can use 'scons -h' to print all the gem5-specific build
  74 # options as well.
  75 #
  76 ###################################################
  77
  78 from __future__ import print_function
  79
  80 # Global Python includes
  81 import atexit
  82 import itertools
  83 import os
  84 import re
  85 import shutil
  86 import subprocess
  87 import sys
  88
  89 from os import mkdir, environ
  90 from os.path import abspath, basename, dirname, expanduser, normpath
  91 from os.path import exists,  isdir, isfile
  92 from os.path import join as joinpath, split as splitpath
  93 from re import match
  94
  95 # SCons includes
  96 import SCons
  97 import SCons.Node
  98 import SCons.Node.FS
  99
 100 from m5.util import compareVersions, readCommand
 101
 102 help_texts = {
 103     "options" : "",
 104     "global_vars" : "",
 105     "local_vars" : ""
 106 }
 107
 108 Export("help_texts")
 109
 110
 111 # There's a bug in scons in that (1) by default, the help texts from
 112 # AddOption() are supposed to be displayed when you type 'scons -h'
 113 # and (2) you can override the help displayed by 'scons -h' using the
 114 # Help() function, but these two features are incompatible: once
 115 # you've overridden the help text using Help(), there's no way to get
 116 # at the help texts from AddOptions.  See:
 117 #     http://scons.tigris.org/issues/show_bug.cgi?id=2356
 118 #     http://scons.tigris.org/issues/show_bug.cgi?id=2611
 119 # This hack lets us extract the help text from AddOptions and
 120 # re-inject it via Help().  Ideally someday this bug will be fixed and
 121 # we can just use AddOption directly.
 122 def AddLocalOption(*args, **kwargs):
 123     col_width = 30
 124
 125     help = "  " + ", ".join(args)
 126     if "help" in kwargs:
 127         length = len(help)
 128         if length >= col_width:
 129             help += "\n" + " " * col_width
 130         else:
 131             help += " " * (col_width - length)
 132         help += kwargs["help"]
 133     help_texts["options"] += help + "\n"
 134
 135     AddOption(*args, **kwargs)
 136
 137 AddLocalOption('--colors', dest='use_colors', action='store_true',
 138                help="Add color to abbreviated scons output")
 139 AddLocalOption('--no-colors', dest='use_colors', action='store_false',
 140                help="Don't add color to abbreviated scons output")
 141 AddLocalOption('--with-cxx-config', dest='with_cxx_config',
 142                action='store_true',
 143                help="Build with support for C++-based configuration")
 144 AddLocalOption('--default', dest='default', type='string', action='store',
 145                help='Override which build_opts file to use for defaults')
 146 AddLocalOption('--ignore-style', dest='ignore_style', action='store_true',
 147                help='Disable style checking hooks')
 148 AddLocalOption('--gold-linker', dest='gold_linker', action='store_true',
 149                help='Use the gold linker')
 150 AddLocalOption('--no-lto', dest='no_lto', action='store_true',
 151                help='Disable Link-Time Optimization for fast')
 152 AddLocalOption('--force-lto', dest='force_lto', action='store_true',
 153                help='Use Link-Time Optimization instead of partial linking' +
 154                     ' when the compiler doesn\'t support using them together.')
 155 AddLocalOption('--update-ref', dest='update_ref', action='store_true',
 156                help='Update test reference outputs')
 157 AddLocalOption('--verbose', dest='verbose', action='store_true',
 158                help='Print full tool command lines')
 159 AddLocalOption('--without-python', dest='without_python',
 160                action='store_true',
 161                help='Build without Python configuration support')
 162 AddLocalOption('--without-tcmalloc', dest='without_tcmalloc',
 163                action='store_true',
 164                help='Disable linking against tcmalloc')
 165 AddLocalOption('--with-ubsan', dest='with_ubsan', action='store_true',
 166                help='Build with Undefined Behavior Sanitizer if available')
 167 AddLocalOption('--with-asan', dest='with_asan', action='store_true',
 168                help='Build with Address Sanitizer if available')
 169 AddLocalOption('--with-systemc-tests', dest='with_systemc_tests',
 170                action='store_true', help='Build systemc tests')
 171
 172 from gem5_scons import Transform, error, warning, summarize_warnings
 173
 174 if GetOption('no_lto') and GetOption('force_lto'):
 175     error('--no-lto and --force-lto are mutually exclusive')
 176
 177 ########################################################################
 178 #
 179 # Set up the main build environment.
 180 #
 181 ########################################################################
 182
 183 main = Environment()
 184
 185 from gem5_scons.util import get_termcap
 186 termcap = get_termcap()
 187
 188 main_dict_keys = main.Dictionary().keys()
 189
 190 # Check that we have a C/C++ compiler
 191 if not ('CC' in main_dict_keys and 'CXX' in main_dict_keys):
 192     error("No C++ compiler installed (package g++ on Ubuntu and RedHat)")
 193
 194 ###################################################
 195 #
 196 # Figure out which configurations to set up based on the path(s) of
 197 # the target(s).
 198 #
 199 ###################################################
 200
 201 # Find default configuration & binary.
 202 Default(environ.get('M5_DEFAULT_BINARY', 'build/ARM/gem5.debug'))
 203
 204 # helper function: find last occurrence of element in list
 205 def rfind(l, elt, offs = -1):
 206     for i in range(len(l)+offs, 0, -1):
 207         if l[i] == elt:
 208             return i
 209     raise ValueError("element not found")
 210
 211 # Take a list of paths (or SCons Nodes) and return a list with all
 212 # paths made absolute and ~-expanded.  Paths will be interpreted
 213 # relative to the launch directory unless a different root is provided
 214 def makePathListAbsolute(path_list, root=GetLaunchDir()):
 215     return [abspath(joinpath(root, expanduser(str(p))))
 216             for p in path_list]
 217
 218 # Each target must have 'build' in the interior of the path; the
 219 # directory below this will determine the build parameters.  For
 220 # example, for target 'foo/bar/build/X86/arch/x86/blah.do' we
 221 # recognize that X86 specifies the configuration because it
 222 # follow 'build' in the build path.
 223
 224 # The funky assignment to "[:]" is needed to replace the list contents
 225 # in place rather than reassign the symbol to a new list, which
 226 # doesn't work (obviously!).
 227 BUILD_TARGETS[:] = makePathListAbsolute(BUILD_TARGETS)
 228
 229 # Generate a list of the unique build roots and configs that the
 230 # collected targets reference.
 231 variant_paths = []
 232 build_root = None
 233 for t in BUILD_TARGETS:
 234     path_dirs = t.split('/')
 235     try:
 236         build_top = rfind(path_dirs, 'build', -2)
 237     except:
 238         error("No non-leaf 'build' dir found on target path.", t)
 239     this_build_root = joinpath('/',*path_dirs[:build_top+1])
 240     if not build_root:
 241         build_root = this_build_root
 242     else:
 243         if this_build_root != build_root:
 244             error("build targets not under same build root\n"
 245                   "  %s\n  %s" % (build_root, this_build_root))
 246     variant_path = joinpath('/',*path_dirs[:build_top+2])
 247     if variant_path not in variant_paths:
 248         variant_paths.append(variant_path)
 249
 250 # Make sure build_root exists (might not if this is the first build there)
 251 if not isdir(build_root):
 252     mkdir(build_root)
 253 main['BUILDROOT'] = build_root
 254
 255 Export('main')
 256
 257 main.SConsignFile(joinpath(build_root, "sconsign"))
 258
 259 # Default duplicate option is to use hard links, but this messes up
 260 # when you use emacs to edit a file in the target dir, as emacs moves
 261 # file to file~ then copies to file, breaking the link.  Symbolic
 262 # (soft) links work better.
 263 main.SetOption('duplicate', 'soft-copy')
 264
 265 #
 266 # Set up global sticky variables... these are common to an entire build
 267 # tree (not specific to a particular build like X86)
 268 #
 269
 270 global_vars_file = joinpath(build_root, 'variables.global')
 271
 272 global_vars = Variables(global_vars_file, args=ARGUMENTS)
 273
 274 global_vars.AddVariables(
 275     ('CC', 'C compiler', environ.get('CC', main['CC'])),
 276     ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])),
 277     ('CCFLAGS_EXTRA', 'Extra C and C++ compiler flags', ''),
 278     ('LDFLAGS_EXTRA', 'Extra linker flags', ''),
 279     ('PYTHON_CONFIG', 'Python config binary to use',
 280      [ 'python2.7-config', 'python-config' ]),
 281     ('PROTOC', 'protoc tool', environ.get('PROTOC', 'protoc')),
 282     ('BATCH', 'Use batch pool for build and tests', False),
 283     ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
 284     ('M5_BUILD_CACHE', 'Cache built objects in this directory', False),
 285     ('EXTRAS', 'Add extra directories to the compilation', '')
 286     )
 287
 288 # Update main environment with values from ARGUMENTS & global_vars_file
 289 global_vars.Update(main)
 290 help_texts["global_vars"] += global_vars.GenerateHelpText(main)
 291
 292 # Save sticky variable settings back to current variables file
 293 global_vars.Save(global_vars_file, main)
 294
 295 # Parse EXTRAS variable to build list of all directories where we're
 296 # look for sources etc.  This list is exported as extras_dir_list.
 297 base_dir = main.srcdir.abspath
 298 if main['EXTRAS']:
 299     extras_dir_list = makePathListAbsolute(main['EXTRAS'].split(':'))
 300 else:
 301     extras_dir_list = []
 302
 303 Export('base_dir')
 304 Export('extras_dir_list')
 305
 306 # the ext directory should be on the #includes path
 307 main.Append(CPPPATH=[Dir('ext')])
 308
 309 # Add shared top-level headers
 310 main.Prepend(CPPPATH=Dir('include'))
 311
 312 if GetOption('verbose'):
 313     def MakeAction(action, string, *args, **kwargs):
 314         return Action(action, *args, **kwargs)
 315 else:
 316     MakeAction = Action
 317     main['CCCOMSTR']        = Transform("CC")
 318     main['CXXCOMSTR']       = Transform("CXX")
 319     main['ASCOMSTR']        = Transform("AS")
 320     main['ARCOMSTR']        = Transform("AR", 0)
 321     main['LINKCOMSTR']      = Transform("LINK", 0)
 322     main['SHLINKCOMSTR']    = Transform("SHLINK", 0)
 323     main['RANLIBCOMSTR']    = Transform("RANLIB", 0)
 324     main['M4COMSTR']        = Transform("M4")
 325     main['SHCCCOMSTR']      = Transform("SHCC")
 326     main['SHCXXCOMSTR']     = Transform("SHCXX")
 327 Export('MakeAction')
 328
 329 # Initialize the Link-Time Optimization (LTO) flags
 330 main['LTO_CCFLAGS'] = []
 331 main['LTO_LDFLAGS'] = []
 332
 333 # According to the readme, tcmalloc works best if the compiler doesn't
 334 # assume that we're using the builtin malloc and friends. These flags
 335 # are compiler-specific, so we need to set them after we detect which
 336 # compiler we're using.
 337 main['TCMALLOC_CCFLAGS'] = []
 338
 339 CXX_version = readCommand([main['CXX'],'--version'], exception=False)
 340 CXX_V = readCommand([main['CXX'],'-V'], exception=False)
 341
 342 main['GCC'] = CXX_version and CXX_version.find('g++') >= 0
 343 main['CLANG'] = CXX_version and CXX_version.find('clang') >= 0
 344 if main['GCC'] + main['CLANG'] > 1:
 345     error('Two compilers enabled at once?')
 346
 347 # Set up default C++ compiler flags
 348 if main['GCC'] or main['CLANG']:
 349     # As gcc and clang share many flags, do the common parts here
 350     main.Append(CCFLAGS=['-pipe'])
 351     main.Append(CCFLAGS=['-fno-strict-aliasing'])
 352     # Enable -Wall and -Wextra and then disable the few warnings that
 353     # we consistently violate
 354     main.Append(CCFLAGS=['-Wall', '-Wundef', '-Wextra',
 355                          '-Wno-sign-compare', '-Wno-unused-parameter'])
 356     # We always compile using C++11
 357     main.Append(CXXFLAGS=['-std=c++11'])
 358     if sys.platform.startswith('freebsd'):
 359         main.Append(CCFLAGS=['-I/usr/local/include'])
 360         main.Append(CXXFLAGS=['-I/usr/local/include'])
 361
 362     main.Append(LINKFLAGS='-Wl,--as-needed')
 363     main['FILTER_PSHLINKFLAGS'] = lambda x: str(x).replace(' -shared', '')
 364     main['PSHLINKFLAGS'] = main.subst('${FILTER_PSHLINKFLAGS(SHLINKFLAGS)}')
 365     if GetOption('gold_linker'):
 366         main.Append(LINKFLAGS='-fuse-ld=gold')
 367     main['PLINKFLAGS'] = main.get('LINKFLAGS')
 368     shared_partial_flags = ['-r', '-nostdlib']
 369     main.Append(PSHLINKFLAGS=shared_partial_flags)
 370     main.Append(PLINKFLAGS=shared_partial_flags)
 371
 372     # Treat warnings as errors but white list some warnings that we
 373     # want to allow (e.g., deprecation warnings).
 374     main.Append(CCFLAGS=['-Werror',
 375                          '-Wno-error=deprecated-declarations',
 376                          '-Wno-error=deprecated',
 377                         ])
 378 else:
 379     error('\n'.join((
 380           "Don't know what compiler options to use for your compiler.",
 381           "compiler: " + main['CXX'],
 382           "version: " + CXX_version.replace('\n', '<nl>') if
 383                 CXX_version else 'COMMAND NOT FOUND!',
 384           "If you're trying to use a compiler other than GCC",
 385           "or clang, there appears to be something wrong with your",
 386           "environment.",
 387           "",
 388           "If you are trying to use a compiler other than those listed",
 389           "above you will need to ease fix SConstruct and ",
 390           "src/SConscript to support that compiler.")))
 391
 392 if main['GCC']:
 393     # Check for a supported version of gcc. >= 4.8 is chosen for its
 394     # level of c++11 support. See
 395     # http://gcc.gnu.org/projects/cxx0x.html for details.
 396     gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False)
 397     if compareVersions(gcc_version, "4.8") < 0:
 398         error('gcc version 4.8 or newer required.\n'
 399               'Installed version:', gcc_version)
 400         Exit(1)
 401
 402     main['GCC_VERSION'] = gcc_version
 403
 404     if compareVersions(gcc_version, '4.9') >= 0:
 405         # Incremental linking with LTO is currently broken in gcc versions
 406         # 4.9 and above. A version where everything works completely hasn't
 407         # yet been identified.
 408         #
 409         # https://gcc.gnu.org/bugzilla/show_bug.cgi?id=67548
 410         main['BROKEN_INCREMENTAL_LTO'] = True
 411     if compareVersions(gcc_version, '6.0') >= 0:
 412         # gcc versions 6.0 and greater accept an -flinker-output flag which
 413         # selects what type of output the linker should generate. This is
 414         # necessary for incremental lto to work, but is also broken in
 415         # current versions of gcc. It may not be necessary in future
 416         # versions. We add it here since it might be, and as a reminder that
 417         # it exists. It's excluded if lto is being forced.
 418         #
 419         # https://gcc.gnu.org/gcc-6/changes.html
 420         # https://gcc.gnu.org/ml/gcc-patches/2015-11/msg03161.html
 421         # https://gcc.gnu.org/bugzilla/show_bug.cgi?id=69866
 422         if not GetOption('force_lto'):
 423             main.Append(PSHLINKFLAGS='-flinker-output=rel')
 424             main.Append(PLINKFLAGS='-flinker-output=rel')
 425
 426     disable_lto = GetOption('no_lto')
 427     if not disable_lto and main.get('BROKEN_INCREMENTAL_LTO', False) and \
 428             not GetOption('force_lto'):
 429         warning('Your compiler doesn\'t support incremental linking and lto '
 430                 'at the same time, so lto is being disabled. To force lto on '
 431                 'anyway, use the --force-lto option. That will disable '
 432                 'partial linking.')
 433         disable_lto = True
 434
 435     # Add the appropriate Link-Time Optimization (LTO) flags
 436     # unless LTO is explicitly turned off. Note that these flags
 437     # are only used by the fast target.
 438     if not disable_lto:
 439         # Pass the LTO flag when compiling to produce GIMPLE
 440         # output, we merely create the flags here and only append
 441         # them later
 442         main['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
 443
 444         # Use the same amount of jobs for LTO as we are running
 445         # scons with
 446         main['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
 447
 448     main.Append(TCMALLOC_CCFLAGS=['-fno-builtin-malloc', '-fno-builtin-calloc',
 449                                   '-fno-builtin-realloc', '-fno-builtin-free'])
 450
 451 elif main['CLANG']:
 452     # Check for a supported version of clang, >= 3.1 is needed to
 453     # support similar features as gcc 4.8. See
 454     # http://clang.llvm.org/cxx_status.html for details
 455     clang_version_re = re.compile(".* version (\d+\.\d+)")
 456     clang_version_match = clang_version_re.search(CXX_version)
 457     if (clang_version_match):
 458         clang_version = clang_version_match.groups()[0]
 459         if compareVersions(clang_version, "3.1") < 0:
 460             error('clang version 3.1 or newer required.\n'
 461                   'Installed version:', clang_version)
 462     else:
 463         error('Unable to determine clang version.')
 464
 465     # clang has a few additional warnings that we disable, extraneous
 466     # parantheses are allowed due to Ruby's printing of the AST,
 467     # finally self assignments are allowed as the generated CPU code
 468     # is relying on this
 469     main.Append(CCFLAGS=['-Wno-parentheses',
 470                          '-Wno-self-assign',
 471                          # Some versions of libstdc++ (4.8?) seem to
 472                          # use struct hash and class hash
 473                          # interchangeably.
 474                          '-Wno-mismatched-tags',
 475                          ])
 476
 477     main.Append(TCMALLOC_CCFLAGS=['-fno-builtin'])
 478
 479     # On Mac OS X/Darwin we need to also use libc++ (part of XCode) as
 480     # opposed to libstdc++, as the later is dated.
 481     if sys.platform == "darwin":
 482         main.Append(CXXFLAGS=['-stdlib=libc++'])
 483         main.Append(LIBS=['c++'])
 484
 485     # On FreeBSD we need libthr.
 486     if sys.platform.startswith('freebsd'):
 487         main.Append(LIBS=['thr'])
 488
 489 # Add sanitizers flags
 490 sanitizers=[]
 491 if GetOption('with_ubsan'):
 492     # Only gcc >= 4.9 supports UBSan, so check both the version
 493     # and the command-line option before adding the compiler and
 494     # linker flags.
 495     if not main['GCC'] or compareVersions(main['GCC_VERSION'], '4.9') >= 0:
 496         sanitizers.append('undefined')
 497 if GetOption('with_asan'):
 498     # Available for gcc >= 4.8 or llvm >= 3.1 both a requirement
 499     # by the build system
 500     sanitizers.append('address')
 501     suppressions_file = Dir('util').File('lsan-suppressions').get_abspath()
 502     suppressions_opt = 'suppressions=%s' % suppressions_file
 503     main['ENV']['LSAN_OPTIONS'] = ':'.join([suppressions_opt,
 504                                             'print_suppressions=0'])
 505     print()
 506     warning('To suppress false positive leaks, set the LSAN_OPTIONS '
 507             'environment variable to "%s" when running gem5' %
 508             suppressions_opt)
 509     warning('LSAN_OPTIONS=suppressions=%s' % suppressions_opt)
 510     print()
 511 if sanitizers:
 512     sanitizers = ','.join(sanitizers)
 513     if main['GCC'] or main['CLANG']:
 514         main.Append(CCFLAGS=['-fsanitize=%s' % sanitizers,
 515                              '-fno-omit-frame-pointer'],
 516                     LINKFLAGS='-fsanitize=%s' % sanitizers)
 517     else:
 518         warning("Don't know how to enable %s sanitizer(s) for your "
 519                 "compiler." % sanitizers)
 520
 521 # Set up common yacc/bison flags (needed for Ruby)
 522 main['YACCFLAGS'] = '-d'
 523 main['YACCHXXFILESUFFIX'] = '.hh'
 524
 525 # Do this after we save setting back, or else we'll tack on an
 526 # extra 'qdo' every time we run scons.
 527 if main['BATCH']:
 528     main['CC']     = main['BATCH_CMD'] + ' ' + main['CC']
 529     main['CXX']    = main['BATCH_CMD'] + ' ' + main['CXX']
 530     main['AS']     = main['BATCH_CMD'] + ' ' + main['AS']
 531     main['AR']     = main['BATCH_CMD'] + ' ' + main['AR']
 532     main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB']
 533
 534 if sys.platform == 'cygwin':
 535     # cygwin has some header file issues...
 536     main.Append(CCFLAGS=["-Wno-uninitialized"])
 537
 538
 539 have_pkg_config = readCommand(['pkg-config', '--version'], exception='')
 540
 541 # Check for the protobuf compiler
 542 try:
 543     main['HAVE_PROTOC'] = True
 544     protoc_version = readCommand([main['PROTOC'], '--version']).split()
 545
 546     # First two words should be "libprotoc x.y.z"
 547     if len(protoc_version) < 2 or protoc_version[0] != 'libprotoc':
 548         warning('Protocol buffer compiler (protoc) not found.\n'
 549                 'Please install protobuf-compiler for tracing support.')
 550         main['HAVE_PROTOC'] = False
 551     else:
 552         # Based on the availability of the compress stream wrappers,
 553         # require 2.1.0
 554         min_protoc_version = '2.1.0'
 555         if compareVersions(protoc_version[1], min_protoc_version) < 0:
 556             warning('protoc version', min_protoc_version,
 557                     'or newer required.\n'
 558                     'Installed version:', protoc_version[1])
 559             main['HAVE_PROTOC'] = False
 560         else:
 561             # Attempt to determine the appropriate include path and
 562             # library path using pkg-config, that means we also need to
 563             # check for pkg-config. Note that it is possible to use
 564             # protobuf without the involvement of pkg-config. Later on we
 565             # check go a library config check and at that point the test
 566             # will fail if libprotobuf cannot be found.
 567             if have_pkg_config:
 568                 try:
 569                     # Attempt to establish what linking flags to add for
 570                     # protobuf
 571                     # using pkg-config
 572                     main.ParseConfig(
 573                             'pkg-config --cflags --libs-only-L protobuf')
 574                 except:
 575                     warning('pkg-config could not get protobuf flags.')
 576 except Exception as e:
 577     warning('While checking protoc version:', str(e))
 578     main['HAVE_PROTOC'] = False
 579
 580 # Check for 'timeout' from GNU coreutils. If present, regressions will
 581 # be run with a time limit. We require version 8.13 since we rely on
 582 # support for the '--foreground' option.
 583 if sys.platform.startswith('freebsd'):
 584     timeout_lines = readCommand(['gtimeout', '--version'],
 585                                 exception='').splitlines()
 586 else:
 587     timeout_lines = readCommand(['timeout', '--version'],
 588                                 exception='').splitlines()
 589 # Get the first line and tokenize it
 590 timeout_version = timeout_lines[0].split() if timeout_lines else []
 591 main['TIMEOUT'] =  timeout_version and \
 592     compareVersions(timeout_version[-1], '8.13') >= 0
 593
 594 # Add a custom Check function to test for structure members.
 595 def CheckMember(context, include, decl, member, include_quotes="<>"):
 596     context.Message("Checking for member %s in %s..." %
 597                     (member, decl))
 598     text = """
 599 #include %(header)s
 600 int main(){
 601   %(decl)s test;
 602   (void)test.%(member)s;
 603   return 0;
 604 };
 605 """ % { "header" : include_quotes[0] + include + include_quotes[1],
 606         "decl" : decl,
 607         "member" : member,
 608         }
 609
 610     ret = context.TryCompile(text, extension=".cc")
 611     context.Result(ret)
 612     return ret
 613
 614 # Platform-specific configuration.  Note again that we assume that all
 615 # builds under a given build root run on the same host platform.
 616 conf = Configure(main,
 617                  conf_dir = joinpath(build_root, '.scons_config'),
 618                  log_file = joinpath(build_root, 'scons_config.log'),
 619                  custom_tests = {
 620         'CheckMember' : CheckMember,
 621         })
 622
 623 # Check if we should compile a 64 bit binary on Mac OS X/Darwin
 624 try:
 625     import platform
 626     uname = platform.uname()
 627     if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0:
 628         if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
 629             main.Append(CCFLAGS=['-arch', 'x86_64'])
 630             main.Append(CFLAGS=['-arch', 'x86_64'])
 631             main.Append(LINKFLAGS=['-arch', 'x86_64'])
 632             main.Append(ASFLAGS=['-arch', 'x86_64'])
 633 except:
 634     pass
 635
 636 # Recent versions of scons substitute a "Null" object for Configure()
 637 # when configuration isn't necessary, e.g., if the "--help" option is
 638 # present.  Unfortuantely this Null object always returns false,
 639 # breaking all our configuration checks.  We replace it with our own
 640 # more optimistic null object that returns True instead.
 641 if not conf:
 642     def NullCheck(*args, **kwargs):
 643         return True
 644
 645     class NullConf:
 646         def __init__(self, env):
 647             self.env = env
 648         def Finish(self):
 649             return self.env
 650         def __getattr__(self, mname):
 651             return NullCheck
 652
 653     conf = NullConf(main)
 654
 655 # Cache build files in the supplied directory.
 656 if main['M5_BUILD_CACHE']:
 657     print('Using build cache located at', main['M5_BUILD_CACHE'])
 658     CacheDir(main['M5_BUILD_CACHE'])
 659
 660 main['USE_PYTHON'] = not GetOption('without_python')
 661 if main['USE_PYTHON']:
 662     # Find Python include and library directories for embedding the
 663     # interpreter. We rely on python-config to resolve the appropriate
 664     # includes and linker flags. ParseConfig does not seem to understand
 665     # the more exotic linker flags such as -Xlinker and -export-dynamic so
 666     # we add them explicitly below. If you want to link in an alternate
 667     # version of python, see above for instructions on how to invoke
 668     # scons with the appropriate PATH set.
 669
 670     python_config = main.Detect(main['PYTHON_CONFIG'])
 671     if python_config is None:
 672         error("Can't find a suitable python-config, tried %s" % \
 673               main['PYTHON_CONFIG'])
 674
 675     print("Info: Using Python config: %s" % (python_config, ))
 676     py_includes = readCommand([python_config, '--includes'],
 677                               exception='').split()
 678     py_includes = list(filter(
 679         lambda s: match(r'.*\/include\/.*',s), py_includes))
 680     # Strip the -I from the include folders before adding them to the
 681     # CPPPATH
 682     py_includes = list(map(
 683         lambda s: s[2:] if s.startswith('-I') else s, py_includes))
 684     main.Append(CPPPATH=py_includes)
 685
 686     # Read the linker flags and split them into libraries and other link
 687     # flags. The libraries are added later through the call the CheckLib.
 688     py_ld_flags = readCommand([python_config, '--ldflags'],
 689         exception='').split()
 690     py_libs = []
 691     for lib in py_ld_flags:
 692          if not lib.startswith('-l'):
 693              main.Append(LINKFLAGS=[lib])
 694          else:
 695              lib = lib[2:]
 696              if lib not in py_libs:
 697                  py_libs.append(lib)
 698
 699     # verify that this stuff works
 700     if not conf.CheckHeader('Python.h', '<>'):
 701         error("Check failed for Python.h header in",
 702                 ' '.join(py_includes), "\n"
 703               "Two possible reasons:\n"
 704               "1. Python headers are not installed (You can install the "
 705               "package python-dev on Ubuntu and RedHat)\n"
 706               "2. SCons is using a wrong C compiler. This can happen if "
 707               "CC has the wrong value.\n"
 708               "CC = %s" % main['CC'])
 709
 710     for lib in py_libs:
 711         if not conf.CheckLib(lib):
 712             error("Can't find library %s required by python." % lib)
 713
 714 # On Solaris you need to use libsocket for socket ops
 715 if not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
 716    if not conf.CheckLibWithHeader('socket', 'sys/socket.h',
 717                                   'C++', 'accept(0,0,0);'):
 718        error("Can't find library with socket calls (e.g. accept()).")
 719
 720 # Check for zlib.  If the check passes, libz will be automatically
 721 # added to the LIBS environment variable.
 722 if not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
 723     error('Did not find needed zlib compression library '
 724           'and/or zlib.h header file.\n'
 725           'Please install zlib and try again.')
 726
 727 # If we have the protobuf compiler, also make sure we have the
 728 # development libraries. If the check passes, libprotobuf will be
 729 # automatically added to the LIBS environment variable. After
 730 # this, we can use the HAVE_PROTOBUF flag to determine if we have
 731 # got both protoc and libprotobuf available.
 732 main['HAVE_PROTOBUF'] = main['HAVE_PROTOC'] and \
 733     conf.CheckLibWithHeader('protobuf', 'google/protobuf/message.h',
 734                             'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;')
 735
 736 # Valgrind gets much less confused if you tell it when you're using
 737 # alternative stacks.
 738 main['HAVE_VALGRIND'] = conf.CheckCHeader('valgrind/valgrind.h')
 739
 740 # If we have the compiler but not the library, print another warning.
 741 if main['HAVE_PROTOC'] and not main['HAVE_PROTOBUF']:
 742     warning('Did not find protocol buffer library and/or headers.\n'
 743             'Please install libprotobuf-dev for tracing support.')
 744
 745 # Check for librt.
 746 have_posix_clock = \
 747     conf.CheckLibWithHeader(None, 'time.h', 'C',
 748                             'clock_nanosleep(0,0,NULL,NULL);') or \
 749     conf.CheckLibWithHeader('rt', 'time.h', 'C',
 750                             'clock_nanosleep(0,0,NULL,NULL);')
 751
 752 have_posix_timers = \
 753     conf.CheckLibWithHeader([None, 'rt'], [ 'time.h', 'signal.h' ], 'C',
 754                             'timer_create(CLOCK_MONOTONIC, NULL, NULL);')
 755
 756 if not GetOption('without_tcmalloc'):
 757     if conf.CheckLib('tcmalloc'):
 758         main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS'])
 759     elif conf.CheckLib('tcmalloc_minimal'):
 760         main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS'])
 761     else:
 762         warning("You can get a 12% performance improvement by "
 763                 "installing tcmalloc (libgoogle-perftools-dev package "
 764                 "on Ubuntu or RedHat).")
 765
 766
 767 # Detect back trace implementations. The last implementation in the
 768 # list will be used by default.
 769 backtrace_impls = [ "none" ]
 770
 771 backtrace_checker = 'char temp;' + \
 772     ' backtrace_symbols_fd((void*)&temp, 0, 0);'
 773 if conf.CheckLibWithHeader(None, 'execinfo.h', 'C', backtrace_checker):
 774     backtrace_impls.append("glibc")
 775 elif conf.CheckLibWithHeader('execinfo', 'execinfo.h', 'C',
 776                              backtrace_checker):
 777     # NetBSD and FreeBSD need libexecinfo.
 778     backtrace_impls.append("glibc")
 779     main.Append(LIBS=['execinfo'])
 780
 781 if backtrace_impls[-1] == "none":
 782     default_backtrace_impl = "none"
 783     warning("No suitable back trace implementation found.")
 784
 785 if not have_posix_clock:
 786     warning("Can't find library for POSIX clocks.")
 787
 788 # Check for <fenv.h> (C99 FP environment control)
 789 have_fenv = conf.CheckHeader('fenv.h', '<>')
 790 if not have_fenv:
 791     warning("Header file <fenv.h> not found.\n"
 792             "This host has no IEEE FP rounding mode control.")
 793
 794 # Check for <png.h> (libpng library needed if wanting to dump
 795 # frame buffer image in png format)
 796 have_png = conf.CheckHeader('png.h', '<>')
 797 if not have_png:
 798     warning("Header file <png.h> not found.\n"
 799             "This host has no libpng library.\n"
 800             "Disabling support for PNG framebuffers.")
 801
 802 # Check if we should enable KVM-based hardware virtualization. The API
 803 # we rely on exists since version 2.6.36 of the kernel, but somehow
 804 # the KVM_API_VERSION does not reflect the change. We test for one of
 805 # the types as a fall back.
 806 have_kvm = conf.CheckHeader('linux/kvm.h', '<>')
 807 if not have_kvm:
 808     print("Info: Compatible header file <linux/kvm.h> not found, "
 809           "disabling KVM support.")
 810
 811 # Check if the TUN/TAP driver is available.
 812 have_tuntap = conf.CheckHeader('linux/if_tun.h', '<>')
 813 if not have_tuntap:
 814     print("Info: Compatible header file <linux/if_tun.h> not found.")
 815
 816 # x86 needs support for xsave. We test for the structure here since we
 817 # won't be able to run new tests by the time we know which ISA we're
 818 # targeting.
 819 have_kvm_xsave = conf.CheckTypeSize('struct kvm_xsave',
 820                                     '#include <linux/kvm.h>') != 0
 821
 822 # Check if the requested target ISA is compatible with the host
 823 def is_isa_kvm_compatible(isa):
 824     try:
 825         import platform
 826         host_isa = platform.machine()
 827     except:
 828         warning("Failed to determine host ISA.")
 829         return False
 830
 831     if not have_posix_timers:
 832         warning("Can not enable KVM, host seems to lack support "
 833                 "for POSIX timers")
 834         return False
 835
 836     if isa == "arm":
 837         return host_isa in ( "armv7l", "aarch64" )
 838     elif isa == "x86":
 839         if host_isa != "x86_64":
 840             return False
 841
 842         if not have_kvm_xsave:
 843             warning("KVM on x86 requires xsave support in kernel headers.")
 844             return False
 845
 846         return True
 847     else:
 848         return False
 849
 850
 851 # Check if the exclude_host attribute is available. We want this to
 852 # get accurate instruction counts in KVM.
 853 main['HAVE_PERF_ATTR_EXCLUDE_HOST'] = conf.CheckMember(
 854     'linux/perf_event.h', 'struct perf_event_attr', 'exclude_host')
 855
 856 def check_hdf5():
 857     return \
 858         conf.CheckLibWithHeader('hdf5', 'hdf5.h', 'C',
 859                                 'H5Fcreate("", 0, 0, 0);') and \
 860         conf.CheckLibWithHeader('hdf5_cpp', 'H5Cpp.h', 'C++',
 861                                 'H5::H5File("", 0);')
 862
 863 def check_hdf5_pkg(name):
 864     print("Checking for %s using pkg-config..." % name, end="")
 865     if not have_pkg_config:
 866         print(" pkg-config not found")
 867         return False
 868
 869     try:
 870         main.ParseConfig('pkg-config --cflags-only-I --libs-only-L %s' % name)
 871         print(" yes")
 872         return True
 873     except:
 874         print(" no")
 875         return False
 876
 877 # Check if there is a pkg-config configuration for hdf5. If we find
 878 # it, setup the environment to enable linking and header inclusion. We
 879 # don't actually try to include any headers or link with hdf5 at this
 880 # stage.
 881 if not check_hdf5_pkg('hdf5-serial'):
 882     check_hdf5_pkg('hdf5')
 883
 884 # Check if the HDF5 libraries can be found. This check respects the
 885 # include path and library path provided by pkg-config. We perform
 886 # this check even if there isn't a pkg-config configuration for hdf5
 887 # since some installations don't use pkg-config.
 888 have_hdf5 = check_hdf5()
 889 if not have_hdf5:
 890     print("Warning: Couldn't find any HDF5 C++ libraries. Disabling")
 891     print("         HDF5 support.")
 892
 893 ######################################################################
 894 #
 895 # Finish the configuration
 896 #
 897 main = conf.Finish()
 898
 899 ######################################################################
 900 #
 901 # Collect all non-global variables
 902 #
 903
 904 # Define the universe of supported ISAs
 905 all_isa_list = [ ]
 906 all_gpu_isa_list = [ ]
 907 Export('all_isa_list')
 908 Export('all_gpu_isa_list')
 909
 910 class CpuModel(object):
 911     '''The CpuModel class encapsulates everything the ISA parser needs to
 912     know about a particular CPU model.'''
 913
 914     # Dict of available CPU model objects.  Accessible as CpuModel.dict.
 915     dict = {}
 916
 917     # Constructor.  Automatically adds models to CpuModel.dict.
 918     def __init__(self, name, default=False):
 919         self.name = name           # name of model
 920
 921         # This cpu is enabled by default
 922         self.default = default
 923
 924         # Add self to dict
 925         if name in CpuModel.dict:
 926             raise AttributeError("CpuModel '%s' already registered" % name)
 927         CpuModel.dict[name] = self
 928
 929 Export('CpuModel')
 930
 931 # Sticky variables get saved in the variables file so they persist from
 932 # one invocation to the next (unless overridden, in which case the new
 933 # value becomes sticky).
 934 sticky_vars = Variables(args=ARGUMENTS)
 935 Export('sticky_vars')
 936
 937 # Sticky variables that should be exported
 938 export_vars = []
 939 Export('export_vars')
 940
 941 # For Ruby
 942 all_protocols = []
 943 Export('all_protocols')
 944 protocol_dirs = []
 945 Export('protocol_dirs')
 946 slicc_includes = []
 947 Export('slicc_includes')
 948
 949 # Walk the tree and execute all SConsopts scripts that wil add to the
 950 # above variables
 951 if GetOption('verbose'):
 952     print("Reading SConsopts")
 953 for bdir in [ base_dir ] + extras_dir_list:
 954     if not isdir(bdir):
 955         error("Directory '%s' does not exist." % bdir)
 956     for root, dirs, files in os.walk(bdir):
 957         if 'SConsopts' in files:
 958             if GetOption('verbose'):
 959                 print("Reading", joinpath(root, 'SConsopts'))
 960             SConscript(joinpath(root, 'SConsopts'))
 961
 962 all_isa_list.sort()
 963 all_gpu_isa_list.sort()
 964
 965 sticky_vars.AddVariables(
 966     EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list),
 967     EnumVariable('TARGET_GPU_ISA', 'Target GPU ISA', 'hsail', all_gpu_isa_list),
 968     ListVariable('CPU_MODELS', 'CPU models',
 969                  sorted(n for n,m in CpuModel.dict.items() if m.default),
 970                  sorted(CpuModel.dict.keys())),
 971     BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
 972                  False),
 973     BoolVariable('USE_SSE2',
 974                  'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
 975                  False),
 976     BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock),
 977     BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
 978     BoolVariable('USE_PNG',  'Enable support for PNG images', have_png),
 979     BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability',
 980                  False),
 981     BoolVariable('USE_KVM', 'Enable hardware virtualized (KVM) CPU models',
 982                  have_kvm),
 983     BoolVariable('USE_TUNTAP',
 984                  'Enable using a tap device to bridge to the host network',
 985                  have_tuntap),
 986     BoolVariable('BUILD_GPU', 'Build the compute-GPU model', False),
 987     EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None',
 988                   all_protocols),
 989     EnumVariable('BACKTRACE_IMPL', 'Post-mortem dump implementation',
 990                  backtrace_impls[-1], backtrace_impls),
 991     ('NUMBER_BITS_PER_SET', 'Max elements in set (default 64)',
 992                  64),
 993     BoolVariable('USE_HDF5', 'Enable the HDF5 support', have_hdf5),
 994     )
 995
 996 # These variables get exported to #defines in config/*.hh (see src/SConscript).
 997 export_vars += ['USE_FENV', 'TARGET_ISA', 'TARGET_GPU_ISA', 'CP_ANNOTATE',
 998                 'USE_POSIX_CLOCK', 'USE_KVM', 'USE_TUNTAP', 'PROTOCOL',
 999                 'HAVE_PROTOBUF', 'HAVE_VALGRIND',
1000                 'HAVE_PERF_ATTR_EXCLUDE_HOST', 'USE_PNG',
1001                 'NUMBER_BITS_PER_SET', 'USE_HDF5']
1002
1003 ###################################################
1004 #
1005 # Define a SCons builder for configuration flag headers.
1006 #
1007 ###################################################
1008
1009 # This function generates a config header file that #defines the
1010 # variable symbol to the current variable setting (0 or 1).  The source
1011 # operands are the name of the variable and a Value node containing the
1012 # value of the variable.
1013 def build_config_file(target, source, env):
1014     (variable, value) = [s.get_contents().decode('utf-8') for s in source]
1015     with open(str(target[0]), 'w') as f:
1016         print('#define', variable, value, file=f)
1017     return None
1018
1019 # Combine the two functions into a scons Action object.
1020 config_action = MakeAction(build_config_file, Transform("CONFIG H", 2))
1021
1022 # The emitter munges the source & target node lists to reflect what
1023 # we're really doing.
1024 def config_emitter(target, source, env):
1025     # extract variable name from Builder arg
1026     variable = str(target[0])
1027     # True target is config header file
1028     target = joinpath('config', variable.lower() + '.hh')
1029     val = env[variable]
1030     if isinstance(val, bool):
1031         # Force value to 0/1
1032         val = int(val)
1033     elif isinstance(val, str):
1034         val = '"' + val + '"'
1035
1036     # Sources are variable name & value (packaged in SCons Value nodes)
1037     return ([target], [Value(variable), Value(val)])
1038
1039 config_builder = Builder(emitter = config_emitter, action = config_action)
1040
1041 main.Append(BUILDERS = { 'ConfigFile' : config_builder })
1042
1043 ###################################################
1044 #
1045 # Builders for static and shared partially linked object files.
1046 #
1047 ###################################################
1048
1049 partial_static_builder = Builder(action=SCons.Defaults.LinkAction,
1050                                  src_suffix='$OBJSUFFIX',
1051                                  src_builder=['StaticObject', 'Object'],
1052                                  LINKFLAGS='$PLINKFLAGS',
1053                                  LIBS='')
1054
1055 def partial_shared_emitter(target, source, env):
1056     for tgt in target:
1057         tgt.attributes.shared = 1
1058     return (target, source)
1059 partial_shared_builder = Builder(action=SCons.Defaults.ShLinkAction,
1060                                  emitter=partial_shared_emitter,
1061                                  src_suffix='$SHOBJSUFFIX',
1062                                  src_builder='SharedObject',
1063                                  SHLINKFLAGS='$PSHLINKFLAGS',
1064                                  LIBS='')
1065
1066 main.Append(BUILDERS = { 'PartialShared' : partial_shared_builder,
1067                          'PartialStatic' : partial_static_builder })
1068
1069 def add_local_rpath(env, *targets):
1070     '''Set up an RPATH for a library which lives in the build directory.
1071
1072     The construction environment variable BIN_RPATH_PREFIX should be set to
1073     the relative path of the build directory starting from the location of the
1074     binary.'''
1075     for target in targets:
1076         target = env.Entry(target)
1077         if not isinstance(target, SCons.Node.FS.Dir):
1078             target = target.dir
1079         relpath = os.path.relpath(target.abspath, env['BUILDDIR'])
1080         components = [
1081             '\\$$ORIGIN',
1082             '${BIN_RPATH_PREFIX}',
1083             relpath
1084         ]
1085         env.Append(RPATH=[env.Literal(os.path.join(*components))])
1086
1087 if sys.platform != "darwin":
1088     main.Append(LINKFLAGS=Split('-z origin'))
1089
1090 main.AddMethod(add_local_rpath, 'AddLocalRPATH')
1091
1092 # builds in ext are shared across all configs in the build root.
1093 ext_dir = abspath(joinpath(str(main.root), 'ext'))
1094 ext_build_dirs = []
1095 for root, dirs, files in os.walk(ext_dir):
1096     if 'SConscript' in files:
1097         build_dir = os.path.relpath(root, ext_dir)
1098         ext_build_dirs.append(build_dir)
1099         main.SConscript(joinpath(root, 'SConscript'),
1100                         variant_dir=joinpath(build_root, build_dir))
1101
1102 gdb_xml_dir = joinpath(ext_dir, 'gdb-xml')
1103 Export('gdb_xml_dir')
1104
1105 main.Prepend(CPPPATH=Dir('ext/pybind11/include/'))
1106
1107 ###################################################
1108 #
1109 # This builder and wrapper method are used to set up a directory with
1110 # switching headers. Those are headers which are in a generic location and
1111 # that include more specific headers from a directory chosen at build time
1112 # based on the current build settings.
1113 #
1114 ###################################################
1115
1116 def build_switching_header(target, source, env):
1117     path = str(target[0])
1118     subdir = str(source[0])
1119     dp, fp = os.path.split(path)
1120     dp = os.path.relpath(os.path.realpath(dp),
1121                          os.path.realpath(env['BUILDDIR']))
1122     with open(path, 'w') as hdr:
1123         print('#include "%s/%s/%s"' % (dp, subdir, fp), file=hdr)
1124
1125 switching_header_action = MakeAction(build_switching_header,
1126                                      Transform('GENERATE'))
1127
1128 switching_header_builder = Builder(action=switching_header_action,
1129                                    source_factory=Value,
1130                                    single_source=True)
1131
1132 main.Append(BUILDERS = { 'SwitchingHeader': switching_header_builder })
1133
1134 def switching_headers(self, headers, source):
1135     for header in headers:
1136         self.SwitchingHeader(header, source)
1137
1138 main.AddMethod(switching_headers, 'SwitchingHeaders')
1139
1140 ###################################################
1141 #
1142 # Define build environments for selected configurations.
1143 #
1144 ###################################################
1145
1146 for variant_path in variant_paths:
1147     if not GetOption('silent'):
1148         print("Building in", variant_path)
1149
1150     # Make a copy of the build-root environment to use for this config.
1151     env = main.Clone()
1152     env['BUILDDIR'] = variant_path
1153
1154     # variant_dir is the tail component of build path, and is used to
1155     # determine the build parameters (e.g., 'X86')
1156     (build_root, variant_dir) = splitpath(variant_path)
1157
1158     # Set env variables according to the build directory config.
1159     sticky_vars.files = []
1160     # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
1161     # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
1162     # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
1163     current_vars_file = joinpath(build_root, 'variables', variant_dir)
1164     if isfile(current_vars_file):
1165         sticky_vars.files.append(current_vars_file)
1166         if not GetOption('silent'):
1167             print("Using saved variables file %s" % current_vars_file)
1168     elif variant_dir in ext_build_dirs:
1169         # Things in ext are built without a variant directory.
1170         continue
1171     else:
1172         # Build dir-specific variables file doesn't exist.
1173
1174         # Make sure the directory is there so we can create it later
1175         opt_dir = dirname(current_vars_file)
1176         if not isdir(opt_dir):
1177             mkdir(opt_dir)
1178
1179         # Get default build variables from source tree.  Variables are
1180         # normally determined by name of $VARIANT_DIR, but can be
1181         # overridden by '--default=' arg on command line.
1182         default = GetOption('default')
1183         opts_dir = joinpath(main.root.abspath, 'build_opts')
1184         if default:
1185             default_vars_files = [joinpath(build_root, 'variables', default),
1186                                   joinpath(opts_dir, default)]
1187         else:
1188             default_vars_files = [joinpath(opts_dir, variant_dir)]
1189         existing_files = list(filter(isfile, default_vars_files))
1190         if existing_files:
1191             default_vars_file = existing_files[0]
1192             sticky_vars.files.append(default_vars_file)
1193             print("Variables file %s not found,\n  using defaults in %s"
1194                   % (current_vars_file, default_vars_file))
1195         else:
1196             error("Cannot find variables file %s or 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         warning("<fenv.h> not available; forcing USE_FENV to False in",
1211                 variant_dir + ".")
1212         env['USE_FENV'] = False
1213
1214     if not env['USE_FENV']:
1215         warning("No IEEE FP rounding mode control in", variant_dir + ".\n"
1216                 "FP results may deviate slightly from other platforms.")
1217
1218     if not have_png and env['USE_PNG']:
1219         warning("<png.h> not available; forcing USE_PNG to False in",
1220                 variant_dir + ".")
1221         env['USE_PNG'] = False
1222
1223     if env['USE_PNG']:
1224         env.Append(LIBS=['png'])
1225
1226     if env['EFENCE']:
1227         env.Append(LIBS=['efence'])
1228
1229     if env['USE_KVM']:
1230         if not have_kvm:
1231             warning("Can not enable KVM, host seems to lack KVM support")
1232             env['USE_KVM'] = False
1233         elif not is_isa_kvm_compatible(env['TARGET_ISA']):
1234             print("Info: KVM support disabled due to unsupported host and "
1235                   "target ISA combination")
1236             env['USE_KVM'] = False
1237
1238     if env['USE_TUNTAP']:
1239         if not have_tuntap:
1240             warning("Can't connect EtherTap with a tap device.")
1241             env['USE_TUNTAP'] = False
1242
1243     if env['BUILD_GPU']:
1244         env.Append(CPPDEFINES=['BUILD_GPU'])
1245
1246     # Warn about missing optional functionality
1247     if env['USE_KVM']:
1248         if not main['HAVE_PERF_ATTR_EXCLUDE_HOST']:
1249             warning("perf_event headers lack support for the exclude_host "
1250                     "attribute. KVM instruction counts will be inaccurate.")
1251
1252     # Save sticky variable settings back to current variables file
1253     sticky_vars.Save(current_vars_file, env)
1254
1255     if env['USE_SSE2']:
1256         env.Append(CCFLAGS=['-msse2'])
1257
1258     env.Append(CCFLAGS='$CCFLAGS_EXTRA')
1259     env.Append(LINKFLAGS='$LDFLAGS_EXTRA')
1260
1261     # The src/SConscript file sets up the build rules in 'env' according
1262     # to the configured variables.  It returns a list of environments,
1263     # one for each variant build (debug, opt, etc.)
1264     SConscript('src/SConscript', variant_dir = variant_path, exports = 'env')
1265
1266 # base help text
1267 Help('''
1268 Usage: scons [scons options] [build variables] [target(s)]
1269
1270 Extra scons options:
1271 %(options)s
1272
1273 Global build variables:
1274 %(global_vars)s
1275
1276 %(local_vars)s
1277 ''' % help_texts)
1278
1279 atexit.register(summarize_warnings)