X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;f=SConstruct;h=e37a858bfbaa18e24fffe017e0ca3a951f034358;hb=c9f613a84f565494f394d97b7b70cd1de8a0fb3f;hp=3599371c89641c4e2212748cf16f2a1c51a0550b;hpb=a3c81f90556143dc6de1e8114c0a613b4010c05c;p=gem5.git diff --git a/SConstruct b/SConstruct index 3599371c8..e37a858bf 100755 --- a/SConstruct +++ b/SConstruct @@ -1,6 +1,6 @@ # -*- mode:python -*- -# Copyright (c) 2013, 2015-2017 ARM Limited +# Copyright (c) 2013, 2015-2020 ARM Limited # All rights reserved. # # The license below extends only to copyright in the software and shall @@ -39,9 +39,6 @@ # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -# -# Authors: Steve Reinhardt -# Nathan Binkert ################################################### # @@ -49,7 +46,7 @@ # # While in this directory ('gem5'), just type 'scons' to build the default # configuration (see below), or type 'scons build//' -# to build some other configuration (e.g., 'build/ALPHA/gem5.opt' for +# to build some other configuration (e.g., 'build/X86/gem5.opt' for # the optimized full-system version). # # You can build gem5 in a different directory as long as there is a @@ -61,15 +58,15 @@ # # The following two commands are equivalent. The '-u' option tells # scons to search up the directory tree for this SConstruct file. -# % cd /gem5 ; scons build/ALPHA/gem5.debug -# % cd /gem5/build/ALPHA; scons -u gem5.debug +# % cd /gem5 ; scons build/X86/gem5.debug +# % cd /gem5/build/X86; scons -u gem5.debug # # The following two commands are equivalent and demonstrate building # in a directory outside of the source tree. The '-C' option tells # scons to chdir to the specified directory to find this SConstruct # file. -# % cd /gem5 ; scons /local/foo/build/ALPHA/gem5.debug -# % cd /local/foo/build/ALPHA; scons -C /gem5 gem5.debug +# % cd /gem5 ; scons /local/foo/build/X86/gem5.debug +# % cd /local/foo/build/X86; scons -C /gem5 gem5.debug # # You can use 'scons -H' to print scons options. If you're in this # 'gem5' directory (or use -u or -C to tell scons where to find this @@ -81,6 +78,7 @@ from __future__ import print_function # Global Python includes +import atexit import itertools import os import re @@ -97,8 +95,9 @@ from re import match # SCons includes import SCons import SCons.Node +import SCons.Node.FS -from m5.util import compareVersions, readCommand +from m5.util import compareVersions, readCommand, readCommandWithReturn help_texts = { "options" : "", @@ -115,8 +114,8 @@ Export("help_texts") # Help() function, but these two features are incompatible: once # you've overridden the help text using Help(), there's no way to get # at the help texts from AddOptions. See: -# http://scons.tigris.org/issues/show_bug.cgi?id=2356 -# http://scons.tigris.org/issues/show_bug.cgi?id=2611 +# https://github.com/SCons/scons/issues/2356 +# https://github.com/SCons/scons/issues/2611 # This hack lets us extract the help text from AddOptions and # re-inject it via Help(). Ideally someday this bug will be fixed and # we can just use AddOption directly. @@ -139,38 +138,36 @@ AddLocalOption('--colors', dest='use_colors', action='store_true', help="Add color to abbreviated scons output") AddLocalOption('--no-colors', dest='use_colors', action='store_false', help="Don't add color to abbreviated scons output") -AddLocalOption('--with-cxx-config', dest='with_cxx_config', - action='store_true', +AddLocalOption('--with-cxx-config', action='store_true', help="Build with support for C++-based configuration") -AddLocalOption('--default', dest='default', type='string', action='store', +AddLocalOption('--default', help='Override which build_opts file to use for defaults') -AddLocalOption('--ignore-style', dest='ignore_style', action='store_true', +AddLocalOption('--ignore-style', action='store_true', help='Disable style checking hooks') -AddLocalOption('--gold-linker', dest='gold_linker', action='store_true', +AddLocalOption('--gold-linker', action='store_true', help='Use the gold linker') -AddLocalOption('--no-lto', dest='no_lto', action='store_true', +AddLocalOption('--no-lto', action='store_true', help='Disable Link-Time Optimization for fast') -AddLocalOption('--force-lto', dest='force_lto', action='store_true', +AddLocalOption('--force-lto', action='store_true', help='Use Link-Time Optimization instead of partial linking' + ' when the compiler doesn\'t support using them together.') -AddLocalOption('--update-ref', dest='update_ref', action='store_true', - help='Update test reference outputs') -AddLocalOption('--verbose', dest='verbose', action='store_true', +AddLocalOption('--verbose', action='store_true', help='Print full tool command lines') -AddLocalOption('--without-python', dest='without_python', - action='store_true', +AddLocalOption('--without-python', action='store_true', help='Build without Python configuration support') -AddLocalOption('--without-tcmalloc', dest='without_tcmalloc', - action='store_true', +AddLocalOption('--without-tcmalloc', action='store_true', help='Disable linking against tcmalloc') -AddLocalOption('--with-ubsan', dest='with_ubsan', action='store_true', +AddLocalOption('--with-ubsan', action='store_true', help='Build with Undefined Behavior Sanitizer if available') -AddLocalOption('--with-asan', dest='with_asan', action='store_true', +AddLocalOption('--with-asan', action='store_true', help='Build with Address Sanitizer if available') +AddLocalOption('--with-systemc-tests', action='store_true', + help='Build systemc tests') + +from gem5_scons import Transform, error, warning, summarize_warnings if GetOption('no_lto') and GetOption('force_lto'): - print('--no-lto and --force-lto are mutually exclusive') - Exit(1) + error('--no-lto and --force-lto are mutually exclusive') ######################################################################## # @@ -180,7 +177,6 @@ if GetOption('no_lto') and GetOption('force_lto'): main = Environment() -from gem5_scons import Transform from gem5_scons.util import get_termcap termcap = get_termcap() @@ -188,8 +184,7 @@ main_dict_keys = main.Dictionary().keys() # Check that we have a C/C++ compiler if not ('CC' in main_dict_keys and 'CXX' in main_dict_keys): - print("No C++ compiler installed (package g++ on Ubuntu and RedHat)") - Exit(1) + error("No C++ compiler installed (package g++ on Ubuntu and RedHat)") ################################################### # @@ -199,14 +194,14 @@ if not ('CC' in main_dict_keys and 'CXX' in main_dict_keys): ################################################### # Find default configuration & binary. -Default(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug')) +Default(environ.get('M5_DEFAULT_BINARY', 'build/ARM/gem5.debug')) # helper function: find last occurrence of element in list def rfind(l, elt, offs = -1): for i in range(len(l)+offs, 0, -1): if l[i] == elt: return i - raise ValueError, "element not found" + raise ValueError("element not found") # Take a list of paths (or SCons Nodes) and return a list with all # paths made absolute and ~-expanded. Paths will be interpreted @@ -215,23 +210,10 @@ def makePathListAbsolute(path_list, root=GetLaunchDir()): return [abspath(joinpath(root, expanduser(str(p)))) for p in path_list] -def find_first_prog(prog_names): - """Find the absolute path to the first existing binary in prog_names""" - - if not isinstance(prog_names, (list, tuple)): - prog_names = [ prog_names ] - - for p in prog_names: - p = main.WhereIs(p) - if p is not None: - return p - - return None - # Each target must have 'build' in the interior of the path; the # directory below this will determine the build parameters. For -# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we -# recognize that ALPHA_SE specifies the configuration because it +# example, for target 'foo/bar/build/X86/arch/x86/blah.do' we +# recognize that X86 specifies the configuration because it # follow 'build' in the build path. # The funky assignment to "[:]" is needed to replace the list contents @@ -248,16 +230,14 @@ for t in BUILD_TARGETS: try: build_top = rfind(path_dirs, 'build', -2) except: - print("Error: no non-leaf 'build' dir found on target path", t) - Exit(1) + error("No non-leaf 'build' dir found on target path.", t) this_build_root = joinpath('/',*path_dirs[:build_top+1]) if not build_root: build_root = this_build_root else: if this_build_root != build_root: - print("Error: build targets not under same build root\n" + error("build targets not under same build root\n" " %s\n %s" % (build_root, this_build_root)) - Exit(1) variant_path = joinpath('/',*path_dirs[:build_top+2]) if variant_path not in variant_paths: variant_paths.append(variant_path) @@ -279,7 +259,7 @@ main.SetOption('duplicate', 'soft-copy') # # Set up global sticky variables... these are common to an entire build -# tree (not specific to a particular build like ALPHA_SE) +# tree (not specific to a particular build like X86) # global_vars_file = joinpath(build_root, 'variables.global') @@ -289,8 +269,12 @@ global_vars = Variables(global_vars_file, args=ARGUMENTS) global_vars.AddVariables( ('CC', 'C compiler', environ.get('CC', main['CC'])), ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])), + ('CCFLAGS_EXTRA', 'Extra C and C++ compiler flags', ''), + ('LDFLAGS_EXTRA', 'Extra linker flags', ''), + ('MARSHAL_CCFLAGS_EXTRA', 'Extra C and C++ marshal compiler flags', ''), + ('MARSHAL_LDFLAGS_EXTRA', 'Extra marshal linker flags', ''), ('PYTHON_CONFIG', 'Python config binary to use', - [ 'python2.7-config', 'python-config' ]), + [ 'python2.7-config', 'python-config', 'python3-config' ]), ('PROTOC', 'protoc tool', environ.get('PROTOC', 'protoc')), ('BATCH', 'Use batch pool for build and tests', False), ('BATCH_CMD', 'Batch pool submission command name', 'qdo'), @@ -355,8 +339,7 @@ CXX_V = readCommand([main['CXX'],'-V'], exception=False) main['GCC'] = CXX_version and CXX_version.find('g++') >= 0 main['CLANG'] = CXX_version and CXX_version.find('clang') >= 0 if main['GCC'] + main['CLANG'] > 1: - print('Error: How can we have two at the same time?') - Exit(1) + error('Two compilers enabled at once?') # Set up default C++ compiler flags if main['GCC'] or main['CLANG']: @@ -373,11 +356,15 @@ if main['GCC'] or main['CLANG']: main.Append(CCFLAGS=['-I/usr/local/include']) main.Append(CXXFLAGS=['-I/usr/local/include']) + # On Mac OS X/Darwin the default linker doesn't support the + # option --as-needed + if sys.platform != "darwin": + main.Append(LINKFLAGS='-Wl,--as-needed') main['FILTER_PSHLINKFLAGS'] = lambda x: str(x).replace(' -shared', '') main['PSHLINKFLAGS'] = main.subst('${FILTER_PSHLINKFLAGS(SHLINKFLAGS)}') if GetOption('gold_linker'): main.Append(LINKFLAGS='-fuse-ld=gold') - main['PLINKFLAGS'] = main.subst('${LINKFLAGS}') + main['PLINKFLAGS'] = main.get('LINKFLAGS') shared_partial_flags = ['-r', '-nostdlib'] main.Append(PSHLINKFLAGS=shared_partial_flags) main.Append(PLINKFLAGS=shared_partial_flags) @@ -389,23 +376,18 @@ if main['GCC'] or main['CLANG']: '-Wno-error=deprecated', ]) else: - print(termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal, end=' ') - print("Don't know what compiler options to use for your compiler.") - print(termcap.Yellow + ' compiler:' + termcap.Normal, main['CXX']) - print(termcap.Yellow + ' version:' + termcap.Normal, end = ' ') - if not CXX_version: - print(termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" + - termcap.Normal) - else: - print(CXX_version.replace('\n', '')) - print(" If you're trying to use a compiler other than GCC") - print(" or clang, there appears to be something wrong with your") - print(" environment.") - print(" ") - print(" If you are trying to use a compiler other than those listed") - print(" above you will need to ease fix SConstruct and ") - print(" src/SConscript to support that compiler.") - Exit(1) + error('\n'.join(( + "Don't know what compiler options to use for your compiler.", + "compiler: " + main['CXX'], + "version: " + CXX_version.replace('\n', '') if + CXX_version else 'COMMAND NOT FOUND!', + "If you're trying to use a compiler other than GCC", + "or clang, there appears to be something wrong with your", + "environment.", + "", + "If you are trying to use a compiler other than those listed", + "above you will need to ease fix SConstruct and ", + "src/SConscript to support that compiler."))) if main['GCC']: # Check for a supported version of gcc. >= 4.8 is chosen for its @@ -413,8 +395,8 @@ if main['GCC']: # http://gcc.gnu.org/projects/cxx0x.html for details. gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False) if compareVersions(gcc_version, "4.8") < 0: - print('Error: gcc version 4.8 or newer required.') - print(' Installed version: ', gcc_version) + error('gcc version 4.8 or newer required.\n' + 'Installed version:', gcc_version) Exit(1) main['GCC_VERSION'] = gcc_version @@ -441,24 +423,13 @@ if main['GCC']: main.Append(PSHLINKFLAGS='-flinker-output=rel') main.Append(PLINKFLAGS='-flinker-output=rel') - # Make sure we warn if the user has requested to compile with the - # Undefined Benahvior Sanitizer and this version of gcc does not - # support it. - if GetOption('with_ubsan') and \ - compareVersions(gcc_version, '4.9') < 0: - print(termcap.Yellow + termcap.Bold + - 'Warning: UBSan is only supported using gcc 4.9 and later.' + - termcap.Normal) - disable_lto = GetOption('no_lto') if not disable_lto and main.get('BROKEN_INCREMENTAL_LTO', False) and \ not GetOption('force_lto'): - print(termcap.Yellow + termcap.Bold + - 'Warning: Your compiler doesn\'t support incremental linking' + - ' and lto at the same time, so lto is being disabled. To force' + - ' lto on anyway, use the --force-lto option. That will disable' + - ' partial linking.' + - termcap.Normal) + warning('Your compiler doesn\'t support incremental linking and lto ' + 'at the same time, so lto is being disabled. To force lto on ' + 'anyway, use the --force-lto option. That will disable ' + 'partial linking.') disable_lto = True # Add the appropriate Link-Time Optimization (LTO) flags @@ -477,25 +448,6 @@ if main['GCC']: main.Append(TCMALLOC_CCFLAGS=['-fno-builtin-malloc', '-fno-builtin-calloc', '-fno-builtin-realloc', '-fno-builtin-free']) - # The address sanitizer is available for gcc >= 4.8 - if GetOption('with_asan'): - if GetOption('with_ubsan') and \ - compareVersions(main['GCC_VERSION'], '4.9') >= 0: - main.Append(CCFLAGS=['-fsanitize=address,undefined', - '-fno-omit-frame-pointer'], - LINKFLAGS='-fsanitize=address,undefined') - else: - main.Append(CCFLAGS=['-fsanitize=address', - '-fno-omit-frame-pointer'], - LINKFLAGS='-fsanitize=address') - # Only gcc >= 4.9 supports UBSan, so check both the version - # and the command-line option before adding the compiler and - # linker flags. - elif GetOption('with_ubsan') and \ - compareVersions(main['GCC_VERSION'], '4.9') >= 0: - main.Append(CCFLAGS='-fsanitize=undefined') - main.Append(LINKFLAGS='-fsanitize=undefined') - elif main['CLANG']: # Check for a supported version of clang, >= 3.1 is needed to # support similar features as gcc 4.8. See @@ -505,12 +457,10 @@ elif main['CLANG']: if (clang_version_match): clang_version = clang_version_match.groups()[0] if compareVersions(clang_version, "3.1") < 0: - print('Error: clang version 3.1 or newer required.') - print(' Installed version:', clang_version) - Exit(1) + error('clang version 3.1 or newer required.\n' + 'Installed version:', clang_version) else: - print('Error: Unable to determine clang version.') - Exit(1) + error('Unable to determine clang version.') # clang has a few additional warnings that we disable, extraneous # parantheses are allowed due to Ruby's printing of the AST, @@ -523,6 +473,11 @@ elif main['CLANG']: # interchangeably. '-Wno-mismatched-tags', ]) + if compareVersions(clang_version, "10.0") >= 0: + main.Append(CCFLAGS=['-Wno-c99-designator']) + + if compareVersions(clang_version, "8.0") >= 0: + main.Append(CCFLAGS=['-Wno-defaulted-function-deleted']) main.Append(TCMALLOC_CCFLAGS=['-fno-builtin']) @@ -536,40 +491,37 @@ elif main['CLANG']: if sys.platform.startswith('freebsd'): main.Append(LIBS=['thr']) - # We require clang >= 3.1, so there is no need to check any - # versions here. - if GetOption('with_ubsan'): - if GetOption('with_asan'): - main.Append(CCFLAGS=['-fsanitize=address,undefined', - '-fno-omit-frame-pointer'], - LINKFLAGS='-fsanitize=address,undefined') - else: - main.Append(CCFLAGS='-fsanitize=undefined', - LINKFLAGS='-fsanitize=undefined') - - elif GetOption('with_asan'): - main.Append(CCFLAGS=['-fsanitize=address', +# Add sanitizers flags +sanitizers=[] +if GetOption('with_ubsan'): + # Only gcc >= 4.9 supports UBSan, so check both the version + # and the command-line option before adding the compiler and + # linker flags. + if not main['GCC'] or compareVersions(main['GCC_VERSION'], '4.9') >= 0: + sanitizers.append('undefined') +if GetOption('with_asan'): + # Available for gcc >= 4.8 or llvm >= 3.1 both a requirement + # by the build system + sanitizers.append('address') + suppressions_file = Dir('util').File('lsan-suppressions').get_abspath() + suppressions_opt = 'suppressions=%s' % suppressions_file + main['ENV']['LSAN_OPTIONS'] = ':'.join([suppressions_opt, + 'print_suppressions=0']) + print() + warning('To suppress false positive leaks, set the LSAN_OPTIONS ' + 'environment variable to "%s" when running gem5' % + suppressions_opt) + warning('LSAN_OPTIONS=suppressions=%s' % suppressions_opt) + print() +if sanitizers: + sanitizers = ','.join(sanitizers) + if main['GCC'] or main['CLANG']: + main.Append(CCFLAGS=['-fsanitize=%s' % sanitizers, '-fno-omit-frame-pointer'], - LINKFLAGS='-fsanitize=address') - -else: - print(termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal, end=' ') - print("Don't know what compiler options to use for your compiler.") - print(termcap.Yellow + ' compiler:' + termcap.Normal, main['CXX']) - print(termcap.Yellow + ' version:' + termcap.Normal, end=' ') - if not CXX_version: - print(termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" + - termcap.Normal) + LINKFLAGS='-fsanitize=%s' % sanitizers) else: - print(CXX_version.replace('\n', '')) - print(" If you're trying to use a compiler other than GCC") - print(" or clang, there appears to be something wrong with your") - print(" environment.") - print(" ") - print(" If you are trying to use a compiler other than those listed") - print(" above you will need to ease fix SConstruct and ") - print(" src/SConscript to support that compiler.") - Exit(1) + warning("Don't know how to enable %s sanitizer(s) for your " + "compiler." % sanitizers) # Set up common yacc/bison flags (needed for Ruby) main['YACCFLAGS'] = '-d' @@ -588,45 +540,47 @@ if sys.platform == 'cygwin': # cygwin has some header file issues... main.Append(CCFLAGS=["-Wno-uninitialized"]) + +have_pkg_config = readCommand(['pkg-config', '--version'], exception='') + # Check for the protobuf compiler -protoc_version = readCommand([main['PROTOC'], '--version'], - exception='').split() - -# First two words should be "libprotoc x.y.z" -if len(protoc_version) < 2 or protoc_version[0] != 'libprotoc': - print(termcap.Yellow + termcap.Bold + - 'Warning: Protocol buffer compiler (protoc) not found.\n' + - ' Please install protobuf-compiler for tracing support.' + - termcap.Normal) - main['PROTOC'] = False -else: - # Based on the availability of the compress stream wrappers, - # require 2.1.0 - min_protoc_version = '2.1.0' - if compareVersions(protoc_version[1], min_protoc_version) < 0: - print(termcap.Yellow + termcap.Bold + - 'Warning: protoc version', min_protoc_version, - 'or newer required.\n' + - ' Installed version:', protoc_version[1], - termcap.Normal) - main['PROTOC'] = False +try: + main['HAVE_PROTOC'] = True + protoc_version = readCommand([main['PROTOC'], '--version']).split() + + # First two words should be "libprotoc x.y.z" + if len(protoc_version) < 2 or protoc_version[0] != 'libprotoc': + warning('Protocol buffer compiler (protoc) not found.\n' + 'Please install protobuf-compiler for tracing support.') + main['HAVE_PROTOC'] = False else: - # Attempt to determine the appropriate include path and - # library path using pkg-config, that means we also need to - # check for pkg-config. Note that it is possible to use - # protobuf without the involvement of pkg-config. Later on we - # check go a library config check and at that point the test - # will fail if libprotobuf cannot be found. - if readCommand(['pkg-config', '--version'], exception=''): - try: - # Attempt to establish what linking flags to add for protobuf - # using pkg-config - main.ParseConfig('pkg-config --cflags --libs-only-L protobuf') - except: - print(termcap.Yellow + termcap.Bold + - 'Warning: pkg-config could not get protobuf flags.' + - termcap.Normal) - + # Based on the availability of the compress stream wrappers, + # require 2.1.0 + min_protoc_version = '2.1.0' + if compareVersions(protoc_version[1], min_protoc_version) < 0: + warning('protoc version', min_protoc_version, + 'or newer required.\n' + 'Installed version:', protoc_version[1]) + main['HAVE_PROTOC'] = False + else: + # Attempt to determine the appropriate include path and + # library path using pkg-config, that means we also need to + # check for pkg-config. Note that it is possible to use + # protobuf without the involvement of pkg-config. Later on we + # check go a library config check and at that point the test + # will fail if libprotobuf cannot be found. + if have_pkg_config: + try: + # Attempt to establish what linking flags to add for + # protobuf + # using pkg-config + main.ParseConfig( + 'pkg-config --cflags --libs-only-L protobuf') + except: + warning('pkg-config could not get protobuf flags.') +except Exception as e: + warning('While checking protoc version:', str(e)) + main['HAVE_PROTOC'] = False # Check for 'timeout' from GNU coreutils. If present, regressions will # be run with a time limit. We require version 8.13 since we rely on @@ -718,25 +672,39 @@ if main['USE_PYTHON']: # version of python, see above for instructions on how to invoke # scons with the appropriate PATH set. - python_config = find_first_prog(main['PYTHON_CONFIG']) + python_config = main.Detect(main['PYTHON_CONFIG']) if python_config is None: - print("Error: can't find a suitable python-config, tried %s" % \ + error("Can't find a suitable python-config, tried %s" % \ main['PYTHON_CONFIG']) - Exit(1) print("Info: Using Python config: %s" % (python_config, )) py_includes = readCommand([python_config, '--includes'], exception='').split() - py_includes = filter(lambda s: match(r'.*\/include\/.*',s), py_includes) + py_includes = list(filter( + lambda s: match(r'.*\/include\/.*',s), py_includes)) # Strip the -I from the include folders before adding them to the # CPPPATH - py_includes = map(lambda s: s[2:] if s.startswith('-I') else s, py_includes) + py_includes = list(map( + lambda s: s[2:] if s.startswith('-I') else s, py_includes)) main.Append(CPPPATH=py_includes) # Read the linker flags and split them into libraries and other link # flags. The libraries are added later through the call the CheckLib. - py_ld_flags = readCommand([python_config, '--ldflags'], - exception='').split() + # Note: starting in Python 3.8 the --embed flag is required to get the + # -lpython3.8 linker flag + retcode, cmd_stdout = readCommandWithReturn( + [python_config, '--ldflags', '--embed'], exception='') + if retcode != 0: + # If --embed isn't detected then we're running python <3.8 + retcode, cmd_stdout = readCommandWithReturn( + [python_config, '--ldflags'], exception='') + + # Checking retcode again + if retcode != 0: + error("Failing on python-config --ldflags command") + + py_ld_flags = cmd_stdout.split() + py_libs = [] for lib in py_ld_flags: if not lib.startswith('-l'): @@ -748,40 +716,44 @@ if main['USE_PYTHON']: # verify that this stuff works if not conf.CheckHeader('Python.h', '<>'): - print("Error: Check failed for Python.h header in", py_includes) - print("Two possible reasons:") - print("1. Python headers are not installed (You can install the " - "package python-dev on Ubuntu and RedHat)") - print("2. SCons is using a wrong C compiler. This can happen if " - "CC has the wrong value.") - print("CC = %s" % main['CC']) - Exit(1) + error("Check failed for Python.h header in", + ' '.join(py_includes), "\n" + "Two possible reasons:\n" + "1. Python headers are not installed (You can install the " + "package python-dev on Ubuntu and RedHat)\n" + "2. SCons is using a wrong C compiler. This can happen if " + "CC has the wrong value.\n" + "CC = %s" % main['CC']) for lib in py_libs: if not conf.CheckLib(lib): - print("Error: can't find library %s required by python" % lib) - Exit(1) + error("Can't find library %s required by python." % lib) + +main.Prepend(CPPPATH=Dir('ext/pybind11/include/')) +# Bare minimum environment that only includes python +marshal_env = main.Clone() +marshal_env.Append(CCFLAGS='$MARSHAL_CCFLAGS_EXTRA') +marshal_env.Append(LINKFLAGS='$MARSHAL_LDFLAGS_EXTRA') # On Solaris you need to use libsocket for socket ops if not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'): - if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'): - print("Can't find library with socket calls (e.g. accept())") - Exit(1) + if not conf.CheckLibWithHeader('socket', 'sys/socket.h', + 'C++', 'accept(0,0,0);'): + error("Can't find library with socket calls (e.g. accept()).") # Check for zlib. If the check passes, libz will be automatically # added to the LIBS environment variable. if not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'): - print('Error: did not find needed zlib compression library ' - 'and/or zlib.h header file.') - print(' Please install zlib and try again.') - Exit(1) + error('Did not find needed zlib compression library ' + 'and/or zlib.h header file.\n' + 'Please install zlib and try again.') # If we have the protobuf compiler, also make sure we have the # development libraries. If the check passes, libprotobuf will be # automatically added to the LIBS environment variable. After # this, we can use the HAVE_PROTOBUF flag to determine if we have # got both protoc and libprotobuf available. -main['HAVE_PROTOBUF'] = main['PROTOC'] and \ +main['HAVE_PROTOBUF'] = main['HAVE_PROTOC'] and \ conf.CheckLibWithHeader('protobuf', 'google/protobuf/message.h', 'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;') @@ -790,11 +762,9 @@ main['HAVE_PROTOBUF'] = main['PROTOC'] and \ main['HAVE_VALGRIND'] = conf.CheckCHeader('valgrind/valgrind.h') # If we have the compiler but not the library, print another warning. -if main['PROTOC'] and not main['HAVE_PROTOBUF']: - print(termcap.Yellow + termcap.Bold + - 'Warning: did not find protocol buffer library and/or headers.\n' + - ' Please install libprotobuf-dev for tracing support.' + - termcap.Normal) +if main['HAVE_PROTOC'] and not main['HAVE_PROTOBUF']: + warning('Did not find protocol buffer library and/or headers.\n' + 'Please install libprotobuf-dev for tracing support.') # Check for librt. have_posix_clock = \ @@ -813,10 +783,9 @@ if not GetOption('without_tcmalloc'): elif conf.CheckLib('tcmalloc_minimal'): main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS']) else: - print(termcap.Yellow + termcap.Bold + - "You can get a 12% performance improvement by " - "installing tcmalloc (libgoogle-perftools-dev package " - "on Ubuntu or RedHat)." + termcap.Normal) + warning("You can get a 12% performance improvement by " + "installing tcmalloc (libgoogle-perftools-dev package " + "on Ubuntu or RedHat).") # Detect back trace implementations. The last implementation in the @@ -835,26 +804,24 @@ elif conf.CheckLibWithHeader('execinfo', 'execinfo.h', 'C', if backtrace_impls[-1] == "none": default_backtrace_impl = "none" - print(termcap.Yellow + termcap.Bold + - "No suitable back trace implementation found." + - termcap.Normal) + warning("No suitable back trace implementation found.") if not have_posix_clock: - print("Can't find library for POSIX clocks.") + warning("Can't find library for POSIX clocks.") # Check for (C99 FP environment control) have_fenv = conf.CheckHeader('fenv.h', '<>') if not have_fenv: - print("Warning: Header file not found.") - print(" This host has no IEEE FP rounding mode control.") + warning("Header file not found.\n" + "This host has no IEEE FP rounding mode control.") # Check for (libpng library needed if wanting to dump # frame buffer image in png format) have_png = conf.CheckHeader('png.h', '<>') if not have_png: - print("Warning: Header file not found.") - print(" This host has no libpng library.") - print(" Disabling support for PNG framebuffers.") + warning("Header file not found.\n" + "This host has no libpng library.\n" + "Disabling support for PNG framebuffers.") # Check if we should enable KVM-based hardware virtualization. The API # we rely on exists since version 2.6.36 of the kernel, but somehow @@ -882,12 +849,12 @@ def is_isa_kvm_compatible(isa): import platform host_isa = platform.machine() except: - print("Warning: Failed to determine host ISA.") + warning("Failed to determine host ISA.") return False if not have_posix_timers: - print("Warning: Can not enable KVM, host seems to lack support " - "for POSIX timers") + warning("Can not enable KVM, host seems to lack support " + "for POSIX timers") return False if isa == "arm": @@ -897,7 +864,7 @@ def is_isa_kvm_compatible(isa): return False if not have_kvm_xsave: - print("KVM on x86 requires xsave support in kernel headers.") + warning("KVM on x86 requires xsave support in kernel headers.") return False return True @@ -910,6 +877,42 @@ def is_isa_kvm_compatible(isa): main['HAVE_PERF_ATTR_EXCLUDE_HOST'] = conf.CheckMember( 'linux/perf_event.h', 'struct perf_event_attr', 'exclude_host') +def check_hdf5(): + return \ + conf.CheckLibWithHeader('hdf5', 'hdf5.h', 'C', + 'H5Fcreate("", 0, 0, 0);') and \ + conf.CheckLibWithHeader('hdf5_cpp', 'H5Cpp.h', 'C++', + 'H5::H5File("", 0);') + +def check_hdf5_pkg(name): + print("Checking for %s using pkg-config..." % name, end="") + if not have_pkg_config: + print(" pkg-config not found") + return False + + try: + main.ParseConfig('pkg-config --cflags-only-I --libs-only-L %s' % name) + print(" yes") + return True + except: + print(" no") + return False + +# Check if there is a pkg-config configuration for hdf5. If we find +# it, setup the environment to enable linking and header inclusion. We +# don't actually try to include any headers or link with hdf5 at this +# stage. +if not check_hdf5_pkg('hdf5-serial'): + check_hdf5_pkg('hdf5') + +# Check if the HDF5 libraries can be found. This check respects the +# include path and library path provided by pkg-config. We perform +# this check even if there isn't a pkg-config configuration for hdf5 +# since some installations don't use pkg-config. +have_hdf5 = check_hdf5() +if not have_hdf5: + print("Warning: Couldn't find any HDF5 C++ libraries. Disabling") + print(" HDF5 support.") ###################################################################### # @@ -944,7 +947,7 @@ class CpuModel(object): # Add self to dict if name in CpuModel.dict: - raise AttributeError, "CpuModel '%s' already registered" % name + raise AttributeError("CpuModel '%s' already registered" % name) CpuModel.dict[name] = self Export('CpuModel') @@ -973,8 +976,7 @@ if GetOption('verbose'): print("Reading SConsopts") for bdir in [ base_dir ] + extras_dir_list: if not isdir(bdir): - print("Error: directory '%s' does not exist" % bdir) - Exit(1) + error("Directory '%s' does not exist." % bdir) for root, dirs, files in os.walk(bdir): if 'SConsopts' in files: if GetOption('verbose'): @@ -985,24 +987,19 @@ all_isa_list.sort() all_gpu_isa_list.sort() sticky_vars.AddVariables( - EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list), - EnumVariable('TARGET_GPU_ISA', 'Target GPU ISA', 'hsail', all_gpu_isa_list), + EnumVariable('TARGET_ISA', 'Target ISA', 'null', all_isa_list), + EnumVariable('TARGET_GPU_ISA', 'Target GPU ISA', 'gcn3', all_gpu_isa_list), ListVariable('CPU_MODELS', 'CPU models', - sorted(n for n,m in CpuModel.dict.iteritems() if m.default), + sorted(n for n,m in CpuModel.dict.items() if m.default), sorted(CpuModel.dict.keys())), BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger', False), - BoolVariable('SS_COMPATIBLE_FP', - 'Make floating-point results compatible with SimpleScalar', - False), BoolVariable('USE_SSE2', 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts', False), BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock), BoolVariable('USE_FENV', 'Use IEEE mode control', have_fenv), BoolVariable('USE_PNG', 'Enable support for PNG images', have_png), - BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', - False), BoolVariable('USE_KVM', 'Enable hardware virtualized (KVM) CPU models', have_kvm), BoolVariable('USE_TUNTAP', @@ -1012,14 +1009,18 @@ sticky_vars.AddVariables( EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None', all_protocols), EnumVariable('BACKTRACE_IMPL', 'Post-mortem dump implementation', - backtrace_impls[-1], backtrace_impls) + backtrace_impls[-1], backtrace_impls), + ('NUMBER_BITS_PER_SET', 'Max elements in set (default 64)', + 64), + BoolVariable('USE_HDF5', 'Enable the HDF5 support', have_hdf5), ) # These variables get exported to #defines in config/*.hh (see src/SConscript). -export_vars += ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'TARGET_GPU_ISA', - 'CP_ANNOTATE', 'USE_POSIX_CLOCK', 'USE_KVM', 'USE_TUNTAP', - 'PROTOCOL', 'HAVE_PROTOBUF', 'HAVE_VALGRIND', - 'HAVE_PERF_ATTR_EXCLUDE_HOST', 'USE_PNG'] +export_vars += ['USE_FENV', 'TARGET_ISA', 'TARGET_GPU_ISA', + 'USE_POSIX_CLOCK', 'USE_KVM', 'USE_TUNTAP', 'PROTOCOL', + 'HAVE_PROTOBUF', 'HAVE_VALGRIND', + 'HAVE_PERF_ATTR_EXCLUDE_HOST', 'USE_PNG', + 'NUMBER_BITS_PER_SET', 'USE_HDF5'] ################################################### # @@ -1032,10 +1033,9 @@ export_vars += ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'TARGET_GPU_ISA', # operands are the name of the variable and a Value node containing the # value of the variable. def build_config_file(target, source, env): - (variable, value) = [s.get_contents() for s in source] - f = file(str(target[0]), 'w') - print('#define', variable, value, file=f) - f.close() + (variable, value) = [s.get_contents().decode('utf-8') for s in source] + with open(str(target[0]), 'w') as f: + print('#define', variable, value, file=f) return None # Combine the two functions into a scons Action object. @@ -1096,7 +1096,7 @@ def add_local_rpath(env, *targets): binary.''' for target in targets: target = env.Entry(target) - if not target.isdir(): + if not isinstance(target, SCons.Node.FS.Dir): target = target.dir relpath = os.path.relpath(target.abspath, env['BUILDDIR']) components = [ @@ -1124,8 +1124,6 @@ for root, dirs, files in os.walk(ext_dir): gdb_xml_dir = joinpath(ext_dir, 'gdb-xml') Export('gdb_xml_dir') -main.Prepend(CPPPATH=Dir('ext/pybind11/include/')) - ################################################### # # This builder and wrapper method are used to set up a directory with @@ -1174,7 +1172,7 @@ for variant_path in variant_paths: env['BUILDDIR'] = variant_path # variant_dir is the tail component of build path, and is used to - # determine the build parameters (e.g., 'ALPHA_SE') + # determine the build parameters (e.g., 'X86') (build_root, variant_dir) = splitpath(variant_path) # Set env variables according to the build directory config. @@ -1208,15 +1206,14 @@ for variant_path in variant_paths: joinpath(opts_dir, default)] else: default_vars_files = [joinpath(opts_dir, variant_dir)] - existing_files = filter(isfile, default_vars_files) + existing_files = list(filter(isfile, default_vars_files)) if existing_files: default_vars_file = existing_files[0] sticky_vars.files.append(default_vars_file) print("Variables file %s not found,\n using defaults in %s" % (current_vars_file, default_vars_file)) else: - print("Error: cannot find variables file %s or " - "default file(s) %s" + error("Cannot find variables file %s or default file(s) %s" % (current_vars_file, ' or '.join(default_vars_files))) Exit(1) @@ -1230,18 +1227,17 @@ for variant_path in variant_paths: # Process variable settings. if not have_fenv and env['USE_FENV']: - print("Warning: not available; " - "forcing USE_FENV to False in", variant_dir + ".") + warning(" not available; forcing USE_FENV to False in", + variant_dir + ".") env['USE_FENV'] = False if not env['USE_FENV']: - print("Warning: No IEEE FP rounding mode control in", - variant_dir + ".") - print(" FP results may deviate slightly from other platforms.") + warning("No IEEE FP rounding mode control in", variant_dir + ".\n" + "FP results may deviate slightly from other platforms.") if not have_png and env['USE_PNG']: - print("Warning: not available; " - "forcing USE_PNG to False in", variant_dir + ".") + warning(" not available; forcing USE_PNG to False in", + variant_dir + ".") env['USE_PNG'] = False if env['USE_PNG']: @@ -1252,8 +1248,7 @@ for variant_path in variant_paths: if env['USE_KVM']: if not have_kvm: - print("Warning: Can not enable KVM, host seems to " - "lack KVM support") + warning("Can not enable KVM, host seems to lack KVM support") env['USE_KVM'] = False elif not is_isa_kvm_compatible(env['TARGET_ISA']): print("Info: KVM support disabled due to unsupported host and " @@ -1262,7 +1257,7 @@ for variant_path in variant_paths: if env['USE_TUNTAP']: if not have_tuntap: - print("Warning: Can't connect EtherTap with a tap device.") + warning("Can't connect EtherTap with a tap device.") env['USE_TUNTAP'] = False if env['BUILD_GPU']: @@ -1271,9 +1266,8 @@ for variant_path in variant_paths: # Warn about missing optional functionality if env['USE_KVM']: if not main['HAVE_PERF_ATTR_EXCLUDE_HOST']: - print("Warning: perf_event headers lack support for the " - "exclude_host attribute. KVM instruction counts will " - "be inaccurate.") + warning("perf_event headers lack support for the exclude_host " + "attribute. KVM instruction counts will be inaccurate.") # Save sticky variable settings back to current variables file sticky_vars.Save(current_vars_file, env) @@ -1281,10 +1275,14 @@ for variant_path in variant_paths: if env['USE_SSE2']: env.Append(CCFLAGS=['-msse2']) + env.Append(CCFLAGS='$CCFLAGS_EXTRA') + env.Append(LINKFLAGS='$LDFLAGS_EXTRA') + # The src/SConscript file sets up the build rules in 'env' according # to the configured variables. It returns a list of environments, # one for each variant build (debug, opt, etc.) - SConscript('src/SConscript', variant_dir = variant_path, exports = 'env') + SConscript('src/SConscript', variant_dir=variant_path, + exports=['env', 'marshal_env']) # base help text Help(''' @@ -1298,3 +1296,5 @@ Global build variables: %(local_vars)s ''' % help_texts) + +atexit.register(summarize_warnings)