X-Git-Url: http://g0dil.de/git?p=senf.git;a=blobdiff_plain;f=SConstruct;h=8566c0f91fb9cfb50203a2feb6dbce2ab9937db8;hp=17696a1baff8a6b7c97438c5cb40c1a767c36f4c;hb=HEAD;hpb=5bd0f0d58ba30d95a02b46fc9122a7e981bcbcad diff --git a/SConstruct b/SConstruct index 17696a1..8566c0f 100644 --- a/SConstruct +++ b/SConstruct @@ -1,8 +1,7 @@ # -*- 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 @@ -34,12 +33,27 @@ 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 +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. - scons @[@] +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 @[@] + +Some more elaborate unit tests may be enabled by setting appropritate variables in the shell (unix) environment SENF_TIMING_CRITICAL_TESTS @@ -58,81 +72,86 @@ SENF_ETH_TEST_INTERFACE 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', - '${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_' ], - 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' ], ) - -# Add all UNIX env vars starting with 'SENF' to the execution environment -env.Append( ENV = dict(((k,v) for k,v in os.environ.iteritems() if k.startswith("SENF"))) ) - 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 = '', + 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 @@ -140,50 +159,33 @@ 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 -# Default configuration (boost stuff) -senfutil.Configure(env) - -@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] - -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', - '$BOOSTFSLIB' ]) +env.Append(LIBS = [ '$LIBSENF$LIBADDSUFFIX', + '$BOOSTREGEXLIB', '$BOOSTSIGNALSLIB', + '$BOOSTFSLIB', '$BOOSTSYSTEMLIB', '$BOOSTDATETIMELIB' ]) ########################################################################### @@ -225,7 +227,8 @@ env.Install('${SCONSINSTALLDIR}', [ 'site_scons/__init__.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') +env.Install('${INCLUDEINSTALLDIR}', 'boost_ext') +env.Install('${INCLUDEINSTALLDIR}/senf', 'senf/boost_intrusive') env.Alias('install_all', env.FindInstalledFiles()) env.Alias('default', DEFAULT_TARGETS) @@ -233,16 +236,17 @@ 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.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 @@ -254,27 +258,37 @@ if env['HAVE_VALGRIND']: ### 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 @@ -294,3 +308,10 @@ for target in COMMAND_LINE_TARGETS: 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") ])