SConstruct

# Copyright (C) 2016-2020 Intel Corporation
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted for any purpose (including commercial purposes)
# provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice,
#    this list of conditions, and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice,
#    this list of conditions, and the following disclaimer in the
#    documentation and/or materials provided with the distribution.
#
# 3. In addition, redistributions of modified forms of the source or binary
#    code must carry prominent notices stating that the original code was
#    changed and the date of the change.
#
#  4. All publications or advertising materials mentioning features or use of
#     this software are asked, but not required, to acknowledge that it was
#     developed by Intel Corporation and credit the contributors.
#
# 5. Neither the name of Intel Corporation, nor the name of any Contributor
#    may be used to endorse or promote products derived from this software
#    without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY 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.
"""Build CaRT components"""

import os
import sys

sys.path.insert(0, os.path.join(Dir('#').abspath, "scons_local"))
try:
    from prereq_tools import PreReqComponent
    from env_modules import load_mpi
except ImportError:
    raise ImportError \
          ("\'prereq_tools\' module not found; run \'git submodule update\'")

# Desired compiler flags that will be used if the compiler supports them.
DESIRED_FLAGS = ['-Wno-gnu-designator',
                 '-Wno-missing-braces',
                 '-Wno-gnu-zero-variadic-macro-arguments',
                 '-Wno-tautological-constant-out-of-range-compare']

CART_VERSION = "4.8.0"

def save_build_info(env, prereqs, platform):
    """Save the build information"""

    build_info = prereqs.get_build_info()

    #Save the build info locally
    json_build_vars = '.build_vars-%s.json' % platform
    sh_build_vars = '.build_vars-%s.sh' % platform
    build_info.gen_script(sh_build_vars)
    build_info.save(json_build_vars)

    #Install the build info to the testing directory
    env.InstallAs('$PREFIX/TESTING/.build_vars.sh', sh_build_vars)
    env.InstallAs('$PREFIX/TESTING/.build_vars.json', json_build_vars)

def run_checks(env):
    """Run all configure time checks"""

    cenv = env.Clone()
    cenv.Append(CFLAGS='-Werror')
    config = Configure(cenv)

    if config.CheckHeader('stdatomic.h'):
        env.AppendUnique(CPPDEFINES=['HAVE_STDATOMIC=1'])

    config.Finish()

def scons():
    """Scons function"""
    platform = os.uname()[0]
    opts_file = os.path.join(Dir('#').abspath, 'cart-%s.conf' % platform)

    env = DefaultEnvironment()

    opts = Variables(opts_file)
    prereqs = PreReqComponent(env, opts, arch=platform)
    prereqs.load_definitions(prebuild=['mercury', 'uuid', 'crypto', 'boost'])
    if env.subst("$MPI_PKG") == "":
        load_mpi('openmpi')

    if not env.GetOption('clean'):
        run_checks(env)

    opts.Save(opts_file, env)

    env.Alias('install', '$PREFIX')

    if platform == 'Darwin':
        # generate .so on OSX instead of .dylib
        env.Append(SHLIBSUFFIX='.so')

    AddOption('--with-fault-injection',
              dest='fault-injection',
              action='store_true',
              default=False,
              help='Enable fault injection framework in this build')

    # Compiler options
    env.Append(CCFLAGS=['-g3', '-Wshadow', '-Wall', '-Werror', '-fpic',
                        '-D_GNU_SOURCE'])
    env.Append(CCFLAGS=['-O2', '-pthread'])
    env.Append(CCFLAGS=['-DCART_VERSION=\\"' + CART_VERSION + '\\"'])

    env.Append(CFLAGS=['-std=gnu99'])

    if GetOption("fault-injection"):
        env.Append(CCFLAGS=['-DFAULT_INJECTION=1'])

    if not GetOption('clean'):
        env.AppendIfSupported(CCFLAGS=DESIRED_FLAGS)

        print('c Compiler options: %s %s %s' % (env.get('CC'),
                                                ' '.join(env.get('CFLAGS')),
                                                ' '.join(env.get('CCFLAGS'))))
        print('c++ Compiler options: %s %s' % (env.get('CXX'),
                                               ' '.join(env.get('CCFLAGS'))))

    Export('env', 'prereqs', 'CART_VERSION')
    # generate targets in specific build dir to avoid polluting the source code
    arch_dir = 'build/%s' % platform
    VariantDir(arch_dir, '.', duplicate=0)
    SConscript('%s/src/SConscript' % arch_dir)
    SConscript('%s/test/SConscript' % arch_dir)

    env.Install('$PREFIX/etc', ['utils/memcheck-cart.supp',
                                'utils/fault-inject-cart.yaml'])

    # Put this after all SConscript calls so that any imports they require can
    # be included.
    save_build_info(env, prereqs, platform)

    try:
        #if using SCons 2.4+, provide a more complete help
        Help(opts.GenerateHelpText(env), append=True)
    except TypeError:
        Help(opts.GenerateHelpText(env))

if __name__ == "SCons.Script":
    scons()