SConstruct revision 2667
1# -*- mode:python -*- 2 3# Copyright (c) 2004-2005 The Regents of The University of Michigan 4# All rights reserved. 5# 6# Redistribution and use in source and binary forms, with or without 7# modification, are permitted provided that the following conditions are 8# met: redistributions of source code must retain the above copyright 9# notice, this list of conditions and the following disclaimer; 10# redistributions in binary form must reproduce the above copyright 11# notice, this list of conditions and the following disclaimer in the 12# documentation and/or other materials provided with the distribution; 13# neither the name of the copyright holders nor the names of its 14# contributors may be used to endorse or promote products derived from 15# this software without specific prior written permission. 16# 17# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 18# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 19# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 20# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 21# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 22# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 23# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 24# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 25# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 26# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 27# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28# 29# Authors: Steve Reinhardt 30 31################################################### 32# 33# SCons top-level build description (SConstruct) file. 34# 35# While in this directory ('m5'), just type 'scons' to build the default 36# configuration (see below), or type 'scons build/<CONFIG>/<binary>' 37# to build some other configuration (e.g., 'build/ALPHA_FS/m5.opt' for 38# the optimized full-system version). 39# 40# You can build M5 in a different directory as long as there is a 41# 'build/<CONFIG>' somewhere along the target path. The build system 42# expdects that all configs under the same build directory are being 43# built for the same host system. 44# 45# Examples: 46# These two commands are equivalent. The '-u' option tells scons to 47# search up the directory tree for this SConstruct file. 48# % cd <path-to-src>/m5 ; scons build/ALPHA_FS/m5.debug 49# % cd <path-to-src>/m5/build/ALPHA_FS; scons -u m5.debug 50# These two commands are equivalent and demonstrate building in a 51# directory outside of the source tree. The '-C' option tells scons 52# to chdir to the specified directory to find this SConstruct file. 53# % cd <path-to-src>/m5 ; scons /local/foo/build/ALPHA_FS/m5.debug 54# % cd /local/foo/build/ALPHA_FS; scons -C <path-to-src>/m5 m5.debug 55# 56# You can use 'scons -H' to print scons options. If you're in this 57# 'm5' directory (or use -u or -C to tell scons where to find this 58# file), you can use 'scons -h' to print all the M5-specific build 59# options as well. 60# 61################################################### 62 63# Python library imports 64import sys 65import os 66 67# Check for recent-enough Python and SCons versions. If your system's 68# default installation of Python is not recent enough, you can use a 69# non-default installation of the Python interpreter by either (1) 70# rearranging your PATH so that scons finds the non-default 'python' 71# first or (2) explicitly invoking an alternative interpreter on the 72# scons script, e.g., "/usr/local/bin/python2.4 `which scons` [args]". 73EnsurePythonVersion(2,4) 74 75# Ironically, SCons 0.96 dies if you give EnsureSconsVersion a 76# 3-element version number. 77min_scons_version = (0,96,91) 78try: 79 EnsureSConsVersion(*min_scons_version) 80except: 81 print "Error checking current SCons version." 82 print "SCons", ".".join(map(str,min_scons_version)), "or greater required." 83 Exit(2) 84 85 86# The absolute path to the current directory (where this file lives). 87ROOT = Dir('.').abspath 88 89# Paths to the M5 and external source trees. 90SRCDIR = os.path.join(ROOT, 'src') 91 92# tell python where to find m5 python code 93sys.path.append(os.path.join(ROOT, 'src/python')) 94 95################################################### 96# 97# Figure out which configurations to set up based on the path(s) of 98# the target(s). 99# 100################################################### 101 102# Find default configuration & binary. 103Default(os.environ.get('M5_DEFAULT_BINARY', 'build/ALPHA_SE/m5.debug')) 104 105# Ask SCons which directory it was invoked from. 106launch_dir = GetLaunchDir() 107 108# Make targets relative to invocation directory 109abs_targets = map(lambda x: os.path.normpath(os.path.join(launch_dir, str(x))), 110 BUILD_TARGETS) 111 112# helper function: find last occurrence of element in list 113def rfind(l, elt, offs = -1): 114 for i in range(len(l)+offs, 0, -1): 115 if l[i] == elt: 116 return i 117 raise ValueError, "element not found" 118 119# Each target must have 'build' in the interior of the path; the 120# directory below this will determine the build parameters. For 121# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we 122# recognize that ALPHA_SE specifies the configuration because it 123# follow 'build' in the bulid path. 124 125# Generate a list of the unique build roots and configs that the 126# collected targets reference. 127build_paths = [] 128build_root = None 129for t in abs_targets: 130 path_dirs = t.split('/') 131 try: 132 build_top = rfind(path_dirs, 'build', -2) 133 except: 134 print "Error: no non-leaf 'build' dir found on target path", t 135 Exit(1) 136 this_build_root = os.path.join('/',*path_dirs[:build_top+1]) 137 if not build_root: 138 build_root = this_build_root 139 else: 140 if this_build_root != build_root: 141 print "Error: build targets not under same build root\n"\ 142 " %s\n %s" % (build_root, this_build_root) 143 Exit(1) 144 build_path = os.path.join('/',*path_dirs[:build_top+2]) 145 if build_path not in build_paths: 146 build_paths.append(build_path) 147 148################################################### 149# 150# Set up the default build environment. This environment is copied 151# and modified according to each selected configuration. 152# 153################################################### 154 155env = Environment(ENV = os.environ, # inherit user's environment vars 156 ROOT = ROOT, 157 SRCDIR = SRCDIR) 158 159env.SConsignFile("sconsign") 160 161# Default duplicate option is to use hard links, but this messes up 162# when you use emacs to edit a file in the target dir, as emacs moves 163# file to file~ then copies to file, breaking the link. Symbolic 164# (soft) links work better. 165env.SetOption('duplicate', 'soft-copy') 166 167# I waffle on this setting... it does avoid a few painful but 168# unnecessary builds, but it also seems to make trivial builds take 169# noticeably longer. 170if False: 171 env.TargetSignatures('content') 172 173# M5_PLY is used by isa_parser.py to find the PLY package. 174env.Append(ENV = { 'M5_PLY' : Dir('ext/ply') }) 175 176# Set up default C++ compiler flags 177env.Append(CCFLAGS='-pipe') 178env.Append(CCFLAGS='-fno-strict-aliasing') 179env.Append(CCFLAGS=Split('-Wall -Wno-sign-compare -Werror -Wundef')) 180if sys.platform == 'cygwin': 181 # cygwin has some header file issues... 182 env.Append(CCFLAGS=Split("-Wno-uninitialized")) 183env.Append(CPPPATH=[Dir('ext/dnet')]) 184 185# Find Python include and library directories for embedding the 186# interpreter. For consistency, we will use the same Python 187# installation used to run scons (and thus this script). If you want 188# to link in an alternate version, see above for instructions on how 189# to invoke scons with a different copy of the Python interpreter. 190 191# Get brief Python version name (e.g., "python2.4") for locating 192# include & library files 193py_version_name = 'python' + sys.version[:3] 194 195# include path, e.g. /usr/local/include/python2.4 196env.Append(CPPPATH = os.path.join(sys.exec_prefix, 'include', py_version_name)) 197env.Append(LIBS = py_version_name) 198# add library path too if it's not in the default place 199if sys.exec_prefix != '/usr': 200 env.Append(LIBPATH = os.path.join(sys.exec_prefix, 'lib')) 201 202# Set up SWIG flags & scanner 203 204env.Append(SWIGFLAGS=Split('-c++ -python -modern $_CPPINCFLAGS')) 205 206import SCons.Scanner 207 208swig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")' 209 210swig_scanner = SCons.Scanner.ClassicCPP("SwigScan", ".i", "CPPPATH", 211 swig_inc_re) 212 213env.Append(SCANNERS = swig_scanner) 214 215# Other default libraries 216env.Append(LIBS=['z']) 217 218# Platform-specific configuration. Note again that we assume that all 219# builds under a given build root run on the same host platform. 220conf = Configure(env, 221 conf_dir = os.path.join(build_root, '.scons_config'), 222 log_file = os.path.join(build_root, 'scons_config.log')) 223 224# Check for <fenv.h> (C99 FP environment control) 225have_fenv = conf.CheckHeader('fenv.h', '<>') 226if not have_fenv: 227 print "Warning: Header file <fenv.h> not found." 228 print " This host has no IEEE FP rounding mode control." 229 230# Check for mysql. 231mysql_config = WhereIs('mysql_config') 232have_mysql = mysql_config != None 233 234# Check MySQL version. 235if have_mysql: 236 mysql_version = os.popen(mysql_config + ' --version').read() 237 mysql_version = mysql_version.split('.') 238 mysql_major = int(mysql_version[0]) 239 mysql_minor = int(mysql_version[1]) 240 # This version check is probably overly conservative, but it deals 241 # with the versions we have installed. 242 if mysql_major < 4 or (mysql_major == 4 and mysql_minor < 1): 243 print "Warning: MySQL v4.1 or newer required." 244 have_mysql = False 245 246# Set up mysql_config commands. 247if have_mysql: 248 mysql_config_include = mysql_config + ' --include' 249 if os.system(mysql_config_include + ' > /dev/null') != 0: 250 # older mysql_config versions don't support --include, use 251 # --cflags instead 252 mysql_config_include = mysql_config + ' --cflags | sed s/\\\'//g' 253 # This seems to work in all versions 254 mysql_config_libs = mysql_config + ' --libs' 255 256env = conf.Finish() 257 258# Define the universe of supported ISAs 259env['ALL_ISA_LIST'] = ['alpha', 'sparc', 'mips'] 260 261# Define the universe of supported CPU models 262env['ALL_CPU_LIST'] = ['AtomicSimpleCPU', 'TimingSimpleCPU', 263 'FullCPU', 'AlphaFullCPU'] 264 265# Sticky options get saved in the options file so they persist from 266# one invocation to the next (unless overridden, in which case the new 267# value becomes sticky). 268sticky_opts = Options(args=ARGUMENTS) 269sticky_opts.AddOptions( 270 EnumOption('TARGET_ISA', 'Target ISA', 'alpha', env['ALL_ISA_LIST']), 271 BoolOption('FULL_SYSTEM', 'Full-system support', False), 272 # There's a bug in scons 0.96.1 that causes ListOptions with list 273 # values (more than one value) not to be able to be restored from 274 # a saved option file. If this causes trouble then upgrade to 275 # scons 0.96.90 or later. 276 ListOption('CPU_MODELS', 'CPU models', 'AtomicSimpleCPU,TimingSimpleCPU', 277 env['ALL_CPU_LIST']), 278 BoolOption('ALPHA_TLASER', 279 'Model Alpha TurboLaser platform (vs. Tsunami)', False), 280 BoolOption('NO_FAST_ALLOC', 'Disable fast object allocator', False), 281 BoolOption('EFENCE', 'Link with Electric Fence malloc debugger', 282 False), 283 BoolOption('SS_COMPATIBLE_FP', 284 'Make floating-point results compatible with SimpleScalar', 285 False), 286 BoolOption('USE_SSE2', 287 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts', 288 False), 289 BoolOption('STATS_BINNING', 'Bin statistics by CPU mode', have_mysql), 290 BoolOption('USE_MYSQL', 'Use MySQL for stats output', have_mysql), 291 BoolOption('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv), 292 ('CC', 'C compiler', os.environ.get('CC', env['CC'])), 293 ('CXX', 'C++ compiler', os.environ.get('CXX', env['CXX'])), 294 BoolOption('BATCH', 'Use batch pool for build and tests', False), 295 ('BATCH_CMD', 'Batch pool submission command name', 'qdo') 296 ) 297 298# Non-sticky options only apply to the current build. 299nonsticky_opts = Options(args=ARGUMENTS) 300nonsticky_opts.AddOptions( 301 BoolOption('update_ref', 'Update test reference outputs', False) 302 ) 303 304# These options get exported to #defines in config/*.hh (see m5/SConscript). 305env.ExportOptions = ['FULL_SYSTEM', 'ALPHA_TLASER', 'USE_FENV', \ 306 'USE_MYSQL', 'NO_FAST_ALLOC', 'SS_COMPATIBLE_FP', \ 307 'STATS_BINNING'] 308 309# Define a handy 'no-op' action 310def no_action(target, source, env): 311 return 0 312 313env.NoAction = Action(no_action, None) 314 315################################################### 316# 317# Define a SCons builder for configuration flag headers. 318# 319################################################### 320 321# This function generates a config header file that #defines the 322# option symbol to the current option setting (0 or 1). The source 323# operands are the name of the option and a Value node containing the 324# value of the option. 325def build_config_file(target, source, env): 326 (option, value) = [s.get_contents() for s in source] 327 f = file(str(target[0]), 'w') 328 print >> f, '#define', option, value 329 f.close() 330 return None 331 332# Generate the message to be printed when building the config file. 333def build_config_file_string(target, source, env): 334 (option, value) = [s.get_contents() for s in source] 335 return "Defining %s as %s in %s." % (option, value, target[0]) 336 337# Combine the two functions into a scons Action object. 338config_action = Action(build_config_file, build_config_file_string) 339 340# The emitter munges the source & target node lists to reflect what 341# we're really doing. 342def config_emitter(target, source, env): 343 # extract option name from Builder arg 344 option = str(target[0]) 345 # True target is config header file 346 target = os.path.join('config', option.lower() + '.hh') 347 # Force value to 0/1 even if it's a Python bool 348 val = int(eval(str(env[option]))) 349 # Sources are option name & value (packaged in SCons Value nodes) 350 return ([target], [Value(option), Value(val)]) 351 352config_builder = Builder(emitter = config_emitter, action = config_action) 353 354env.Append(BUILDERS = { 'ConfigFile' : config_builder }) 355 356################################################### 357# 358# Define a SCons builder for copying files. This is used by the 359# Python zipfile code in src/python/SConscript, but is placed up here 360# since it's potentially more generally applicable. 361# 362################################################### 363 364copy_builder = Builder(action = Copy("$TARGET", "$SOURCE")) 365 366env.Append(BUILDERS = { 'CopyFile' : copy_builder }) 367 368################################################### 369# 370# Define a simple SCons builder to concatenate files. 371# 372# Used to append the Python zip archive to the executable. 373# 374################################################### 375 376concat_builder = Builder(action = Action(['cat $SOURCES > $TARGET', 377 'chmod +x $TARGET'])) 378 379env.Append(BUILDERS = { 'Concat' : concat_builder }) 380 381 382# base help text 383help_text = ''' 384Usage: scons [scons options] [build options] [target(s)] 385 386''' 387 388# libelf build is shared across all configs in the build root. 389env.SConscript('ext/libelf/SConscript', 390 build_dir = os.path.join(build_root, 'libelf'), 391 exports = 'env') 392 393################################################### 394# 395# Define build environments for selected configurations. 396# 397################################################### 398 399# rename base env 400base_env = env 401 402for build_path in build_paths: 403 print "Building in", build_path 404 # build_dir is the tail component of build path, and is used to 405 # determine the build parameters (e.g., 'ALPHA_SE') 406 (build_root, build_dir) = os.path.split(build_path) 407 # Make a copy of the build-root environment to use for this config. 408 env = base_env.Copy() 409 410 # Set env options according to the build directory config. 411 sticky_opts.files = [] 412 # Options for $BUILD_ROOT/$BUILD_DIR are stored in 413 # $BUILD_ROOT/options/$BUILD_DIR so you can nuke 414 # $BUILD_ROOT/$BUILD_DIR without losing your options settings. 415 current_opts_file = os.path.join(build_root, 'options', build_dir) 416 if os.path.isfile(current_opts_file): 417 sticky_opts.files.append(current_opts_file) 418 print "Using saved options file %s" % current_opts_file 419 else: 420 # Build dir-specific options file doesn't exist. 421 422 # Make sure the directory is there so we can create it later 423 opt_dir = os.path.dirname(current_opts_file) 424 if not os.path.isdir(opt_dir): 425 os.mkdir(opt_dir) 426 427 # Get default build options from source tree. Options are 428 # normally determined by name of $BUILD_DIR, but can be 429 # overriden by 'default=' arg on command line. 430 default_opts_file = os.path.join('build_opts', 431 ARGUMENTS.get('default', build_dir)) 432 if os.path.isfile(default_opts_file): 433 sticky_opts.files.append(default_opts_file) 434 print "Options file %s not found,\n using defaults in %s" \ 435 % (current_opts_file, default_opts_file) 436 else: 437 print "Error: cannot find options file %s or %s" \ 438 % (current_opts_file, default_opts_file) 439 Exit(1) 440 441 # Apply current option settings to env 442 sticky_opts.Update(env) 443 nonsticky_opts.Update(env) 444 445 help_text += "Sticky options for %s:\n" % build_dir \ 446 + sticky_opts.GenerateHelpText(env) \ 447 + "\nNon-sticky options for %s:\n" % build_dir \ 448 + nonsticky_opts.GenerateHelpText(env) 449 450 # Process option settings. 451 452 if not have_fenv and env['USE_FENV']: 453 print "Warning: <fenv.h> not available; " \ 454 "forcing USE_FENV to False in", build_dir + "." 455 env['USE_FENV'] = False 456 457 if not env['USE_FENV']: 458 print "Warning: No IEEE FP rounding mode control in", build_dir + "." 459 print " FP results may deviate slightly from other platforms." 460 461 if env['EFENCE']: 462 env.Append(LIBS=['efence']) 463 464 if env['USE_MYSQL']: 465 if not have_mysql: 466 print "Warning: MySQL not available; " \ 467 "forcing USE_MYSQL to False in", build_dir + "." 468 env['USE_MYSQL'] = False 469 else: 470 print "Compiling in", build_dir, "with MySQL support." 471 env.ParseConfig(mysql_config_libs) 472 env.ParseConfig(mysql_config_include) 473 474 # Save sticky option settings back to current options file 475 sticky_opts.Save(current_opts_file, env) 476 477 # Do this after we save setting back, or else we'll tack on an 478 # extra 'qdo' every time we run scons. 479 if env['BATCH']: 480 env['CC'] = env['BATCH_CMD'] + ' ' + env['CC'] 481 env['CXX'] = env['BATCH_CMD'] + ' ' + env['CXX'] 482 483 if env['USE_SSE2']: 484 env.Append(CCFLAGS='-msse2') 485 486 # The m5/SConscript file sets up the build rules in 'env' according 487 # to the configured options. It returns a list of environments, 488 # one for each variant build (debug, opt, etc.) 489 envList = SConscript('src/SConscript', build_dir = build_path, 490 exports = 'env') 491 492 # Set up the regression tests for each build. 493# for e in envList: 494# SConscript('m5-test/SConscript', 495# build_dir = os.path.join(build_dir, 'test', e.Label), 496# exports = { 'env' : e }, duplicate = False) 497 498Help(help_text) 499 500################################################### 501# 502# Let SCons do its thing. At this point SCons will use the defined 503# build environments to build the requested targets. 504# 505################################################### 506 507