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