# -*- python -*-
-import sys, os.path, fnmatch
-import SENFSCons, senfutil, senfconf
-
+import sys, os.path
+import SENFSCons, senfutil
###########################################################################
# Load utilities and setup libraries and configure build
all_valgrinds Run all tests under valgrind/memcheck
lcov Generate test coverage output in doc/lcov and lcov.info
-You may execute targets on a remote host (if the directory layout is the same)
-by calling
+The following additional targets may be called within subdirectories, either
+using '$ scons -u <target>' or '$ scons <directory>/<target>:
+
+test Build and run unit test for this module
+doc Build the documentation of this module
+valgrind Run the unit test of this module under valgrind
+
+When cleaning up using '$ scons -c <target>', some targets are handled specially:
+
+all Remove everything generated by the build including temporary and
+ backup files
+
+some Remove all files not needed for building like temporary or backup
+ files. This target is only valid when called as clean target.
- scons <target>@[<user>@]<host>
+You may execute targets on a remote host via ssh (if the directory layout is the
+same) by calling
-Some more elaborate unit tests may be enabled by setting appropritate variables
+ $ scons <target>@[<user>@]<host>
+
+Some more elaborate unit tests may be enabled by setting appropritate variables
in the shell (unix) environment
SENF_TIMING_CRITICAL_TESTS
Some unit tests will only run when executed to 'root'.
""")
+env.Replace(
+ expandLogOption = senfutil.expandLogOption,
+ CXXFLAGS_ = env.BuildTypeOptions('CXXFLAGS'),
+ CPPDEFINES_ = env.BuildTypeOptions('CPPDEFINES'),
+ LINKFLAGS_ = env.BuildTypeOptions('LINKFLAGS'),
+)
env.Append(
- IMPORT_ENV = [ 'PATH', 'HOME', 'SSH_*', 'SENF*', 'CCACHE_*', 'DISTCC_*' ],
-
- CLEAN_PATTERNS = [ '*~', '#*#', '*.pyc', 'semantic.cache', '.sconsign*',
- '.sconf_temp' ],
-
- BUILDDIR = '${FLAVOR and "#/build/$FLAVOR" or "#"}',
- CPPPATH = [ '#', '$BUILDDIR',
- '${NEED_BOOST_EXT and "#/boost_ext" or None}' ],
- LOCALLIBDIR = '$BUILDDIR',
- LIBPATH = [ '$LOCALLIBDIR' ],
- LIBS = [ '$EXTRA_LIBS' ],
- EXTRA_LIBS = [ 'rt' ],
- TEST_EXTRA_LIBS = [ ],
- VALGRINDARGS = [ '--num-callers=50' ],
-
- PREFIX = '#/dist',
- LIBINSTALLDIR = '$PREFIX${syslayout and "/lib" or ""}',
- BININSTALLDIR = '$PREFIX${syslayout and "/bin" or ""}',
- INCLUDEINSTALLDIR = '$PREFIX${syslayout and "/include" or ""}',
- CONFINSTALLDIR = '${syslayout and "$LIBINSTALLDIR/senf" or "$PREFIX"}',
- OBJINSTALLDIR = '$CONFINSTALLDIR',
- DOCINSTALLDIR = '$PREFIX${syslayout and "/share/doc/senf" or "/manual"}',
- SCONSINSTALLDIR = '$CONFINSTALLDIR/site_scons',
-
- CPP_INCLUDE_EXTENSIONS = [ '.h', '.hh', '.ih', '.mpp', '.cci', '.ct', '.cti' ],
- CPP_EXCLUDE_EXTENSIONS = [ '.test.hh' ],
-
- # These options are insane. Only useful for inline debugging. Need at least 1G free RAM
- INLINE_OPTS_DEBUG = [ '-finline-limit=20000', '-fvisibility-inlines-hidden',
- '-fno-inline-functions', '-Winline'
- '--param','large-function-growth=10000',
- '--param', 'large-function-insns=10000',
- '--param','inline-unit-growth=10000' ],
- INLINE_OPTS_NORMAL = [ '-finline-limit=5000' ],
- INLINE_OPTS = [ '$INLINE_OPTS_NORMAL' ],
- CXXFLAGS = [ '-Wall', '-Woverloaded-virtual', '-Wno-long-long', '$INLINE_OPTS',
- '-pipe', '$CXXFLAGS_', '-fno-strict-aliasing' ],
- CXXFLAGS_ = senfutil.BuildTypeOptions('CXXFLAGS'),
- CXXFLAGS_final = [ '-O3' ],
- CXXFLAGS_normal = [ '-O2', '-g' ],
- CXXFLAGS_debug = [ '-O0', '-g' ],
-
- CPPDEFINES = [ '$expandLogOption', '$CPPDEFINES_' ],
- expandLogOption = senfutil.expandLogOption,
- CPPDEFINES_ = senfutil.BuildTypeOptions('CPPDEFINES'),
- CPPDEFINES_final = [ 'SENF_PPI_NOTRACE'],
- CPPDEFINES_normal = [ 'SENF_DEBUG' ],
- CPPDEFINES_debug = [ '$CPPDEFINES_normal' ],
-
- LINKFLAGS = [ '-rdynamic', '$LINKFLAGS_' ],
- LINKFLAGS_ = senfutil.BuildTypeOptions('LINKFLAGS'),
- LINKFLAGS_final = [ ],
- LINKFLAGS_normal = [ '-Wl,-S' ],
- LINKFLAGS_debug = [ '-g' ],
+ IMPORT_ENV = [ 'PATH', 'HOME', 'SSH_*', 'SENF*', 'CCACHE_*', 'DISTCC_*' ],
+
+ CLEAN_SOME_PATTERNS = [ '*~', '#*#', '*.pyc', 'semantic.cache' ],
+ CLEAN_PATTERNS = [ '.sconsign*', '.sconf_temp' ],
+
+ CPPPATH = [ '#', '$BUILDDIR',
+ '${NEED_BOOST_EXT and "#/boost_ext" or None}' ],
+ LIBPATH = [ '$LOCALLIBDIR' ],
+ LIBS = [ '$EXTRA_LIBS' ],
+ EXTRA_LIBS = [ 'rt' ],
+ TEST_EXTRA_LIBS = [ ],
+ VALGRINDARGS = [ '--num-callers=50' ],
+
+ CPP_INCLUDE_EXTENSIONS = [ '.h', '.hh', '.ih', '.mpp', '.cci', '.ct', '.cti' ],
+ CPP_EXCLUDE_EXTENSIONS = [ '.test.hh' ],
+
+ # INLINE_OPTS_DEBUG are insane. Only useful for inline debugging. Need at least 1G free RAM
+ INLINE_OPTS_DEBUG = [ '-finline-limit=20000', '-fvisibility-inlines-hidden',
+ '-fno-inline-functions', '-Winline'
+ '--param','large-function-growth=10000',
+ '--param', 'large-function-insns=10000',
+ '--param','inline-unit-growth=10000' ],
+ INLINE_OPTS_NORMAL = [ '-finline-limit=5000', '--param', 'inline-unit-growth=60' ],
+ INLINE_OPTS = [ '$INLINE_OPTS_NORMAL' ],
+ CXXFLAGS = [ '-Wall', '-Woverloaded-virtual', '-Wno-long-long', '$INLINE_OPTS',
+ '-pipe', '$CXXFLAGS_', '-fno-strict-aliasing',
+ "${profile and '-pg' or None}" ],
+ CXXFLAGS_final = [ '-O3' ],
+ CXXFLAGS_normal = [ '-O2', '-g' ],
+ CXXFLAGS_debug = [ '-O0', '-g' ],
+
+ CPPDEFINES = [ '$expandLogOption', '$CPPDEFINES_' ],
+ CPPDEFINES_final = [ 'SENF_PPI_NOTRACE', 'BOOST_NO_MT', 'NDEBUG', 'BOOST_DISABLE_ASSERTS' ],
+ CPPDEFINES_normal = [ 'SENF_DEBUG' ],
+ CPPDEFINES_debug = [ '$CPPDEFINES_normal' ],
+
+ LINKFLAGS = [ '-rdynamic', '$LINKFLAGS_', "${profile and '-pg' or None}" ],
+ LINKFLAGS_final = [ ],
+ LINKFLAGS_normal = [ '-Wl,-S' ],
+ LINKFLAGS_debug = [ '-g' ],
)
-
env.SetDefault(
- LIBSENF = "senf",
- LCOV = "lcov",
- GENHTML = "genhtml",
- VALGRIND = "valgrind",
- SCONSBIN = env.File("#/tools/scons"),
- SCONSARGS = [ '-Q', '-j$CONCURRENCY_LEVEL', 'debug=$debug', 'final=$final' ] + \
- [ '%s=%s' % (k,v) for k,v in ARGUMENTS.iteritems() ],
- SCONS = "@$SCONSBIN $SCONSARGS",
- CONCURRENCY_LEVEL = env.GetOption('num_jobs') or 1,
- TOPDIR = env.Dir('#').abspath,
- LIBADDSUFFIX = '${FLAVOR and "_$FLAVOR" or ""}',
- OBJADDSUFFIX = '${LIBADDSUFFIX}',
- FLAVOR = '',
-)
-
-env.Replace(
- _defines = senfutil.expandDefines
+ PREFIX = '#/dist',
+ LIBINSTALLDIR = '$PREFIX${syslayout and "/lib" or ""}',
+ BININSTALLDIR = '$PREFIX${syslayout and "/bin" or ""}',
+ INCLUDEINSTALLDIR = '$PREFIX${syslayout and "/include" or ""}',
+ CONFINSTALLDIR = '${syslayout and "$LIBINSTALLDIR/senf" or "$PREFIX"}',
+ OBJINSTALLDIR = '$CONFINSTALLDIR',
+ DOCINSTALLDIR = '$PREFIX${syslayout and "/share/doc/senf" or "/manual"}',
+ SCONSINSTALLDIR = '$CONFINSTALLDIR/site_scons',
+
+ BUILDDIR = '${FLAVOR and "#/build/$FLAVOR" or "#"}',
+ LOCALLIBDIR = '$BUILDDIR',
+
+ LIBSENF = "senf",
+ LCOV = "lcov",
+ GENHTML = "genhtml",
+ VALGRIND = "valgrind",
+ SCONSBIN = env.File("#/tools/scons"),
+ SCONSARGS = ([ '-Q', '-j$CONCURRENCY_LEVEL' ] +
+ [ '%s=%s' % (k,v) for k,v in ARGLIST ]),
+ SCONS = "@$SCONSBIN $SCONSARGS",
+ CONCURRENCY_LEVEL = env.GetOption('num_jobs') or 1,
+ TOPDIR = env.Dir('#').abspath,
+ LIBADDSUFFIX = '${FLAVOR and "_$FLAVOR" or ""}',
+ OBJADDSUFFIX = '${LIBADDSUFFIX}',
+ FLAVOR = '',
+
+ PARSEFLAGS = '',
)
# Set variables from command line
env,
BoolVariable('final', 'Build final (optimized) build', False),
BoolVariable('debug', 'Link in debug symbols', False),
+ BoolVariable('profile', 'compile and link with the profiling enabled option', False),
BoolVariable('syslayout', 'Install in to system layout directories (lib/, include/ etc)', False),
BoolVariable('sparse_tests', 'Link tests against object files and not the senf lib', False)
)
# Add UNIX env vars matching IMPORT_ENV patterns into the execution environment
-env.Append( ENV = dict(( (k,v)
- for pattern in env['IMPORT_ENV']
- for k,v in os.environ.iteritems()
- if fnmatch.fnmatchcase(k,pattern) )) )
+senfutil.importProcessEnv(env)
+# Handle 'test_changes'
if 'test_changes' in COMMAND_LINE_TARGETS and not env.has_key('only_tests'):
import SparseTestHack
env['only_tests'] = " ".join(x.abspath for x in SparseTestHack.findSCMChanges(env))
if env.has_key('only_tests') : env['sparse_tests'] = True
+
Export('env')
###########################################################################
# Configure
-@senfconf.Test
-def CheckValgrind(context):
- context.Message( "Checking for valgrind... " )
- ret = context.TryAction(['$VALGRIND --version >$TARGET'])
- context.Result( ret[1].strip() or False )
- return ret[0]
-
-@senfconf.Test
-def CheckValgrindWildcards(context):
- context.Message( "Checking whether valgrind supports '...' wildcards in suppressions... " )
- ret = context.TryAction(['$VALGRIND --suppressions=$SOURCE /bin/true'],
- "{\n test_suppression\n Memcheck:Addr4\n ...\n fun:foo\n}\n",
- ".sup")
- context.Result( ret[0] )
- return ret[0]
-
-# Default configuration (boost stuff)
-senfutil.Configure(env)
-
-conf = env.Configure(clean=False, help=False, custom_tests = senfconf.Tests())
-env.Replace(
- HAVE_VALGRIND = conf.CheckValgrind() and conf.CheckValgrindWildcards()
-)
-conf.Finish()
+SConscript('SConfigure')
# Only add this here, after all configure checks have run
env.Append(LIBS = '$LIBSENF$LIBADDSUFFIX',
- EXTRA_LIBS = [ '$BOOSTREGEXLIB', '$BOOSTIOSTREAMSLIB', '$BOOSTSIGNALSLIB',
+ EXTRA_LIBS = [ '$BOOSTREGEXLIB', '$BOOSTSIGNALSLIB',
'$BOOSTFSLIB' ])
###########################################################################
#### install_all, default, all_tests, all
env.Install('${SCONSINSTALLDIR}', [ 'site_scons/__init__.py',
'site_scons/senfutil.py',
- 'site_scons/senfconf.py',
'site_scons/yaptu.py' ])
env.InstallDir('${SCONSINSTALLDIR}', [ 'site_scons/site_tools', 'site_scons/lib' ],
FILTER_SUFFIXES=[ '','.css','.pl','.py','.sh','.sty','.xml','.xsl','.yap' ])
env.Alias('test_changes', 'all_tests')
env.Alias('all', [ 'default', 'all_tests', 'examples', 'all_docs' ])
-#### prepare
+#### prepare and -c some
env.PhonyTarget('prepare', [], [])
+env.PhonyTarget('some', [], [])
#### valgrind
env.Alias('all_valgrinds')
-if env['HAVE_VALGRIND']:
+if env.get('HAVE_VALGRIND'):
for test in env.FindAllBoostUnitTests():
- stamp = env.Command(test[0].dir.File('.test-valgrind.stamp'),
+ stamp = env.Command(test[0].dir.File('.test-valgrind.stamp'),
[ test[0].dir.File('.test.bin'), 'tools/valgrind.sup' ],
- [ """$VALGRIND --tool=memcheck
+ [ """$VALGRIND --tool=memcheck
--error-exitcode=1
--suppressions=${SOURCES[1]}
$VALGRINDARGS
### lcov
env.PhonyTarget('lcov', [], [
- '$SCONS debug=1 BUILDDIR="#/build/lcov" CCFLAGS+="-fprofile-arcs -ftest-coverage" LIBS+="gcov" all_tests',
- '$LCOV --follow --directory $TOPDIR/build/lcov/senf --capture --output-file /tmp/senf_lcov.info --base-directory $TOPDIR',
- '$LCOV --output-file lcov.info --remove /tmp/senf_lcov.info "*/include/*" "*/boost/*" "*.test.*" ',
- '$GENHTML --output-directory doc/lcov --title all_tests lcov.info',
+ '$SCONS'
+ ' debug=1'
+ ' BUILDDIR="#/build/lcov"'
+ ' CCFLAGS+="-fprofile-arcs -ftest-coverage"'
+ ' LIBS+="gcov"'
+ ' all_tests',
+ '$LCOV'
+ ' --follow'
+ ' --directory $TOPDIR/build/lcov/senf'
+ ' --capture'
+ ' --output-file /tmp/senf_lcov.info'
+ ' --base-directory $TOPDIR',
+ '$LCOV'
+ ' --output-file lcov.info'
+ ' --remove /tmp/senf_lcov.info "*/include/*" "*/boost/*" "*.test.*"',
+ '$GENHTML'
+ ' --output-directory doc/lcov'
+ ' --title all_tests lcov.info',
'rm /tmp/senf_lcov.info' ])
-if env.GetOption('clean'):
- env.Clean('lcov', [ os.path.join(path,f)
- for path, subdirs, files in os.walk('.')
- for pattern in ('*.gcno', '*.gcda', '*.gcov')
- for f in fnmatch.filter(files,pattern) ] +
- [ 'lcov.info', env.Dir('doc/lcov'), env.Dir('build/lcov') ])
-
+senfutil.CleanGlob(env, ['lcov','some','all'], [ '*.gcno', '*.gcda', '*.gcov' ])
+env.Clean(['lcov', 'all'], [ 'lcov.info', env.Dir('doc/lcov'), env.Dir('build/lcov') ])
+
#### clean
+
env.Clean('all', ('.prepare-stamp', env.Dir('dist'), env.Dir('build')))
-if env.GetOption('clean') : env.Depends('all', ('lcov', 'all_valgrinds'))
+
+senfutil.CleanGlob(env, 'all', '$CLEAN_PATTERNS')
+senfutil.CleanGlob(env, ['some', 'all'], '$CLEAN_SOME_PATTERNS')
if env.GetOption('clean') and 'all' in BUILD_TARGETS:
- env.Clean('all', [ os.path.join(path,f)
- for path, subdirs, files in os.walk('.')
- for pattern in env['CLEAN_PATTERNS']
- for f in fnmatch.filter(files,pattern) ])
+ env.Depends('all', ('lcov', 'all_valgrinds'))
# Disable writing to the deleted .sconsign file
import SCons.SConsign
SCons.SConsign.write = lambda : None
args.append('-u')
env.PhonyTarget(target, [], [ "ssh $HOST scons $SCONSARGS -C $DIR $RTARGET" ],
HOST=host, RTARGET=realtarget, DIR=cwd, SCONSARGS=args)
+
+env.PhonyTarget('clean', [], [
+ lambda **args: sys.stderr.write(
+ "=================================================================\n"
+ "'clean' is not a valid target, use the '-c' option instead:\n"
+ " $ scons -c all\n"
+ "=================================================================\n") ])