SConstruct revision 7827
1# -*- mode:python -*-
2
3# Copyright (c) 2011 Advanced Micro Devices, Inc.
4# Copyright (c) 2009 The Hewlett-Packard Development Company
5# Copyright (c) 2004-2005 The Regents of The University of Michigan
6# All rights reserved.
7#
8# Redistribution and use in source and binary forms, with or without
9# modification, are permitted provided that the following conditions are
10# met: redistributions of source code must retain the above copyright
11# notice, this list of conditions and the following disclaimer;
12# redistributions in binary form must reproduce the above copyright
13# notice, this list of conditions and the following disclaimer in the
14# documentation and/or other materials provided with the distribution;
15# neither the name of the copyright holders nor the names of its
16# contributors may be used to endorse or promote products derived from
17# this software without specific prior written permission.
18#
19# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30#
31# Authors: Steve Reinhardt
32#          Nathan Binkert
33
34###################################################
35#
36# SCons top-level build description (SConstruct) file.
37#
38# While in this directory ('m5'), just type 'scons' to build the default
39# configuration (see below), or type 'scons build/<CONFIG>/<binary>'
40# to build some other configuration (e.g., 'build/ALPHA_FS/m5.opt' for
41# the optimized full-system version).
42#
43# You can build M5 in a different directory as long as there is a
44# 'build/<CONFIG>' somewhere along the target path.  The build system
45# expects that all configs under the same build directory are being
46# built for the same host system.
47#
48# Examples:
49#
50#   The following two commands are equivalent.  The '-u' option tells
51#   scons to search up the directory tree for this SConstruct file.
52#   % cd <path-to-src>/m5 ; scons build/ALPHA_FS/m5.debug
53#   % cd <path-to-src>/m5/build/ALPHA_FS; scons -u m5.debug
54#
55#   The following two commands are equivalent and demonstrate building
56#   in a directory outside of the source tree.  The '-C' option tells
57#   scons to chdir to the specified directory to find this SConstruct
58#   file.
59#   % cd <path-to-src>/m5 ; scons /local/foo/build/ALPHA_FS/m5.debug
60#   % cd /local/foo/build/ALPHA_FS; scons -C <path-to-src>/m5 m5.debug
61#
62# You can use 'scons -H' to print scons options.  If you're in this
63# 'm5' directory (or use -u or -C to tell scons where to find this
64# file), you can use 'scons -h' to print all the M5-specific build
65# options as well.
66#
67###################################################
68
69# Check for recent-enough Python and SCons versions.
70try:
71    # Really old versions of scons only take two options for the
72    # function, so check once without the revision and once with the
73    # revision, the first instance will fail for stuff other than
74    # 0.98, and the second will fail for 0.98.0
75    EnsureSConsVersion(0, 98)
76    EnsureSConsVersion(0, 98, 1)
77except SystemExit, e:
78    print """
79For more details, see:
80    http://m5sim.org/wiki/index.php/Compiling_M5
81"""
82    raise
83
84# We ensure the python version early because we have stuff that
85# requires python 2.4
86try:
87    EnsurePythonVersion(2, 4)
88except SystemExit, e:
89    print """
90You can use a non-default installation of the Python interpreter by
91either (1) rearranging your PATH so that scons finds the non-default
92'python' first or (2) explicitly invoking an alternative interpreter
93on the scons script.
94
95For more details, see:
96    http://m5sim.org/wiki/index.php/Using_a_non-default_Python_installation
97"""
98    raise
99
100# Global Python includes
101import os
102import re
103import subprocess
104import sys
105
106from os import mkdir, environ
107from os.path import abspath, basename, dirname, expanduser, normpath
108from os.path import exists,  isdir, isfile
109from os.path import join as joinpath, split as splitpath
110
111# SCons includes
112import SCons
113import SCons.Node
114
115extra_python_paths = [
116    Dir('src/python').srcnode().abspath, # M5 includes
117    Dir('ext/ply').srcnode().abspath, # ply is used by several files
118    ]
119    
120sys.path[1:1] = extra_python_paths
121
122from m5.util import compareVersions, readCommand
123
124AddOption('--colors', dest='use_colors', action='store_true')
125AddOption('--no-colors', dest='use_colors', action='store_false')
126use_colors = GetOption('use_colors')
127
128if use_colors:
129    from m5.util.terminal import termcap
130elif use_colors is None:
131    # option unspecified; default behavior is to use colors iff isatty
132    from m5.util.terminal import tty_termcap as termcap
133else:
134    from m5.util.terminal import no_termcap as termcap
135
136########################################################################
137#
138# Set up the main build environment.
139#
140########################################################################
141use_vars = set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH', 'PATH',
142                 'PYTHONPATH', 'RANLIB' ])
143
144use_env = {}
145for key,val in os.environ.iteritems():
146    if key in use_vars or key.startswith("M5"):
147        use_env[key] = val
148
149main = Environment(ENV=use_env)
150main.root = Dir(".")         # The current directory (where this file lives).
151main.srcdir = Dir("src")     # The source directory
152
153# add useful python code PYTHONPATH so it can be used by subprocesses
154# as well
155main.AppendENVPath('PYTHONPATH', extra_python_paths)
156
157########################################################################
158#
159# Mercurial Stuff.
160#
161# If the M5 directory is a mercurial repository, we should do some
162# extra things.
163#
164########################################################################
165
166hgdir = main.root.Dir(".hg")
167
168mercurial_style_message = """
169You're missing the M5 style hook.
170Please install the hook so we can ensure that all code fits a common style.
171
172All you'd need to do is add the following lines to your repository .hg/hgrc
173or your personal .hgrc
174----------------
175
176[extensions]
177style = %s/util/style.py
178
179[hooks]
180pretxncommit.style = python:style.check_style
181pre-qrefresh.style = python:style.check_style
182""" % (main.root)
183
184mercurial_bin_not_found = """
185Mercurial binary cannot be found, unfortunately this means that we
186cannot easily determine the version of M5 that you are running and
187this makes error messages more difficult to collect.  Please consider
188installing mercurial if you choose to post an error message
189"""
190
191mercurial_lib_not_found = """
192Mercurial libraries cannot be found, ignoring style hook
193If you are actually a M5 developer, please fix this and
194run the style hook. It is important.
195"""
196
197hg_info = "Unknown"
198if hgdir.exists():
199    # 1) Grab repository revision if we know it.
200    cmd = "hg id -n -i -t -b"
201    try:
202        hg_info = readCommand(cmd, cwd=main.root.abspath).strip()
203    except OSError:
204        print mercurial_bin_not_found
205
206    # 2) Ensure that the style hook is in place.
207    try:
208        ui = None
209        if ARGUMENTS.get('IGNORE_STYLE') != 'True':
210            from mercurial import ui
211            ui = ui.ui()
212    except ImportError:
213        print mercurial_lib_not_found
214
215    if ui is not None:
216        ui.readconfig(hgdir.File('hgrc').abspath)
217        style_hook = ui.config('hooks', 'pretxncommit.style', None)
218
219        if not style_hook:
220            print mercurial_style_message
221            sys.exit(1)
222else:
223    print ".hg directory not found"
224
225main['HG_INFO'] = hg_info
226
227###################################################
228#
229# Figure out which configurations to set up based on the path(s) of
230# the target(s).
231#
232###################################################
233
234# Find default configuration & binary.
235Default(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA_SE/m5.debug'))
236
237# helper function: find last occurrence of element in list
238def rfind(l, elt, offs = -1):
239    for i in range(len(l)+offs, 0, -1):
240        if l[i] == elt:
241            return i
242    raise ValueError, "element not found"
243
244# Each target must have 'build' in the interior of the path; the
245# directory below this will determine the build parameters.  For
246# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
247# recognize that ALPHA_SE specifies the configuration because it
248# follow 'build' in the bulid path.
249
250# Generate absolute paths to targets so we can see where the build dir is
251if COMMAND_LINE_TARGETS:
252    # Ask SCons which directory it was invoked from
253    launch_dir = GetLaunchDir()
254    # Make targets relative to invocation directory
255    abs_targets = [ normpath(joinpath(launch_dir, str(x))) for x in \
256                    COMMAND_LINE_TARGETS]
257else:
258    # Default targets are relative to root of tree
259    abs_targets = [ normpath(joinpath(main.root.abspath, str(x))) for x in \
260                    DEFAULT_TARGETS]
261
262
263# Generate a list of the unique build roots and configs that the
264# collected targets reference.
265variant_paths = []
266build_root = None
267for t in abs_targets:
268    path_dirs = t.split('/')
269    try:
270        build_top = rfind(path_dirs, 'build', -2)
271    except:
272        print "Error: no non-leaf 'build' dir found on target path", t
273        Exit(1)
274    this_build_root = joinpath('/',*path_dirs[:build_top+1])
275    if not build_root:
276        build_root = this_build_root
277    else:
278        if this_build_root != build_root:
279            print "Error: build targets not under same build root\n"\
280                  "  %s\n  %s" % (build_root, this_build_root)
281            Exit(1)
282    variant_path = joinpath('/',*path_dirs[:build_top+2])
283    if variant_path not in variant_paths:
284        variant_paths.append(variant_path)
285
286# Make sure build_root exists (might not if this is the first build there)
287if not isdir(build_root):
288    mkdir(build_root)
289main['BUILDROOT'] = build_root
290
291Export('main')
292
293main.SConsignFile(joinpath(build_root, "sconsign"))
294
295# Default duplicate option is to use hard links, but this messes up
296# when you use emacs to edit a file in the target dir, as emacs moves
297# file to file~ then copies to file, breaking the link.  Symbolic
298# (soft) links work better.
299main.SetOption('duplicate', 'soft-copy')
300
301#
302# Set up global sticky variables... these are common to an entire build
303# tree (not specific to a particular build like ALPHA_SE)
304#
305
306# Variable validators & converters for global sticky variables
307def PathListMakeAbsolute(val):
308    if not val:
309        return val
310    f = lambda p: abspath(expanduser(p))
311    return ':'.join(map(f, val.split(':')))
312
313def PathListAllExist(key, val, env):
314    if not val:
315        return
316    paths = val.split(':')
317    for path in paths:
318        if not isdir(path):
319            raise SCons.Errors.UserError("Path does not exist: '%s'" % path)
320
321global_sticky_vars_file = joinpath(build_root, 'variables.global')
322
323global_sticky_vars = Variables(global_sticky_vars_file, args=ARGUMENTS)
324global_nonsticky_vars = Variables(args=ARGUMENTS)
325
326global_sticky_vars.AddVariables(
327    ('CC', 'C compiler', environ.get('CC', main['CC'])),
328    ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])),
329    ('BATCH', 'Use batch pool for build and tests', False),
330    ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
331    ('M5_BUILD_CACHE', 'Cache built objects in this directory', False),
332    ('EXTRAS', 'Add Extra directories to the compilation', '',
333     PathListAllExist, PathListMakeAbsolute),
334    )
335
336global_nonsticky_vars.AddVariables(
337    ('VERBOSE', 'Print full tool command lines', False),
338    ('update_ref', 'Update test reference outputs', False)
339    )
340
341
342# base help text
343help_text = '''
344Usage: scons [scons options] [build options] [target(s)]
345
346Global sticky options:
347'''
348
349# Update main environment with values from ARGUMENTS & global_sticky_vars_file
350global_sticky_vars.Update(main)
351global_nonsticky_vars.Update(main)
352
353help_text += global_sticky_vars.GenerateHelpText(main)
354help_text += global_nonsticky_vars.GenerateHelpText(main)
355
356# Save sticky variable settings back to current variables file
357global_sticky_vars.Save(global_sticky_vars_file, main)
358
359# Parse EXTRAS variable to build list of all directories where we're
360# look for sources etc.  This list is exported as base_dir_list.
361base_dir = main.srcdir.abspath
362if main['EXTRAS']:
363    extras_dir_list = main['EXTRAS'].split(':')
364else:
365    extras_dir_list = []
366
367Export('base_dir')
368Export('extras_dir_list')
369
370# the ext directory should be on the #includes path
371main.Append(CPPPATH=[Dir('ext')])
372
373def strip_build_path(path, env):
374    path = str(path)
375    variant_base = env['BUILDROOT'] + os.path.sep
376    if path.startswith(variant_base):
377        path = path[len(variant_base):]
378    elif path.startswith('build/'):
379        path = path[6:]
380    return path
381
382# Generate a string of the form:
383#   common/path/prefix/src1, src2 -> tgt1, tgt2
384# to print while building.
385class Transform(object):
386    # all specific color settings should be here and nowhere else
387    tool_color = termcap.Normal
388    pfx_color = termcap.Yellow
389    srcs_color = termcap.Yellow + termcap.Bold
390    arrow_color = termcap.Blue + termcap.Bold
391    tgts_color = termcap.Yellow + termcap.Bold
392
393    def __init__(self, tool, max_sources=99):
394        self.format = self.tool_color + (" [%8s] " % tool) \
395                      + self.pfx_color + "%s" \
396                      + self.srcs_color + "%s" \
397                      + self.arrow_color + " -> " \
398                      + self.tgts_color + "%s" \
399                      + termcap.Normal
400        self.max_sources = max_sources
401
402    def __call__(self, target, source, env, for_signature=None):
403        # truncate source list according to max_sources param
404        source = source[0:self.max_sources]
405        def strip(f):
406            return strip_build_path(str(f), env)
407        if len(source) > 0:
408            srcs = map(strip, source)
409        else:
410            srcs = ['']
411        tgts = map(strip, target)
412        # surprisingly, os.path.commonprefix is a dumb char-by-char string
413        # operation that has nothing to do with paths.
414        com_pfx = os.path.commonprefix(srcs + tgts)
415        com_pfx_len = len(com_pfx)
416        if com_pfx:
417            # do some cleanup and sanity checking on common prefix
418            if com_pfx[-1] == ".":
419                # prefix matches all but file extension: ok
420                # back up one to change 'foo.cc -> o' to 'foo.cc -> .o'
421                com_pfx = com_pfx[0:-1]
422            elif com_pfx[-1] == "/":
423                # common prefix is directory path: OK
424                pass
425            else:
426                src0_len = len(srcs[0])
427                tgt0_len = len(tgts[0])
428                if src0_len == com_pfx_len:
429                    # source is a substring of target, OK
430                    pass
431                elif tgt0_len == com_pfx_len:
432                    # target is a substring of source, need to back up to
433                    # avoid empty string on RHS of arrow
434                    sep_idx = com_pfx.rfind(".")
435                    if sep_idx != -1:
436                        com_pfx = com_pfx[0:sep_idx]
437                    else:
438                        com_pfx = ''
439                elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".":
440                    # still splitting at file extension: ok
441                    pass
442                else:
443                    # probably a fluke; ignore it
444                    com_pfx = ''
445        # recalculate length in case com_pfx was modified
446        com_pfx_len = len(com_pfx)
447        def fmt(files):
448            f = map(lambda s: s[com_pfx_len:], files)
449            return ', '.join(f)
450        return self.format % (com_pfx, fmt(srcs), fmt(tgts))
451
452Export('Transform')
453
454
455if main['VERBOSE']:
456    def MakeAction(action, string, *args, **kwargs):
457        return Action(action, *args, **kwargs)
458else:
459    MakeAction = Action
460    main['CCCOMSTR']        = Transform("CC")
461    main['CXXCOMSTR']       = Transform("CXX")
462    main['ASCOMSTR']        = Transform("AS")
463    main['SWIGCOMSTR']      = Transform("SWIG")
464    main['ARCOMSTR']        = Transform("AR", 0)
465    main['LINKCOMSTR']      = Transform("LINK", 0)
466    main['RANLIBCOMSTR']    = Transform("RANLIB", 0)
467    main['M4COMSTR']        = Transform("M4")
468    main['SHCCCOMSTR']      = Transform("SHCC")
469    main['SHCXXCOMSTR']     = Transform("SHCXX")
470Export('MakeAction')
471
472CXX_version = readCommand([main['CXX'],'--version'], exception=False)
473CXX_V = readCommand([main['CXX'],'-V'], exception=False)
474
475main['GCC'] = CXX_version and CXX_version.find('g++') >= 0
476main['SUNCC'] = CXX_V and CXX_V.find('Sun C++') >= 0
477main['ICC'] = CXX_V and CXX_V.find('Intel') >= 0
478if main['GCC'] + main['SUNCC'] + main['ICC'] > 1:
479    print 'Error: How can we have two at the same time?'
480    Exit(1)
481
482# Set up default C++ compiler flags
483if main['GCC']:
484    main.Append(CCFLAGS=['-pipe'])
485    main.Append(CCFLAGS=['-fno-strict-aliasing'])
486    main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef'])
487    main.Append(CXXFLAGS=['-Wno-deprecated'])
488    # Read the GCC version to check for versions with bugs
489    # Note CCVERSION doesn't work here because it is run with the CC
490    # before we override it from the command line
491    gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False)
492    if not compareVersions(gcc_version, '4.4.1') or \
493       not compareVersions(gcc_version, '4.4.2'):
494        print 'Info: Tree vectorizer in GCC 4.4.1 & 4.4.2 is buggy, disabling.'
495        main.Append(CCFLAGS=['-fno-tree-vectorize'])
496elif main['ICC']:
497    pass #Fix me... add warning flags once we clean up icc warnings
498elif main['SUNCC']:
499    main.Append(CCFLAGS=['-Qoption ccfe'])
500    main.Append(CCFLAGS=['-features=gcc'])
501    main.Append(CCFLAGS=['-features=extensions'])
502    main.Append(CCFLAGS=['-library=stlport4'])
503    main.Append(CCFLAGS=['-xar'])
504    #main.Append(CCFLAGS=['-instances=semiexplicit'])
505else:
506    print 'Error: Don\'t know what compiler options to use for your compiler.'
507    print '       Please fix SConstruct and src/SConscript and try again.'
508    Exit(1)
509
510# Set up common yacc/bison flags (needed for Ruby)
511main['YACCFLAGS'] = '-d'
512main['YACCHXXFILESUFFIX'] = '.hh'
513
514# Do this after we save setting back, or else we'll tack on an
515# extra 'qdo' every time we run scons.
516if main['BATCH']:
517    main['CC']     = main['BATCH_CMD'] + ' ' + main['CC']
518    main['CXX']    = main['BATCH_CMD'] + ' ' + main['CXX']
519    main['AS']     = main['BATCH_CMD'] + ' ' + main['AS']
520    main['AR']     = main['BATCH_CMD'] + ' ' + main['AR']
521    main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB']
522
523if sys.platform == 'cygwin':
524    # cygwin has some header file issues...
525    main.Append(CCFLAGS=["-Wno-uninitialized"])
526
527# Check for SWIG
528if not main.has_key('SWIG'):
529    print 'Error: SWIG utility not found.'
530    print '       Please install (see http://www.swig.org) and retry.'
531    Exit(1)
532
533# Check for appropriate SWIG version
534swig_version = readCommand(('swig', '-version'), exception='').split()
535# First 3 words should be "SWIG Version x.y.z"
536if len(swig_version) < 3 or \
537        swig_version[0] != 'SWIG' or swig_version[1] != 'Version':
538    print 'Error determining SWIG version.'
539    Exit(1)
540
541min_swig_version = '1.3.28'
542if compareVersions(swig_version[2], min_swig_version) < 0:
543    print 'Error: SWIG version', min_swig_version, 'or newer required.'
544    print '       Installed version:', swig_version[2]
545    Exit(1)
546
547# Set up SWIG flags & scanner
548swig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
549main.Append(SWIGFLAGS=swig_flags)
550
551# filter out all existing swig scanners, they mess up the dependency
552# stuff for some reason
553scanners = []
554for scanner in main['SCANNERS']:
555    skeys = scanner.skeys
556    if skeys == '.i':
557        continue
558
559    if isinstance(skeys, (list, tuple)) and '.i' in skeys:
560        continue
561
562    scanners.append(scanner)
563
564# add the new swig scanner that we like better
565from SCons.Scanner import ClassicCPP as CPPScanner
566swig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
567scanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re))
568
569# replace the scanners list that has what we want
570main['SCANNERS'] = scanners
571
572# Add a custom Check function to the Configure context so that we can
573# figure out if the compiler adds leading underscores to global
574# variables.  This is needed for the autogenerated asm files that we
575# use for embedding the python code.
576def CheckLeading(context):
577    context.Message("Checking for leading underscore in global variables...")
578    # 1) Define a global variable called x from asm so the C compiler
579    #    won't change the symbol at all.
580    # 2) Declare that variable.
581    # 3) Use the variable
582    #
583    # If the compiler prepends an underscore, this will successfully
584    # link because the external symbol 'x' will be called '_x' which
585    # was defined by the asm statement.  If the compiler does not
586    # prepend an underscore, this will not successfully link because
587    # '_x' will have been defined by assembly, while the C portion of
588    # the code will be trying to use 'x'
589    ret = context.TryLink('''
590        asm(".globl _x; _x: .byte 0");
591        extern int x;
592        int main() { return x; }
593        ''', extension=".c")
594    context.env.Append(LEADING_UNDERSCORE=ret)
595    context.Result(ret)
596    return ret
597
598# Platform-specific configuration.  Note again that we assume that all
599# builds under a given build root run on the same host platform.
600conf = Configure(main,
601                 conf_dir = joinpath(build_root, '.scons_config'),
602                 log_file = joinpath(build_root, 'scons_config.log'),
603                 custom_tests = { 'CheckLeading' : CheckLeading })
604
605# Check for leading underscores.  Don't really need to worry either
606# way so don't need to check the return code.
607conf.CheckLeading()
608
609# Check if we should compile a 64 bit binary on Mac OS X/Darwin
610try:
611    import platform
612    uname = platform.uname()
613    if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0:
614        if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
615            main.Append(CCFLAGS=['-arch', 'x86_64'])
616            main.Append(CFLAGS=['-arch', 'x86_64'])
617            main.Append(LINKFLAGS=['-arch', 'x86_64'])
618            main.Append(ASFLAGS=['-arch', 'x86_64'])
619except:
620    pass
621
622# Recent versions of scons substitute a "Null" object for Configure()
623# when configuration isn't necessary, e.g., if the "--help" option is
624# present.  Unfortuantely this Null object always returns false,
625# breaking all our configuration checks.  We replace it with our own
626# more optimistic null object that returns True instead.
627if not conf:
628    def NullCheck(*args, **kwargs):
629        return True
630
631    class NullConf:
632        def __init__(self, env):
633            self.env = env
634        def Finish(self):
635            return self.env
636        def __getattr__(self, mname):
637            return NullCheck
638
639    conf = NullConf(main)
640
641# Find Python include and library directories for embedding the
642# interpreter.  For consistency, we will use the same Python
643# installation used to run scons (and thus this script).  If you want
644# to link in an alternate version, see above for instructions on how
645# to invoke scons with a different copy of the Python interpreter.
646from distutils import sysconfig
647
648py_getvar = sysconfig.get_config_var
649
650py_debug = getattr(sys, 'pydebug', False)
651py_version = 'python' + py_getvar('VERSION') + (py_debug and "_d" or "")
652
653py_general_include = sysconfig.get_python_inc()
654py_platform_include = sysconfig.get_python_inc(plat_specific=True)
655py_includes = [ py_general_include ]
656if py_platform_include != py_general_include:
657    py_includes.append(py_platform_include)
658
659py_lib_path = [ py_getvar('LIBDIR') ]
660# add the prefix/lib/pythonX.Y/config dir, but only if there is no
661# shared library in prefix/lib/.
662if not py_getvar('Py_ENABLE_SHARED'):
663    py_lib_path.append(py_getvar('LIBPL'))
664
665py_libs = []
666for lib in py_getvar('LIBS').split() + py_getvar('SYSLIBS').split():
667    assert lib.startswith('-l')
668    lib = lib[2:]   
669    if lib not in py_libs:
670        py_libs.append(lib)
671py_libs.append(py_version)
672
673main.Append(CPPPATH=py_includes)
674main.Append(LIBPATH=py_lib_path)
675
676# Cache build files in the supplied directory.
677if main['M5_BUILD_CACHE']:
678    print 'Using build cache located at', main['M5_BUILD_CACHE']
679    CacheDir(main['M5_BUILD_CACHE'])
680
681
682# verify that this stuff works
683if not conf.CheckHeader('Python.h', '<>'):
684    print "Error: can't find Python.h header in", py_includes
685    Exit(1)
686
687for lib in py_libs:
688    if not conf.CheckLib(lib):
689        print "Error: can't find library %s required by python" % lib
690        Exit(1)
691
692# On Solaris you need to use libsocket for socket ops
693if not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
694   if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
695       print "Can't find library with socket calls (e.g. accept())"
696       Exit(1)
697
698# Check for zlib.  If the check passes, libz will be automatically
699# added to the LIBS environment variable.
700if not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
701    print 'Error: did not find needed zlib compression library '\
702          'and/or zlib.h header file.'
703    print '       Please install zlib and try again.'
704    Exit(1)
705
706# Check for <fenv.h> (C99 FP environment control)
707have_fenv = conf.CheckHeader('fenv.h', '<>')
708if not have_fenv:
709    print "Warning: Header file <fenv.h> not found."
710    print "         This host has no IEEE FP rounding mode control."
711
712######################################################################
713#
714# Check for mysql.
715#
716mysql_config = WhereIs('mysql_config')
717have_mysql = bool(mysql_config)
718
719# Check MySQL version.
720if have_mysql:
721    mysql_version = readCommand(mysql_config + ' --version')
722    min_mysql_version = '4.1'
723    if compareVersions(mysql_version, min_mysql_version) < 0:
724        print 'Warning: MySQL', min_mysql_version, 'or newer required.'
725        print '         Version', mysql_version, 'detected.'
726        have_mysql = False
727
728# Set up mysql_config commands.
729if have_mysql:
730    mysql_config_include = mysql_config + ' --include'
731    if os.system(mysql_config_include + ' > /dev/null') != 0:
732        # older mysql_config versions don't support --include, use
733        # --cflags instead
734        mysql_config_include = mysql_config + ' --cflags | sed s/\\\'//g'
735    # This seems to work in all versions
736    mysql_config_libs = mysql_config + ' --libs'
737
738######################################################################
739#
740# Finish the configuration
741#
742main = conf.Finish()
743
744######################################################################
745#
746# Collect all non-global variables
747#
748
749# Define the universe of supported ISAs
750all_isa_list = [ ]
751Export('all_isa_list')
752
753class CpuModel(object):
754    '''The CpuModel class encapsulates everything the ISA parser needs to
755    know about a particular CPU model.'''
756
757    # Dict of available CPU model objects.  Accessible as CpuModel.dict.
758    dict = {}
759    list = []
760    defaults = []
761
762    # Constructor.  Automatically adds models to CpuModel.dict.
763    def __init__(self, name, filename, includes, strings, default=False):
764        self.name = name           # name of model
765        self.filename = filename   # filename for output exec code
766        self.includes = includes   # include files needed in exec file
767        # The 'strings' dict holds all the per-CPU symbols we can
768        # substitute into templates etc.
769        self.strings = strings
770
771        # This cpu is enabled by default
772        self.default = default
773
774        # Add self to dict
775        if name in CpuModel.dict:
776            raise AttributeError, "CpuModel '%s' already registered" % name
777        CpuModel.dict[name] = self
778        CpuModel.list.append(name)
779
780Export('CpuModel')
781
782# Sticky variables get saved in the variables file so they persist from
783# one invocation to the next (unless overridden, in which case the new
784# value becomes sticky).
785sticky_vars = Variables(args=ARGUMENTS)
786Export('sticky_vars')
787
788# Sticky variables that should be exported
789export_vars = []
790Export('export_vars')
791
792# Walk the tree and execute all SConsopts scripts that wil add to the
793# above variables
794for bdir in [ base_dir ] + extras_dir_list:
795    for root, dirs, files in os.walk(bdir):
796        if 'SConsopts' in files:
797            print "Reading", joinpath(root, 'SConsopts')
798            SConscript(joinpath(root, 'SConsopts'))
799
800all_isa_list.sort()
801
802sticky_vars.AddVariables(
803    EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list),
804    BoolVariable('FULL_SYSTEM', 'Full-system support', False),
805    ListVariable('CPU_MODELS', 'CPU models',
806                 sorted(n for n,m in CpuModel.dict.iteritems() if m.default),
807                 sorted(CpuModel.list)),
808    BoolVariable('NO_FAST_ALLOC', 'Disable fast object allocator', False),
809    BoolVariable('FAST_ALLOC_DEBUG', 'Enable fast object allocator debugging',
810                 False),
811    BoolVariable('FAST_ALLOC_STATS', 'Enable fast object allocator statistics',
812                 False),
813    BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
814                 False),
815    BoolVariable('SS_COMPATIBLE_FP',
816                 'Make floating-point results compatible with SimpleScalar',
817                 False),
818    BoolVariable('USE_SSE2',
819                 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
820                 False),
821    BoolVariable('USE_MYSQL', 'Use MySQL for stats output', have_mysql),
822    BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
823    BoolVariable('USE_CHECKER', 'Use checker for detailed CPU models', False),
824    BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False),
825    BoolVariable('RUBY', 'Build with Ruby', False),
826    )
827
828# These variables get exported to #defines in config/*.hh (see src/SConscript).
829export_vars += ['FULL_SYSTEM', 'USE_FENV', 'USE_MYSQL',
830                'NO_FAST_ALLOC', 'FAST_ALLOC_DEBUG', 'FAST_ALLOC_STATS',
831                'SS_COMPATIBLE_FP', 'USE_CHECKER', 'TARGET_ISA', 'CP_ANNOTATE']
832
833###################################################
834#
835# Define a SCons builder for configuration flag headers.
836#
837###################################################
838
839# This function generates a config header file that #defines the
840# variable symbol to the current variable setting (0 or 1).  The source
841# operands are the name of the variable and a Value node containing the
842# value of the variable.
843def build_config_file(target, source, env):
844    (variable, value) = [s.get_contents() for s in source]
845    f = file(str(target[0]), 'w')
846    print >> f, '#define', variable, value
847    f.close()
848    return None
849
850# Generate the message to be printed when building the config file.
851def build_config_file_string(target, source, env):
852    (variable, value) = [s.get_contents() for s in source]
853    return "Defining %s as %s in %s." % (variable, value, target[0])
854
855# Combine the two functions into a scons Action object.
856config_action = Action(build_config_file, build_config_file_string)
857
858# The emitter munges the source & target node lists to reflect what
859# we're really doing.
860def config_emitter(target, source, env):
861    # extract variable name from Builder arg
862    variable = str(target[0])
863    # True target is config header file
864    target = joinpath('config', variable.lower() + '.hh')
865    val = env[variable]
866    if isinstance(val, bool):
867        # Force value to 0/1
868        val = int(val)
869    elif isinstance(val, str):
870        val = '"' + val + '"'
871
872    # Sources are variable name & value (packaged in SCons Value nodes)
873    return ([target], [Value(variable), Value(val)])
874
875config_builder = Builder(emitter = config_emitter, action = config_action)
876
877main.Append(BUILDERS = { 'ConfigFile' : config_builder })
878
879# libelf build is shared across all configs in the build root.
880main.SConscript('ext/libelf/SConscript',
881                variant_dir = joinpath(build_root, 'libelf'))
882
883# gzstream build is shared across all configs in the build root.
884main.SConscript('ext/gzstream/SConscript',
885                variant_dir = joinpath(build_root, 'gzstream'))
886
887###################################################
888#
889# This function is used to set up a directory with switching headers
890#
891###################################################
892
893main['ALL_ISA_LIST'] = all_isa_list
894def make_switching_dir(dname, switch_headers, env):
895    # Generate the header.  target[0] is the full path of the output
896    # header to generate.  'source' is a dummy variable, since we get the
897    # list of ISAs from env['ALL_ISA_LIST'].
898    def gen_switch_hdr(target, source, env):
899        fname = str(target[0])
900        f = open(fname, 'w')
901        isa = env['TARGET_ISA'].lower()
902        print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname))
903        f.close()
904
905    # Build SCons Action object. 'varlist' specifies env vars that this
906    # action depends on; when env['ALL_ISA_LIST'] changes these actions
907    # should get re-executed.
908    switch_hdr_action = MakeAction(gen_switch_hdr,
909                          Transform("GENERATE"), varlist=['ALL_ISA_LIST'])
910
911    # Instantiate actions for each header
912    for hdr in switch_headers:
913        env.Command(hdr, [], switch_hdr_action)
914Export('make_switching_dir')
915
916###################################################
917#
918# Define build environments for selected configurations.
919#
920###################################################
921
922for variant_path in variant_paths:
923    print "Building in", variant_path
924
925    # Make a copy of the build-root environment to use for this config.
926    env = main.Clone()
927    env['BUILDDIR'] = variant_path
928
929    # variant_dir is the tail component of build path, and is used to
930    # determine the build parameters (e.g., 'ALPHA_SE')
931    (build_root, variant_dir) = splitpath(variant_path)
932
933    # Set env variables according to the build directory config.
934    sticky_vars.files = []
935    # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
936    # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
937    # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
938    current_vars_file = joinpath(build_root, 'variables', variant_dir)
939    if isfile(current_vars_file):
940        sticky_vars.files.append(current_vars_file)
941        print "Using saved variables file %s" % current_vars_file
942    else:
943        # Build dir-specific variables file doesn't exist.
944
945        # Make sure the directory is there so we can create it later
946        opt_dir = dirname(current_vars_file)
947        if not isdir(opt_dir):
948            mkdir(opt_dir)
949
950        # Get default build variables from source tree.  Variables are
951        # normally determined by name of $VARIANT_DIR, but can be
952        # overriden by 'default=' arg on command line.
953        default_vars_file = joinpath('build_opts',
954                                     ARGUMENTS.get('default', variant_dir))
955        if isfile(default_vars_file):
956            sticky_vars.files.append(default_vars_file)
957            print "Variables file %s not found,\n  using defaults in %s" \
958                  % (current_vars_file, default_vars_file)
959        else:
960            print "Error: cannot find variables file %s or %s" \
961                  % (current_vars_file, default_vars_file)
962            Exit(1)
963
964    # Apply current variable settings to env
965    sticky_vars.Update(env)
966
967    help_text += "\nSticky variables for %s:\n" % variant_dir \
968                 + sticky_vars.GenerateHelpText(env)
969
970    # Process variable settings.
971
972    if not have_fenv and env['USE_FENV']:
973        print "Warning: <fenv.h> not available; " \
974              "forcing USE_FENV to False in", variant_dir + "."
975        env['USE_FENV'] = False
976
977    if not env['USE_FENV']:
978        print "Warning: No IEEE FP rounding mode control in", variant_dir + "."
979        print "         FP results may deviate slightly from other platforms."
980
981    if env['EFENCE']:
982        env.Append(LIBS=['efence'])
983
984    if env['USE_MYSQL']:
985        if not have_mysql:
986            print "Warning: MySQL not available; " \
987                  "forcing USE_MYSQL to False in", variant_dir + "."
988            env['USE_MYSQL'] = False
989        else:
990            print "Compiling in", variant_dir, "with MySQL support."
991            env.ParseConfig(mysql_config_libs)
992            env.ParseConfig(mysql_config_include)
993
994    # Save sticky variable settings back to current variables file
995    sticky_vars.Save(current_vars_file, env)
996
997    if env['USE_SSE2']:
998        env.Append(CCFLAGS=['-msse2'])
999
1000    # The src/SConscript file sets up the build rules in 'env' according
1001    # to the configured variables.  It returns a list of environments,
1002    # one for each variant build (debug, opt, etc.)
1003    envList = SConscript('src/SConscript', variant_dir = variant_path,
1004                         exports = 'env')
1005
1006    # Set up the regression tests for each build.
1007    for e in envList:
1008        SConscript('tests/SConscript',
1009                   variant_dir = joinpath(variant_path, 'tests', e.Label),
1010                   exports = { 'env' : e }, duplicate = False)
1011
1012Help(help_text)
1013