# -*- python -*-
-import sys, os.path, fnmatch
+import sys, os.path
import SENFSCons, senfutil
###########################################################################
env.Help("""
Additional top-level build targets:
-prepare Create all target files not part of the repository
-default Build all default targets (like calling scons with no arguments)
-examples Build all examples
-all_tests Build and run unit tests for all modules
-all_docs Build documentation for all modules
-all Build everything
-install_all Install SENF into $$PREFIX
-deb Build debian source and binary package
-debsrc Build debian source package
-debbin Build debian binary package
-linklint Check links of doxygen documentation with 'linklint'
-fixlinks Fix broken links in doxygen documentation
-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
-
- scons <target>@[<user>@]<host>
+prepare Create all target files not part of the repository
+default Build all default targets (like calling scons with no arguments)
+examples Build all examples
+all_tests Build and run unit tests for all modules
+test_changes Build tests only for files with local changes (queries svn or git)
+all_docs Build documentation for all modules
+all Build everything
+install_all Install SENF into $$PREFIX
+deb Build debian source and binary package
+debsrc Build debian source package
+debbin Build debian binary package
+linklint Check links of doxygen documentation with 'linklint'
+fixlinks Fix broken links in doxygen documentation
+all_valgrinds Run all tests under valgrind/memcheck
+lcov Generate test coverage output in doc/lcov and lcov.info
+
+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.
+
+You may execute targets on a remote host via ssh (if the directory layout is the
+same) by calling
+
+ $ 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
+ Enables unit tests which depend on timing measurements. These
+ unit tests should only be run on a single core and an otherwise
+ idle system.
+
+SENF_WLAN_TEST_INTERFACE
+ WLAN interface to use for testing. The interface should not be
+ actively in use.
+
+SENF_ETH_TEST_INTERFACE
+ Ethernet interface to use for testing. The interface should not
+ be actively in use.
+
+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(
- ENV = { 'PATH' : os.environ.get('PATH'),
- 'HOME' : os.environ.get('HOME'),
- 'SSH_AGENT_PID': os.environ.get('SSH_AGENT_PID'),
- 'SSH_AUTH_SOCK': os.environ.get('SSH_AUTH_SOCK') },
- CLEAN_PATTERNS = [ '*~', '#*#', '*.pyc', 'semantic.cache', '.sconsign*' ],
-
- BUILDDIR = '${FLAVOR and "#/build/$FLAVOR" or "#"}',
- CPPPATH = [ '$BUILDDIR', '#' ],
- LOCALLIBDIR = '$BUILDDIR',
- LIBPATH = [ '$LOCALLIBDIR' ],
- LIBS = [ '$LIBSENF$LIBADDSUFFIX', '$EXTRA_LIBS' ],
- EXTRA_LIBS = [ 'rt', '$BOOSTREGEXLIB', '$BOOSTIOSTREAMSLIB', '$BOOSTSIGNALSLIB',
- '$BOOSTFSLIB' ],
- 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',
- '$CXXFLAGS_' ],
- CXXFLAGS_ = senfutil.BuildTypeOptions('CXXFLAGS'),
- CXXFLAGS_final = [ '-O3' ],
- CXXFLAGS_normal = [ '-O0', '-g' ],
- CXXFLAGS_debug = [ '$CXXFLAGS_normal' ],
-
- CPPDEFINES = [ '$expandLogOption', '$CPPDEFINES_' ],
- expandLogOption = senfutil.expandLogOption,
- CPPDEFINES_ = senfutil.BuildTypeOptions('CPPDEFINES'),
- CPPDEFINES_final = [ ],
- 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_GCC = [ '-finline-limit=5000', '--param', 'inline-unit-growth=60' ],
+ INLINE_OPTS = [ '${str(CXX).split("/")[-1] == "g++" and "$INLINE_OPTS_GCC" or None}' ],
+ CXXFLAGS_CLANG = [ '-Wno-unneeded-internal-declaration' ], # needed for BOOST_PARAMETER_KEYWORD
+ CXXFLAGS = [ '-Wall', '-Woverloaded-virtual', '-Wno-long-long', '$INLINE_OPTS',
+ '-pipe', '$CXXFLAGS_', '-fno-strict-aliasing',
+ "${profile and '-pg' or None}",
+ '${str(CXX).split("/")[-1] == "clang++" and "$CXXFLAGS_CLANG" or None}' ],
+ CXXFLAGS_final = [ '-O3', '-fno-threadsafe-statics','-fno-stack-protector',
+ "${profile and ' ' or '-ffunction-sections'}" ],
+ CXXFLAGS_normal = [ '-O2', '-g' ],
+ CXXFLAGS_debug = [ '-O0', '-g' ],
+
+ CPPDEFINES = [ '$expandLogOption', '$CPPDEFINES_' ],
+ CPPDEFINES_final = [ 'SENF_PPI_NOTRACE', 'NDEBUG',
+ 'BOOST_NO_MT', 'BOOST_DISABLE_ASSERTS', 'BOOST_DISABLE_THREADS' ],
+ CPPDEFINES_normal = [ 'SENF_DEBUG' ],
+ CPPDEFINES_debug = [ '$CPPDEFINES_normal' ],
+
+ LINKFLAGS = [ '-rdynamic', '$LINKFLAGS_', "${profile and '-pg' or None}" ],
+ LINKFLAGS_final = [ "${profile and ' ' or '-Wl,--gc-sections'}" ],
+ LINKFLAGS_normal = [ '-Wl,-S' ],
+ LINKFLAGS_debug = [ '-g' ],
)
-
env.SetDefault(
- LIBSENF = "senf",
- LCOV = "lcov",
- GENHTML = "genhtml",
- SCONSBIN = env.File("#/tools/scons"),
- SCONSARGS = [ '-Q', '-j$CONCURRENCY_LEVEL', 'debug=$debug', 'final=$final' ],
- SCONS = "@$SCONSBIN $SCONSARGS",
- CONCURRENCY_LEVEL = env.GetOption('num_jobs') or 1,
- TOPDIR = env.Dir('#').abspath,
- LIBADDSUFFIX = '${FLAVOR and "_$FLAVOR" or ""}',
- OBJADDSUFFIX = '${LIBADDSUFFIX}',
- FLAVOR = '',
+ 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
+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
+
+SConscript('SConfigure')
+
+# Only add this here, after all configure checks have run
+
+env.Append(LIBS = [ '$LIBSENF$LIBADDSUFFIX',
+ '$BOOSTREGEXLIB', '$BOOSTSIGNALSLIB',
+ '$BOOSTFSLIB', '$BOOSTSYSTEMLIB', '$BOOSTDATETIMELIB' ])
+
+###########################################################################
+
# Create Doxyfile.local otherwise doxygen will barf on this non-existent file
# Create it even when cleaning, to silence the doxygen builder warnings
if not os.path.exists("doclib/Doxyfile.local"):
SConscript("HowTos/SConscript")
SConscript("doclib/SConscript")
if env['sparse_tests']:
- SparseTestHack.build(env, 'test_changes' in COMMAND_LINE_TARGETS)
+ verbose = 'test_changes' in COMMAND_LINE_TARGETS
+ SparseTestHack.build(env, verbose, verbose)
###########################################################################
# Define build targets
'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.Install('${INCLUDEINSTALLDIR}', 'boost')
+env.Install('${INCLUDEINSTALLDIR}', 'boost_ext')
+env.Install('${INCLUDEINSTALLDIR}/senf', 'senf/boost_intrusive')
env.Alias('install_all', env.FindInstalledFiles())
env.Alias('default', DEFAULT_TARGETS)
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
-for test in env.FindAllBoostUnitTests():
- stamp = env.Command(test[0].dir.File('.test-valgrind.stamp'),
- [ test[0].dir.File('.test.bin'), 'tools/valgrind.sup' ],
- [ """valgrind --tool=memcheck
- --error-exitcode=99
- --suppressions=${SOURCES[1]}
- $VALGRINDARGS
- ${SOURCES[0]} $BOOSTTESTARGS;
- [ $$? -ne 99 ] || exit 1""".replace("\n"," "),
- Touch("$TARGET") ])
- alias = env.Command(test[0].dir.File('valgrind'), stamp, [ env.NopAction() ])
- env.Alias('all_valgrinds', alias)
+env.Alias('all_valgrinds')
+if env.get('HAVE_VALGRIND'):
+ for test in env.FindAllBoostUnitTests():
+ stamp = env.Command(test[0].dir.File('.test-valgrind.stamp'),
+ [ test[0].dir.File('.test.bin'), 'tools/valgrind.sup' ],
+ [ """$VALGRIND --tool=memcheck
+ --error-exitcode=1
+ --suppressions=${SOURCES[1]}
+ $VALGRINDARGS
+ ${SOURCES[0]} --result_code=no $BOOSTTESTARGS
+ """.replace("\n"," "),
+ Touch("$TARGET") ])
+ alias = env.Command(test[0].dir.File('valgrind'), stamp, [ env.NopAction() ])
+ env.Alias('all_valgrinds', alias)
### 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") ])
projects / senf.git / blobdiff