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