SConstruct revision 2155
19520SAndreas.Sandberg@ARM.com# -*- mode:python -*-
29520SAndreas.Sandberg@ARM.com
39520SAndreas.Sandberg@ARM.com# Copyright (c) 2004-2005 The Regents of The University of Michigan
49520SAndreas.Sandberg@ARM.com# All rights reserved.
59520SAndreas.Sandberg@ARM.com#
69520SAndreas.Sandberg@ARM.com# Redistribution and use in source and binary forms, with or without
79520SAndreas.Sandberg@ARM.com# modification, are permitted provided that the following conditions are
89520SAndreas.Sandberg@ARM.com# met: redistributions of source code must retain the above copyright
99520SAndreas.Sandberg@ARM.com# notice, this list of conditions and the following disclaimer;
109520SAndreas.Sandberg@ARM.com# redistributions in binary form must reproduce the above copyright
119520SAndreas.Sandberg@ARM.com# notice, this list of conditions and the following disclaimer in the
129520SAndreas.Sandberg@ARM.com# documentation and/or other materials provided with the distribution;
139520SAndreas.Sandberg@ARM.com# neither the name of the copyright holders nor the names of its
149520SAndreas.Sandberg@ARM.com# contributors may be used to endorse or promote products derived from
159520SAndreas.Sandberg@ARM.com# this software without specific prior written permission.
169520SAndreas.Sandberg@ARM.com#
179520SAndreas.Sandberg@ARM.com# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
189520SAndreas.Sandberg@ARM.com# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
199520SAndreas.Sandberg@ARM.com# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
209520SAndreas.Sandberg@ARM.com# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
219520SAndreas.Sandberg@ARM.com# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
229520SAndreas.Sandberg@ARM.com# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
239520SAndreas.Sandberg@ARM.com# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
249520SAndreas.Sandberg@ARM.com# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
259520SAndreas.Sandberg@ARM.com# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
269520SAndreas.Sandberg@ARM.com# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
279520SAndreas.Sandberg@ARM.com# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
289520SAndreas.Sandberg@ARM.com
299520SAndreas.Sandberg@ARM.com###################################################
309520SAndreas.Sandberg@ARM.com#
319520SAndreas.Sandberg@ARM.com# SCons top-level build description (SConstruct) file.
329520SAndreas.Sandberg@ARM.com#
339520SAndreas.Sandberg@ARM.com# To build M5, you need a directory with three things:
349520SAndreas.Sandberg@ARM.com# 1. A copy of this file (named SConstruct).
359520SAndreas.Sandberg@ARM.com# 2. A link named 'm5' to the top of the M5 simulator source tree.
369520SAndreas.Sandberg@ARM.com# 3. A link named 'ext' to the top of the M5 external source tree.
379520SAndreas.Sandberg@ARM.com#
389520SAndreas.Sandberg@ARM.com# Then type 'scons' to build the default configuration (see below), or
399520SAndreas.Sandberg@ARM.com# 'scons <CONFIG>/<binary>' to build some other configuration (e.g.,
409520SAndreas.Sandberg@ARM.com# 'ALPHA_FS/m5.opt' for the optimized full-system version).
419520SAndreas.Sandberg@ARM.com#
429520SAndreas.Sandberg@ARM.com###################################################
439520SAndreas.Sandberg@ARM.com
449520SAndreas.Sandberg@ARM.com# Python library imports
459520SAndreas.Sandberg@ARM.comimport sys
469520SAndreas.Sandberg@ARM.comimport os
479520SAndreas.Sandberg@ARM.com
489520SAndreas.Sandberg@ARM.com# Check for recent-enough Python and SCons versions
499520SAndreas.Sandberg@ARM.comEnsurePythonVersion(2,3)
509520SAndreas.Sandberg@ARM.comEnsureSConsVersion(0,96)
519520SAndreas.Sandberg@ARM.com
529520SAndreas.Sandberg@ARM.com# The absolute path to the current directory (where this file lives).
539520SAndreas.Sandberg@ARM.comROOT = Dir('.').abspath
549520SAndreas.Sandberg@ARM.com
559520SAndreas.Sandberg@ARM.com# Paths to the M5 and external source trees (local symlinks).
569520SAndreas.Sandberg@ARM.comSRCDIR = os.path.join(ROOT, 'm5')
579520SAndreas.Sandberg@ARM.comEXT_SRCDIR = os.path.join(ROOT, 'ext')
589520SAndreas.Sandberg@ARM.com
599520SAndreas.Sandberg@ARM.com# Check for 'm5' and 'ext' links, die if they don't exist.
609520SAndreas.Sandberg@ARM.comif not os.path.isdir(SRCDIR):
619520SAndreas.Sandberg@ARM.com    print "Error: '%s' must be a link to the M5 source tree." % SRCDIR
629520SAndreas.Sandberg@ARM.com    Exit(1)
639520SAndreas.Sandberg@ARM.com
649520SAndreas.Sandberg@ARM.comif not os.path.isdir('ext'):
659520SAndreas.Sandberg@ARM.com    print "Error: '%s' must be a link to the M5 external source tree." \
669520SAndreas.Sandberg@ARM.com          % EXT_SRCDIR
679520SAndreas.Sandberg@ARM.com    Exit(1)
689520SAndreas.Sandberg@ARM.com
699520SAndreas.Sandberg@ARM.com# tell python where to find m5 python code
709520SAndreas.Sandberg@ARM.comsys.path.append(os.path.join(SRCDIR, 'python'))
719520SAndreas.Sandberg@ARM.com
729520SAndreas.Sandberg@ARM.com###################################################
739520SAndreas.Sandberg@ARM.com#
749520SAndreas.Sandberg@ARM.com# Figure out which configurations to set up.
759520SAndreas.Sandberg@ARM.com#
769520SAndreas.Sandberg@ARM.com#
779520SAndreas.Sandberg@ARM.com# It's prohibitive to do all the combinations of base configurations
789520SAndreas.Sandberg@ARM.com# and options, so we have to infer which ones the user wants.
799520SAndreas.Sandberg@ARM.com#
809520SAndreas.Sandberg@ARM.com# 1. If there are command-line targets, the configuration(s) are inferred
819520SAndreas.Sandberg@ARM.com#    from the directories of those targets.  If scons was invoked from a
829520SAndreas.Sandberg@ARM.com#    subdirectory (using 'scons -u'), those targets have to be
839520SAndreas.Sandberg@ARM.com#    interpreted relative to that subdirectory.
849520SAndreas.Sandberg@ARM.com#
859520SAndreas.Sandberg@ARM.com# 2. If there are no command-line targets, and scons was invoked from a
869520SAndreas.Sandberg@ARM.com#    subdirectory (using 'scons -u'), the configuration is inferred from
879520SAndreas.Sandberg@ARM.com#    the name of the subdirectory.
889520SAndreas.Sandberg@ARM.com#
899520SAndreas.Sandberg@ARM.com# 3. If there are no command-line targets and scons was invoked from
909520SAndreas.Sandberg@ARM.com#    the root build directory, a default configuration is used.  The
919520SAndreas.Sandberg@ARM.com#    built-in default is ALPHA_SE, but this can be overridden by setting the
929520SAndreas.Sandberg@ARM.com#    M5_DEFAULT_CONFIG shell environment veriable.
939520SAndreas.Sandberg@ARM.com#
949520SAndreas.Sandberg@ARM.com# In cases 2 & 3, the specific file target defaults to 'm5.debug', but
959520SAndreas.Sandberg@ARM.com# this can be overridden by setting the M5_DEFAULT_BINARY shell
969520SAndreas.Sandberg@ARM.com# environment veriable.
979520SAndreas.Sandberg@ARM.com#
989520SAndreas.Sandberg@ARM.com###################################################
999520SAndreas.Sandberg@ARM.com
1009520SAndreas.Sandberg@ARM.com# Find default configuration & binary.
1019520SAndreas.Sandberg@ARM.comdefault_config = os.environ.get('M5_DEFAULT_CONFIG', 'ALPHA_SE')
1029520SAndreas.Sandberg@ARM.comdefault_binary = os.environ.get('M5_DEFAULT_BINARY', 'm5.debug')
1039520SAndreas.Sandberg@ARM.com
1049520SAndreas.Sandberg@ARM.com# Ask SCons which directory it was invoked from.  If you invoke SCons
1059520SAndreas.Sandberg@ARM.com# from a subdirectory you must use the '-u' flag.
1069520SAndreas.Sandberg@ARM.comlaunch_dir = GetLaunchDir()
1079520SAndreas.Sandberg@ARM.com
1089520SAndreas.Sandberg@ARM.com# Build a list 'my_targets' of all the targets relative to ROOT.
1099520SAndreas.Sandberg@ARM.comif launch_dir == ROOT:
1109520SAndreas.Sandberg@ARM.com    # invoked from root build dir
1119520SAndreas.Sandberg@ARM.com    if len(COMMAND_LINE_TARGETS) != 0:
1129520SAndreas.Sandberg@ARM.com        # easy: use specified targets as is
1139520SAndreas.Sandberg@ARM.com        my_targets = COMMAND_LINE_TARGETS
1149520SAndreas.Sandberg@ARM.com    else:
1159520SAndreas.Sandberg@ARM.com        # default target (ALPHA_SE/m5.debug, unless overridden)
1169520SAndreas.Sandberg@ARM.com        target = os.path.join(default_config, default_binary)
1179520SAndreas.Sandberg@ARM.com        my_targets = [target]
1189520SAndreas.Sandberg@ARM.com        Default(target)
1199520SAndreas.Sandberg@ARM.comelse:
1209520SAndreas.Sandberg@ARM.com    # invoked from subdirectory
1219520SAndreas.Sandberg@ARM.com    if not launch_dir.startswith(ROOT):
1229520SAndreas.Sandberg@ARM.com        print "Error: launch dir (%s) not a subdirectory of ROOT (%s)!" \
1239520SAndreas.Sandberg@ARM.com              (launch_dir, ROOT)
1249520SAndreas.Sandberg@ARM.com        Exit(1)
1259520SAndreas.Sandberg@ARM.com    # make launch_dir relative to ROOT (strip ROOT plus slash off front)
1269520SAndreas.Sandberg@ARM.com    launch_dir = launch_dir[len(ROOT)+1:]
1279520SAndreas.Sandberg@ARM.com    if len(COMMAND_LINE_TARGETS) != 0:
1289520SAndreas.Sandberg@ARM.com        # make specified targets relative to ROOT
1299520SAndreas.Sandberg@ARM.com        my_targets = map(lambda x: os.path.join(launch_dir, x),
1309520SAndreas.Sandberg@ARM.com                         COMMAND_LINE_TARGETS)
1319520SAndreas.Sandberg@ARM.com    else:
1329520SAndreas.Sandberg@ARM.com        # build default binary (m5.debug, unless overridden) using the
133        # config inferred by the invocation directory (the first
134        # subdirectory after ROOT)
135        target = os.path.join(launch_dir.split('/')[0], default_binary)
136        my_targets = [target]
137        Default(target)
138
139# Normalize target paths (gets rid of '..' in the middle, etc.)
140my_targets = map(os.path.normpath, my_targets)
141
142# Generate a list of the unique configs that the collected targets reference.
143build_dirs = []
144for t in my_targets:
145    dir = t.split('/')[0]
146    if dir not in build_dirs:
147        build_dirs.append(dir)
148
149###################################################
150#
151# Set up the default build environment.  This environment is copied
152# and modified according to each selected configuration.
153#
154###################################################
155
156env = Environment(ENV = os.environ,  # inherit user's environment vars
157                  ROOT = ROOT,
158                  SRCDIR = SRCDIR,
159                  EXT_SRCDIR = EXT_SRCDIR)
160
161env.SConsignFile("sconsign")
162
163# I waffle on this setting... it does avoid a few painful but
164# unnecessary builds, but it also seems to make trivial builds take
165# noticeably longer.
166if False:
167    env.TargetSignatures('content')
168
169# M5_EXT is used by isa_parser.py to find the PLY package.
170env.Append(ENV = { 'M5_EXT' : EXT_SRCDIR })
171
172# Set up default C++ compiler flags
173env.Append(CCFLAGS='-pipe')
174env.Append(CCFLAGS='-fno-strict-aliasing')
175env.Append(CCFLAGS=Split('-Wall -Wno-sign-compare -Werror -Wundef'))
176if sys.platform == 'cygwin':
177    # cygwin has some header file issues...
178    env.Append(CCFLAGS=Split("-Wno-uninitialized"))
179env.Append(CPPPATH=[os.path.join(EXT_SRCDIR + '/dnet')])
180
181# Default libraries
182env.Append(LIBS=['z'])
183
184# Platform-specific configuration
185conf = Configure(env)
186
187# Check for <fenv.h> (C99 FP environment control)
188have_fenv = conf.CheckHeader('fenv.h', '<>')
189if not have_fenv:
190    print "Warning: Header file <fenv.h> not found."
191    print "         This host has no IEEE FP rounding mode control."
192
193# Check for mysql.
194mysql_config = WhereIs('mysql_config')
195have_mysql = mysql_config != None
196
197# Check MySQL version.
198if have_mysql:
199    mysql_version = os.popen(mysql_config + ' --version').read()
200    mysql_version = mysql_version.split('.')
201    mysql_major = int(mysql_version[0])
202    mysql_minor = int(mysql_version[1])
203    # This version check is probably overly conservative, but it deals
204    # with the versions we have installed.
205    if mysql_major < 4 or (mysql_major == 4 and mysql_minor < 1):
206        print "Warning: MySQL v4.1 or newer required."
207        have_mysql = False
208
209# Set up mysql_config commands.
210if have_mysql:
211    mysql_config_include = mysql_config + ' --include'
212    if os.system(mysql_config_include + ' > /dev/null') != 0:
213        # older mysql_config versions don't support --include, use
214        # --cflags instead
215        mysql_config_include = mysql_config + ' --cflags | sed s/\\\'//g'
216    # This seems to work in all versions
217    mysql_config_libs = mysql_config + ' --libs'
218
219env = conf.Finish()
220
221# Define the universe of supported ISAs
222env['ALL_ISA_LIST'] = ['alpha', 'sparc', 'mips']
223
224# Define the universe of supported CPU models
225env['ALL_CPU_LIST'] = ['SimpleCPU', 'FastCPU', 'FullCPU', 'AlphaFullCPU']
226
227# Sticky options get saved in the options file so they persist from
228# one invocation to the next (unless overridden, in which case the new
229# value becomes sticky).
230sticky_opts = Options(args=ARGUMENTS)
231sticky_opts.AddOptions(
232    EnumOption('TARGET_ISA', 'Target ISA', 'alpha', env['ALL_ISA_LIST']),
233    BoolOption('FULL_SYSTEM', 'Full-system support', False),
234    BoolOption('ALPHA_TLASER',
235               'Model Alpha TurboLaser platform (vs. Tsunami)', False),
236    BoolOption('NO_FAST_ALLOC', 'Disable fast object allocator', False),
237    BoolOption('EFENCE', 'Link with Electric Fence malloc debugger',
238               False),
239    BoolOption('SS_COMPATIBLE_FP',
240               'Make floating-point results compatible with SimpleScalar',
241               False),
242    BoolOption('USE_SSE2',
243               'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
244               False),
245    BoolOption('STATS_BINNING', 'Bin statistics by CPU mode', have_mysql),
246    BoolOption('USE_MYSQL', 'Use MySQL for stats output', have_mysql),
247    BoolOption('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
248    ('CC', 'C compiler', os.environ.get('CC', env['CC'])),
249    ('CXX', 'C++ compiler', os.environ.get('CXX', env['CXX'])),
250    BoolOption('BATCH', 'Use batch pool for build and tests', False),
251    ('BATCH_CMD', 'Batch pool submission command name', 'qdo')
252    )
253
254# Non-sticky options only apply to the current build.
255nonsticky_opts = Options(args=ARGUMENTS)
256nonsticky_opts.AddOptions(
257    # This really should be a sticky option, but there's a bug in
258    # scons 0.96.1 that causes ListOptions not to be able to be
259    # restored from a saved option file.  It looks like this is fixed
260    # in 0.96.9, but there's a different bug in that version that means we
261    # can't just upgrade.
262    ListOption('CPU_MODELS', 'CPU models', 'all', env['ALL_CPU_LIST']),
263    BoolOption('update_ref', 'Update test reference outputs', False)
264    )
265
266# These options get exported to #defines in config/*.hh (see m5/SConscript).
267env.ExportOptions = ['FULL_SYSTEM', 'ALPHA_TLASER', 'USE_FENV', \
268                     'USE_MYSQL', 'NO_FAST_ALLOC', 'SS_COMPATIBLE_FP', \
269                     'STATS_BINNING']
270
271# Define a handy 'no-op' action
272def no_action(target, source, env):
273    return 0
274
275env.NoAction = Action(no_action, None)
276
277# libelf build is described in its own SConscript file.
278# SConscript-global is the build in build/libelf shared among all
279# configs.
280env.SConscript('m5/libelf/SConscript-global', exports = 'env')
281
282###################################################
283#
284# Define a SCons builder for configuration flag headers.
285#
286###################################################
287
288# This function generates a config header file that #defines the
289# option symbol to the current option setting (0 or 1).  The source
290# operands are the name of the option and a Value node containing the
291# value of the option.
292def build_config_file(target, source, env):
293    (option, value) = [s.get_contents() for s in source]
294    f = file(str(target[0]), 'w')
295    print >> f, '#define', option, value
296    f.close()
297    return None
298
299# Generate the message to be printed when building the config file.
300def build_config_file_string(target, source, env):
301    (option, value) = [s.get_contents() for s in source]
302    return "Defining %s as %s in %s." % (option, value, target[0])
303
304# Combine the two functions into a scons Action object.
305config_action = Action(build_config_file, build_config_file_string)
306
307# The emitter munges the source & target node lists to reflect what
308# we're really doing.
309def config_emitter(target, source, env):
310    # extract option name from Builder arg
311    option = str(target[0])
312    # True target is config header file
313    target = os.path.join('config', option.lower() + '.hh')
314    # Force value to 0/1 even if it's a Python bool
315    val = int(eval(str(env[option])))
316    # Sources are option name & value (packaged in SCons Value nodes)
317    return ([target], [Value(option), Value(val)])
318
319config_builder = Builder(emitter = config_emitter, action = config_action)
320
321env.Append(BUILDERS = { 'ConfigFile' : config_builder })
322
323###################################################
324#
325# Define build environments for selected configurations.
326#
327###################################################
328
329# rename base env
330base_env = env
331
332for build_dir in build_dirs:
333    # Make a copy of the default environment to use for this config.
334    env = base_env.Copy()
335
336    # Record what build_dir was in the environment
337    env.Append(BUILD_DIR=build_dir);
338
339    # Set env according to the build directory config.
340
341    sticky_opts.files = []
342    # Name of default options file is taken from 'default=' on command
343    # line if set, otherwise name of build dir.
344    default_options_file = os.path.join('build_options', 'default',
345                                        ARGUMENTS.get('default', build_dir))
346    if os.path.isfile(default_options_file):
347        sticky_opts.files.append(default_options_file)
348    current_options_file = os.path.join('build_options', 'current', build_dir)
349    if os.path.isfile(current_options_file):
350        sticky_opts.files.append(current_options_file)
351    else:
352        # if file doesn't exist, make sure at least the directory is there
353        # so we can create it later
354        opt_dir = os.path.dirname(current_options_file)
355        if not os.path.isdir(opt_dir):
356            os.mkdir(opt_dir)
357    if not sticky_opts.files:
358        print "%s: No options file found in build_options, using defaults." \
359              % build_dir
360
361    # Apply current option settings to env
362    sticky_opts.Update(env)
363    nonsticky_opts.Update(env)
364
365    # Process option settings.
366
367    if not have_fenv and env['USE_FENV']:
368        print "Warning: <fenv.h> not available; " \
369              "forcing USE_FENV to False in", build_dir + "."
370        env['USE_FENV'] = False
371
372    if not env['USE_FENV']:
373        print "Warning: No IEEE FP rounding mode control in", build_dir + "."
374        print "         FP results may deviate slightly from other platforms."
375
376    if env['EFENCE']:
377        env.Append(LIBS=['efence'])
378
379    if env['USE_MYSQL']:
380        if not have_mysql:
381            print "Warning: MySQL not available; " \
382                  "forcing USE_MYSQL to False in", build_dir + "."
383            env['USE_MYSQL'] = False
384        else:
385            print "Compiling in", build_dir, "with MySQL support."
386            env.ParseConfig(mysql_config_libs)
387            env.ParseConfig(mysql_config_include)
388
389    # Save sticky option settings back to current options file
390    sticky_opts.Save(current_options_file, env)
391
392    # Do this after we save setting back, or else we'll tack on an
393    # extra 'qdo' every time we run scons.
394    if env['BATCH']:
395        env['CC']  = env['BATCH_CMD'] + ' ' + env['CC']
396        env['CXX'] = env['BATCH_CMD'] + ' ' + env['CXX']
397
398    if env['USE_SSE2']:
399        env.Append(CCFLAGS='-msse2')
400
401    # The m5/SConscript file sets up the build rules in 'env' according
402    # to the configured options.  It returns a list of environments,
403    # one for each variant build (debug, opt, etc.)
404    envList = SConscript('m5/SConscript', build_dir = build_dir,
405                         exports = 'env', duplicate = False)
406
407    # Set up the regression tests for each build.
408    for e in envList:
409        SConscript('m5-test/SConscript',
410                   build_dir = os.path.join(build_dir, 'test', e.Label),
411                   exports = { 'env' : e }, duplicate = False)
412
413###################################################
414#
415# Let SCons do its thing.  At this point SCons will use the defined
416# build environments to build the requested targets.
417#
418###################################################
419
420