SConstruct

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