X-Git-Url: http://g0dil.de/git?p=senf.git;a=blobdiff_plain;f=SConstruct;h=8566c0f91fb9cfb50203a2feb6dbce2ab9937db8;hp=f56ce4fc0181b3adcf733d368f0c416a25ed24f7;hb=HEAD;hpb=3b28ce6a5f2029bdf2fba77f46e2aff31eef7f33 diff --git a/SConstruct b/SConstruct index f56ce4f..8566c0f 100644 --- a/SConstruct +++ b/SConstruct @@ -1,6 +1,6 @@ # -*- python -*- -import sys, glob, os.path, fnmatch +import sys, os.path import SENFSCons, senfutil ########################################################################### @@ -8,120 +8,195 @@ import SENFSCons, senfutil env = Environment() +env.Decider('MD5-timestamp') +env.EnsureSConsVersion(1,2) + # Load all the local SCons tools -env.Tool('Doxygen') -env.Tool('Dia2Png') -env.Tool('PkgDraw') -env.Tool('InstallSubdir') -env.Tool('CopyToDir') -env.Tool('Boost') -env.Tool('CombinedObject') -env.Tool('PhonyTarget') -env.Tool('InstallDir') +senfutil.loadTools(env) 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 -valgrind Run all tests under valgrind/memcheck - -Build parameters: - -final=1 Build optimized library without debug symbols -debug=1 Link all binaries with debug symbols (slow!) -syslayout=1 Install into system layout directories ($$PREFIX/lib, $$PREFIX/include etc) - -additionally, any construction environment variable may be set from the scons -command line (see SConstruct file and SCons documentation for a list of variables). +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 ' or '$ scons /: + +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 ', 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 @[@] + +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( - PKGDRAW = 'doclib/pkgdraw', + expandLogOption = senfutil.expandLogOption, + CXXFLAGS_ = env.BuildTypeOptions('CXXFLAGS'), + CPPDEFINES_ = env.BuildTypeOptions('CPPDEFINES'), + LINKFLAGS_ = env.BuildTypeOptions('LINKFLAGS'), ) - env.Append( - ENV = { 'PATH' : os.environ.get('PATH') }, - CLEAN_PATTERNS = [ '*~', '#*#', '*.pyc', 'semantic.cache', '.sconsign*', '.sconsign' ], - - CPPPATH = [ '#' ], - LOCALLIBDIR = '#', - LIBPATH = [ '$LOCALLIBDIR' ], - LIBS = [ '$LIBSENF$LIBADDSUFFIX', 'rt', '$BOOSTREGEXLIB', - '$BOOSTIOSTREAMSLIB', '$BOOSTSIGNALSLIB', '$BOOSTFSLIB' ], - TEST_EXTRA_LIBS = [ ], - - PREFIX = '#/dist', - LIBINSTALLDIR = '$PREFIX${syslayout and "/lib" or ""}', - BININSTALLDIR = '$PREFIX${syslayout and "/bin" or ""}', - INCLUDEINSTALLDIR = '$PREFIX${syslayout and "/include" or ""}', - OBJINSTALLDIR = '${syslayout and "$LIBINSTALLDIR/senf" or "$PREFIX"}', - DOCINSTALLDIR = '$PREFIX/manual', - SCONSINSTALLDIR = '${syslayout and "$LIBINSTALLDIR/senf" or "$PREFIX"}/site_scons', - CONFINSTALLDIR = '$OBJINSTALLDIR', - - 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 = [ ], + 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", - final = 0, - debug = 0, - syslayout = 0 + 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.Replace(**ARGUMENTS) +senfutil.parseArguments( + 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("Doxyfile.local"): - Execute(Touch("Doxyfile.local")) +if not os.path.exists("doclib/Doxyfile.local"): + Execute(Touch("doclib/Doxyfile.local")) if not env.GetOption('clean') and not os.path.exists(".prepare-stamp") \ and not os.environ.get("SCONS") and COMMAND_LINE_TARGETS != [ 'prepare' ]: - env.Execute([ "scons prepare" ]) + env.Execute([ "$SCONS prepare" ]) # Load SConscripts @@ -129,65 +204,114 @@ SConscriptChdir(0) SConscript("debian/SConscript") SConscriptChdir(1) if os.path.exists('SConscript.local') : SConscript('SConscript.local') -SConscript("senf/SConscript") +if env['sparse_tests']: + import SparseTestHack + SparseTestHack.setup(env) +if env.subst('$BUILDDIR') == '#': + SConscript("SConscript") +else: + SConscript("SConscript", variant_dir=env.subst('$BUILDDIR'), src_dir='#', duplicate=False) SConscript("Examples/SConscript") SConscript("HowTos/SConscript") SConscript("doclib/SConscript") +if env['sparse_tests']: + verbose = 'test_changes' in COMMAND_LINE_TARGETS + SparseTestHack.build(env, verbose, verbose) ########################################################################### # Define build targets -#### doc -env.Depends(SENFSCons.Doxygen(env), env.Value(env['ENV']['REVISION'])) - -#### libsenf.a -libsenf = env.Library("$LOCALLIBDIR/${LIBSENF}${LIBADDSUFFIX}", env['ALLOBJECTS']) -env.Default(libsenf) -env.Install('$LIBINSTALLDIR', libsenf) - -def create(target, source, env): - file(str(target[0]), 'w').write(source[0].get_contents()+"\n") -env['BUILDERS']['CreateFile'] = Builder(action = create) - -conf = env.CreateFile("${LOCALLIBDIR}/${LIBSENF}${LIBADDSUFFIX}.conf", - env.Value(env.subst("$_CPPDEFFLAGS"))) -env.Default(conf) -env.Install('$CONFINSTALLDIR', conf) - #### install_all, default, all_tests, all -env.Install('${SCONSINSTALLDIR}', 'site_scons/senfutil.py') +env.Install('${SCONSINSTALLDIR}', [ 'site_scons/__init__.py', + 'site_scons/senfutil.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.Install('${INCLUDEINSTALLDIR}', 'boost_ext') +env.Install('${INCLUDEINSTALLDIR}/senf', 'senf/boost_intrusive') env.Alias('install_all', env.FindInstalledFiles()) env.Alias('default', DEFAULT_TARGETS) env.Alias('all_tests', env.FindAllBoostUnitTests()) +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.PhonyTarget('valgrind', [ 'all_tests' ], [ """ - find -name .test.bin - | while read test; do - echo; - echo "Running $$test"; - echo; - valgrind --tool=memcheck --error-exitcode=99 --suppressions=valgrind.sup - $$test $BOOSTTESTARGS; - [ $$? -ne 99 ] || exit 1; - done -""".replace("\n"," ") ]) +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', + 'rm /tmp/senf_lcov.info' ]) +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.Clean('all', libsenf) -env.Clean('all', env.Dir('linklint')) # env.Dir to disambiguate from linklint PhonyTarget -if env.GetOption('clean'): - 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.Clean('all', ('.prepare-stamp', env.Dir('dist'), env.Dir('build'))) + +senfutil.CleanGlob(env, 'all', '$CLEAN_PATTERNS') +senfutil.CleanGlob(env, ['some', 'all'], '$CLEAN_SOME_PATTERNS') + +if env.GetOption('clean') and 'all' in BUILD_TARGETS: + env.Depends('all', ('lcov', 'all_valgrinds')) + # Disable writing to the deleted .sconsign file + import SCons.SConsign + SCons.SConsign.write = lambda : None if not env.GetOption('clean') and not os.path.exists(".prepare-stamp"): Execute(Touch(".prepare-stamp")) + +### execute targets on remote hosts +for target in COMMAND_LINE_TARGETS: + if '@' in target: + realtarget, host = target.split('@',1) + cwd=env.GetLaunchDir() + home=os.environ['HOME']+'/' + if cwd.startswith(home) : cwd = cwd[len(home):] + args = [ '$SCONSARGS' ] + if env.GetLaunchDir() != os.getcwd(): + 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") ])