SConstruct revision 3546:c4074658f1e1
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
67import sys
68import 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]".
76EnsurePythonVersion(2,4)
77
78# Ironically, SCons 0.96 dies if you give EnsureSconsVersion a
79# 3-element version number.
80min_scons_version = (0,96,91)
81try:
82    EnsureSConsVersion(*min_scons_version)
83except:
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).
90ROOT = Dir('.').abspath
91
92# Paths to the M5 and external source trees.
93SRCDIR = os.path.join(ROOT, 'src')
94
95# tell python where to find m5 python code
96sys.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.
106Default(os.environ.get('M5_DEFAULT_BINARY', 'build/ALPHA_SE/m5.debug'))
107
108# Ask SCons which directory it was invoked from.
109launch_dir = GetLaunchDir()
110
111# Make targets relative to invocation directory
112abs_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
116def 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# helper function: compare dotted version numbers.
123# E.g., compare_version('1.3.25', '1.4.1')
124# returns -1, 0, 1 if v1 is <, ==, > v2
125def compare_versions(v1, v2):
126    # Convert dotted strings to lists
127    v1 = map(int, v1.split('.'))
128    v2 = map(int, v2.split('.'))
129    # Compare corresponding elements of lists
130    for n1,n2 in zip(v1, v2):
131        if n1 < n2: return -1
132        if n1 > n2: return  1
133    # all corresponding values are equal... see if one has extra values
134    if len(v1) < len(v2): return -1
135    if len(v1) > len(v2): return  1
136    return 0
137
138# Each target must have 'build' in the interior of the path; the
139# directory below this will determine the build parameters.  For
140# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
141# recognize that ALPHA_SE specifies the configuration because it
142# follow 'build' in the bulid path.
143
144# Generate a list of the unique build roots and configs that the
145# collected targets reference.
146build_paths = []
147build_root = None
148for t in abs_targets:
149    path_dirs = t.split('/')
150    try:
151        build_top = rfind(path_dirs, 'build', -2)
152    except:
153        print "Error: no non-leaf 'build' dir found on target path", t
154        Exit(1)
155    this_build_root = os.path.join('/',*path_dirs[:build_top+1])
156    if not build_root:
157        build_root = this_build_root
158    else:
159        if this_build_root != build_root:
160            print "Error: build targets not under same build root\n"\
161                  "  %s\n  %s" % (build_root, this_build_root)
162            Exit(1)
163    build_path = os.path.join('/',*path_dirs[:build_top+2])
164    if build_path not in build_paths:
165        build_paths.append(build_path)
166
167###################################################
168#
169# Set up the default build environment.  This environment is copied
170# and modified according to each selected configuration.
171#
172###################################################
173
174env = Environment(ENV = os.environ,  # inherit user's environment vars
175                  ROOT = ROOT,
176                  SRCDIR = SRCDIR)
177
178env.SConsignFile(os.path.join(build_root,"sconsign"))
179
180# Default duplicate option is to use hard links, but this messes up
181# when you use emacs to edit a file in the target dir, as emacs moves
182# file to file~ then copies to file, breaking the link.  Symbolic
183# (soft) links work better.
184env.SetOption('duplicate', 'soft-copy')
185
186# I waffle on this setting... it does avoid a few painful but
187# unnecessary builds, but it also seems to make trivial builds take
188# noticeably longer.
189if False:
190    env.TargetSignatures('content')
191
192# M5_PLY is used by isa_parser.py to find the PLY package.
193env.Append(ENV = { 'M5_PLY' : Dir('ext/ply') })
194
195# Set up default C++ compiler flags
196env.Append(CCFLAGS='-pipe')
197env.Append(CCFLAGS='-fno-strict-aliasing')
198env.Append(CCFLAGS=Split('-Wall -Wno-sign-compare -Werror -Wundef'))
199if sys.platform == 'cygwin':
200    # cygwin has some header file issues...
201    env.Append(CCFLAGS=Split("-Wno-uninitialized"))
202env.Append(CPPPATH=[Dir('ext/dnet')])
203
204# Check for SWIG
205if not env.has_key('SWIG'):
206    print 'Error: SWIG utility not found.'
207    print '       Please install (see http://www.swig.org) and retry.'
208    Exit(1)
209
210# Check for appropriate SWIG version
211swig_version = os.popen('swig -version').read().split()
212# First 3 words should be "SWIG Version x.y.z"
213if swig_version[0] != 'SWIG' or swig_version[1] != 'Version':
214    print 'Error determining SWIG version.'
215    Exit(1)
216
217min_swig_version = '1.3.28'
218if compare_versions(swig_version[2], min_swig_version) < 0:
219    print 'Error: SWIG version', min_swig_version, 'or newer required.'
220    print '       Installed version:', swig_version[2]
221    Exit(1)
222
223# Set up SWIG flags & scanner
224env.Append(SWIGFLAGS=Split('-c++ -python -modern $_CPPINCFLAGS'))
225
226import SCons.Scanner
227
228swig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
229
230swig_scanner = SCons.Scanner.ClassicCPP("SwigScan", ".i", "CPPPATH",
231                                        swig_inc_re)
232
233env.Append(SCANNERS = swig_scanner)
234
235# Platform-specific configuration.  Note again that we assume that all
236# builds under a given build root run on the same host platform.
237conf = Configure(env,
238                 conf_dir = os.path.join(build_root, '.scons_config'),
239                 log_file = os.path.join(build_root, 'scons_config.log'))
240
241# Find Python include and library directories for embedding the
242# interpreter.  For consistency, we will use the same Python
243# installation used to run scons (and thus this script).  If you want
244# to link in an alternate version, see above for instructions on how
245# to invoke scons with a different copy of the Python interpreter.
246
247# Get brief Python version name (e.g., "python2.4") for locating
248# include & library files
249py_version_name = 'python' + sys.version[:3]
250
251# include path, e.g. /usr/local/include/python2.4
252py_header_path = os.path.join(sys.exec_prefix, 'include', py_version_name)
253env.Append(CPPPATH = py_header_path)
254# verify that it works
255if not conf.CheckHeader('Python.h', '<>'):
256    print "Error: can't find Python.h header in", py_header_path
257    Exit(1)
258
259# add library path too if it's not in the default place
260py_lib_path = None
261if sys.exec_prefix != '/usr':
262    py_lib_path = os.path.join(sys.exec_prefix, 'lib')
263elif sys.platform == 'cygwin':
264    # cygwin puts the .dll in /bin for some reason
265    py_lib_path = '/bin'
266if py_lib_path:
267    env.Append(LIBPATH = py_lib_path)
268    print 'Adding', py_lib_path, 'to LIBPATH for', py_version_name
269if not conf.CheckLib(py_version_name):
270    print "Error: can't find Python library", py_version_name
271    Exit(1)
272
273# On Solaris you need to use libsocket for socket ops
274if not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
275   if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
276       print "Can't find library with socket calls (e.g. accept())"
277       Exit(1)
278
279# Check for zlib.  If the check passes, libz will be automatically
280# added to the LIBS environment variable.
281if not conf.CheckLibWithHeader('z', 'zlib.h', 'C++'):
282    print 'Error: did not find needed zlib compression library '\
283          'and/or zlib.h header file.'
284    print '       Please install zlib and try again.'
285    Exit(1)
286
287# Check for <fenv.h> (C99 FP environment control)
288have_fenv = conf.CheckHeader('fenv.h', '<>')
289if not have_fenv:
290    print "Warning: Header file <fenv.h> not found."
291    print "         This host has no IEEE FP rounding mode control."
292
293# Check for mysql.
294mysql_config = WhereIs('mysql_config')
295have_mysql = mysql_config != None
296
297# Check MySQL version.
298if have_mysql:
299    mysql_version = os.popen(mysql_config + ' --version').read()
300    min_mysql_version = '4.1'
301    if compare_versions(mysql_version, min_mysql_version) < 0:
302        print 'Warning: MySQL', min_mysql_version, 'or newer required.'
303        print '         Version', mysql_version, 'detected.'
304        have_mysql = False
305
306# Set up mysql_config commands.
307if have_mysql:
308    mysql_config_include = mysql_config + ' --include'
309    if os.system(mysql_config_include + ' > /dev/null') != 0:
310        # older mysql_config versions don't support --include, use
311        # --cflags instead
312        mysql_config_include = mysql_config + ' --cflags | sed s/\\\'//g'
313    # This seems to work in all versions
314    mysql_config_libs = mysql_config + ' --libs'
315
316env = conf.Finish()
317
318# Define the universe of supported ISAs
319env['ALL_ISA_LIST'] = ['alpha', 'sparc', 'mips']
320
321# Define the universe of supported CPU models
322env['ALL_CPU_LIST'] = ['AtomicSimpleCPU', 'TimingSimpleCPU',
323                       'FullCPU', 'O3CPU',
324                       'OzoneCPU']
325
326# Sticky options get saved in the options file so they persist from
327# one invocation to the next (unless overridden, in which case the new
328# value becomes sticky).
329sticky_opts = Options(args=ARGUMENTS)
330sticky_opts.AddOptions(
331    EnumOption('TARGET_ISA', 'Target ISA', 'alpha', env['ALL_ISA_LIST']),
332    BoolOption('FULL_SYSTEM', 'Full-system support', False),
333    # There's a bug in scons 0.96.1 that causes ListOptions with list
334    # values (more than one value) not to be able to be restored from
335    # a saved option file.  If this causes trouble then upgrade to
336    # scons 0.96.90 or later.
337    ListOption('CPU_MODELS', 'CPU models', 'AtomicSimpleCPU,TimingSimpleCPU',
338               env['ALL_CPU_LIST']),
339    BoolOption('ALPHA_TLASER',
340               'Model Alpha TurboLaser platform (vs. Tsunami)', False),
341    BoolOption('NO_FAST_ALLOC', 'Disable fast object allocator', False),
342    BoolOption('EFENCE', 'Link with Electric Fence malloc debugger',
343               False),
344    BoolOption('SS_COMPATIBLE_FP',
345               'Make floating-point results compatible with SimpleScalar',
346               False),
347    BoolOption('USE_SSE2',
348               'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
349               False),
350    BoolOption('USE_MYSQL', 'Use MySQL for stats output', have_mysql),
351    BoolOption('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
352    BoolOption('USE_CHECKER', 'Use checker for detailed CPU models', False),
353    ('CC', 'C compiler', os.environ.get('CC', env['CC'])),
354    ('CXX', 'C++ compiler', os.environ.get('CXX', env['CXX'])),
355    BoolOption('BATCH', 'Use batch pool for build and tests', False),
356    ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
357    ('PYTHONHOME',
358     'Override the default PYTHONHOME for this system (use with caution)',
359     '%s:%s' % (sys.prefix, sys.exec_prefix))
360    )
361
362# Non-sticky options only apply to the current build.
363nonsticky_opts = Options(args=ARGUMENTS)
364nonsticky_opts.AddOptions(
365    BoolOption('update_ref', 'Update test reference outputs', False)
366    )
367
368# These options get exported to #defines in config/*.hh (see src/SConscript).
369env.ExportOptions = ['FULL_SYSTEM', 'ALPHA_TLASER', 'USE_FENV', \
370                     'USE_MYSQL', 'NO_FAST_ALLOC', 'SS_COMPATIBLE_FP', \
371                     'USE_CHECKER', 'PYTHONHOME']
372
373# Define a handy 'no-op' action
374def no_action(target, source, env):
375    return 0
376
377env.NoAction = Action(no_action, None)
378
379###################################################
380#
381# Define a SCons builder for configuration flag headers.
382#
383###################################################
384
385# This function generates a config header file that #defines the
386# option symbol to the current option setting (0 or 1).  The source
387# operands are the name of the option and a Value node containing the
388# value of the option.
389def build_config_file(target, source, env):
390    (option, value) = [s.get_contents() for s in source]
391    f = file(str(target[0]), 'w')
392    print >> f, '#define', option, value
393    f.close()
394    return None
395
396# Generate the message to be printed when building the config file.
397def build_config_file_string(target, source, env):
398    (option, value) = [s.get_contents() for s in source]
399    return "Defining %s as %s in %s." % (option, value, target[0])
400
401# Combine the two functions into a scons Action object.
402config_action = Action(build_config_file, build_config_file_string)
403
404# The emitter munges the source & target node lists to reflect what
405# we're really doing.
406def config_emitter(target, source, env):
407    # extract option name from Builder arg
408    option = str(target[0])
409    # True target is config header file
410    target = os.path.join('config', option.lower() + '.hh')
411    val = env[option]
412    if isinstance(val, bool):
413        # Force value to 0/1
414        val = int(val)
415    elif isinstance(val, str):
416        val = '"' + val + '"'
417        
418    # Sources are option name & value (packaged in SCons Value nodes)
419    return ([target], [Value(option), Value(val)])
420
421config_builder = Builder(emitter = config_emitter, action = config_action)
422
423env.Append(BUILDERS = { 'ConfigFile' : config_builder })
424
425###################################################
426#
427# Define a SCons builder for copying files.  This is used by the
428# Python zipfile code in src/python/SConscript, but is placed up here
429# since it's potentially more generally applicable.
430#
431###################################################
432
433copy_builder = Builder(action = Copy("$TARGET", "$SOURCE"))
434
435env.Append(BUILDERS = { 'CopyFile' : copy_builder })
436
437###################################################
438#
439# Define a simple SCons builder to concatenate files.
440#
441# Used to append the Python zip archive to the executable.
442#
443###################################################
444
445concat_builder = Builder(action = Action(['cat $SOURCES > $TARGET',
446                                          'chmod +x $TARGET']))
447
448env.Append(BUILDERS = { 'Concat' : concat_builder })
449
450
451# base help text
452help_text = '''
453Usage: scons [scons options] [build options] [target(s)]
454
455'''
456
457# libelf build is shared across all configs in the build root.
458env.SConscript('ext/libelf/SConscript',
459               build_dir = os.path.join(build_root, 'libelf'),
460               exports = 'env')
461
462###################################################
463#
464# This function is used to set up a directory with switching headers
465#
466###################################################
467
468def make_switching_dir(dirname, switch_headers, env):
469    # Generate the header.  target[0] is the full path of the output
470    # header to generate.  'source' is a dummy variable, since we get the
471    # list of ISAs from env['ALL_ISA_LIST'].
472    def gen_switch_hdr(target, source, env):
473	fname = str(target[0])
474	basename = os.path.basename(fname)
475	f = open(fname, 'w')
476	f.write('#include "arch/isa_specific.hh"\n')
477	cond = '#if'
478	for isa in env['ALL_ISA_LIST']:
479	    f.write('%s THE_ISA == %s_ISA\n#include "%s/%s/%s"\n'
480		    % (cond, isa.upper(), dirname, isa, basename))
481	    cond = '#elif'
482	f.write('#else\n#error "THE_ISA not set"\n#endif\n')
483	f.close()
484	return 0
485
486    # String to print when generating header
487    def gen_switch_hdr_string(target, source, env):
488	return "Generating switch header " + str(target[0])
489
490    # Build SCons Action object. 'varlist' specifies env vars that this
491    # action depends on; when env['ALL_ISA_LIST'] changes these actions
492    # should get re-executed.
493    switch_hdr_action = Action(gen_switch_hdr, gen_switch_hdr_string,
494                               varlist=['ALL_ISA_LIST'])
495
496    # Instantiate actions for each header
497    for hdr in switch_headers:
498        env.Command(hdr, [], switch_hdr_action)
499
500env.make_switching_dir = make_switching_dir
501
502###################################################
503#
504# Define build environments for selected configurations.
505#
506###################################################
507
508# rename base env
509base_env = env
510
511for build_path in build_paths:
512    print "Building in", build_path
513    # build_dir is the tail component of build path, and is used to
514    # determine the build parameters (e.g., 'ALPHA_SE')
515    (build_root, build_dir) = os.path.split(build_path)
516    # Make a copy of the build-root environment to use for this config.
517    env = base_env.Copy()
518
519    # Set env options according to the build directory config.
520    sticky_opts.files = []
521    # Options for $BUILD_ROOT/$BUILD_DIR are stored in
522    # $BUILD_ROOT/options/$BUILD_DIR so you can nuke
523    # $BUILD_ROOT/$BUILD_DIR without losing your options settings.
524    current_opts_file = os.path.join(build_root, 'options', build_dir)
525    if os.path.isfile(current_opts_file):
526        sticky_opts.files.append(current_opts_file)
527        print "Using saved options file %s" % current_opts_file
528    else:
529        # Build dir-specific options file doesn't exist.
530
531        # Make sure the directory is there so we can create it later
532        opt_dir = os.path.dirname(current_opts_file)
533        if not os.path.isdir(opt_dir):
534            os.mkdir(opt_dir)
535
536        # Get default build options from source tree.  Options are
537        # normally determined by name of $BUILD_DIR, but can be
538        # overriden by 'default=' arg on command line.
539        default_opts_file = os.path.join('build_opts',
540                                         ARGUMENTS.get('default', build_dir))
541        if os.path.isfile(default_opts_file):
542            sticky_opts.files.append(default_opts_file)
543            print "Options file %s not found,\n  using defaults in %s" \
544                  % (current_opts_file, default_opts_file)
545        else:
546            print "Error: cannot find options file %s or %s" \
547                  % (current_opts_file, default_opts_file)
548            Exit(1)
549
550    # Apply current option settings to env
551    sticky_opts.Update(env)
552    nonsticky_opts.Update(env)
553
554    help_text += "Sticky options for %s:\n" % build_dir \
555                 + sticky_opts.GenerateHelpText(env) \
556                 + "\nNon-sticky options for %s:\n" % build_dir \
557                 + nonsticky_opts.GenerateHelpText(env)
558
559    # Process option settings.
560
561    if not have_fenv and env['USE_FENV']:
562        print "Warning: <fenv.h> not available; " \
563              "forcing USE_FENV to False in", build_dir + "."
564        env['USE_FENV'] = False
565
566    if not env['USE_FENV']:
567        print "Warning: No IEEE FP rounding mode control in", build_dir + "."
568        print "         FP results may deviate slightly from other platforms."
569
570    if env['EFENCE']:
571        env.Append(LIBS=['efence'])
572
573    if env['USE_MYSQL']:
574        if not have_mysql:
575            print "Warning: MySQL not available; " \
576                  "forcing USE_MYSQL to False in", build_dir + "."
577            env['USE_MYSQL'] = False
578        else:
579            print "Compiling in", build_dir, "with MySQL support."
580            env.ParseConfig(mysql_config_libs)
581            env.ParseConfig(mysql_config_include)
582
583    # Save sticky option settings back to current options file
584    sticky_opts.Save(current_opts_file, env)
585
586    # Do this after we save setting back, or else we'll tack on an
587    # extra 'qdo' every time we run scons.
588    if env['BATCH']:
589        env['CC']  = env['BATCH_CMD'] + ' ' + env['CC']
590        env['CXX'] = env['BATCH_CMD'] + ' ' + env['CXX']
591
592    if env['USE_SSE2']:
593        env.Append(CCFLAGS='-msse2')
594
595    # The src/SConscript file sets up the build rules in 'env' according
596    # to the configured options.  It returns a list of environments,
597    # one for each variant build (debug, opt, etc.)
598    envList = SConscript('src/SConscript', build_dir = build_path,
599                         exports = 'env')
600
601    # Set up the regression tests for each build.
602    for e in envList:
603        SConscript('tests/SConscript',
604                   build_dir = os.path.join(build_path, 'tests', e.Label),
605                   exports = { 'env' : e }, duplicate = False)
606
607Help(help_text)
608
609
610###################################################
611#
612# Let SCons do its thing.  At this point SCons will use the defined
613# build environments to build the requested targets.
614#
615###################################################
616
617