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# Update main environment with values from ARGUMENTS & global_sticky_vars_file
342global_sticky_vars.Update(main)
343global_nonsticky_vars.Update(main)
344global_help_texts = {
345 "global_sticky" : global_sticky_vars.GenerateHelpText(main),
346 "global_nonsticky" : global_nonsticky_vars.GenerateHelpText(main)
347}
348
349# base help text
350help_text = '''
351Usage: scons [scons options] [build options] [target(s)]
352
353Global sticky options:
354%(global_sticky)s
355Global nonsticky options:
356%(global_nonsticky)s
357''' % global_help_texts
358
359# Save sticky variable settings back to current variables file
360global_sticky_vars.Save(global_sticky_vars_file, main)
361
362# Parse EXTRAS variable to build list of all directories where we're
363# look for sources etc. This list is exported as base_dir_list.
364base_dir = main.srcdir.abspath
365if main['EXTRAS']:
366 extras_dir_list = main['EXTRAS'].split(':')
367else:
368 extras_dir_list = []
369
370Export('base_dir')
371Export('extras_dir_list')
372
373# the ext directory should be on the #includes path
374main.Append(CPPPATH=[Dir('ext')])
375
376def strip_build_path(path, env):
377 path = str(path)
378 variant_base = env['BUILDROOT'] + os.path.sep
379 if path.startswith(variant_base):
380 path = path[len(variant_base):]
381 elif path.startswith('build/'):
382 path = path[6:]
383 return path
384
385# Generate a string of the form:
386# common/path/prefix/src1, src2 -> tgt1, tgt2
387# to print while building.
388class Transform(object):
389 # all specific color settings should be here and nowhere else
390 tool_color = termcap.Normal
391 pfx_color = termcap.Yellow
392 srcs_color = termcap.Yellow + termcap.Bold
393 arrow_color = termcap.Blue + termcap.Bold
394 tgts_color = termcap.Yellow + termcap.Bold
395
396 def __init__(self, tool, max_sources=99):
397 self.format = self.tool_color + (" [%8s] " % tool) \
398 + self.pfx_color + "%s" \
399 + self.srcs_color + "%s" \
400 + self.arrow_color + " -> " \
401 + self.tgts_color + "%s" \
402 + termcap.Normal
403 self.max_sources = max_sources
404
405 def __call__(self, target, source, env, for_signature=None):
406 # truncate source list according to max_sources param
407 source = source[0:self.max_sources]
408 def strip(f):
409 return strip_build_path(str(f), env)
410 if len(source) > 0:
411 srcs = map(strip, source)
412 else:
413 srcs = ['']
414 tgts = map(strip, target)
415 # surprisingly, os.path.commonprefix is a dumb char-by-char string
416 # operation that has nothing to do with paths.
417 com_pfx = os.path.commonprefix(srcs + tgts)
418 com_pfx_len = len(com_pfx)
419 if com_pfx:
420 # do some cleanup and sanity checking on common prefix
421 if com_pfx[-1] == ".":
422 # prefix matches all but file extension: ok
423 # back up one to change 'foo.cc -> o' to 'foo.cc -> .o'
424 com_pfx = com_pfx[0:-1]
425 elif com_pfx[-1] == "/":
426 # common prefix is directory path: OK
427 pass
428 else:
429 src0_len = len(srcs[0])
430 tgt0_len = len(tgts[0])
431 if src0_len == com_pfx_len:
432 # source is a substring of target, OK
433 pass
434 elif tgt0_len == com_pfx_len:
435 # target is a substring of source, need to back up to
436 # avoid empty string on RHS of arrow
437 sep_idx = com_pfx.rfind(".")
438 if sep_idx != -1:
439 com_pfx = com_pfx[0:sep_idx]
440 else:
441 com_pfx = ''
442 elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".":
443 # still splitting at file extension: ok
444 pass
445 else:
446 # probably a fluke; ignore it
447 com_pfx = ''
448 # recalculate length in case com_pfx was modified
449 com_pfx_len = len(com_pfx)
450 def fmt(files):
451 f = map(lambda s: s[com_pfx_len:], files)
452 return ', '.join(f)
453 return self.format % (com_pfx, fmt(srcs), fmt(tgts))
454
455Export('Transform')
456
457
458if main['VERBOSE']:
459 def MakeAction(action, string, *args, **kwargs):
460 return Action(action, *args, **kwargs)
461else:
462 MakeAction = Action
463 main['CCCOMSTR'] = Transform("CC")
464 main['CXXCOMSTR'] = Transform("CXX")
465 main['ASCOMSTR'] = Transform("AS")
466 main['SWIGCOMSTR'] = Transform("SWIG")
467 main['ARCOMSTR'] = Transform("AR", 0)
468 main['LINKCOMSTR'] = Transform("LINK", 0)
469 main['RANLIBCOMSTR'] = Transform("RANLIB", 0)
470 main['M4COMSTR'] = Transform("M4")
471 main['SHCCCOMSTR'] = Transform("SHCC")
472 main['SHCXXCOMSTR'] = Transform("SHCXX")
473Export('MakeAction')
474
475CXX_version = readCommand([main['CXX'],'--version'], exception=False)
476CXX_V = readCommand([main['CXX'],'-V'], exception=False)
477
478main['GCC'] = CXX_version and CXX_version.find('g++') >= 0
479main['SUNCC'] = CXX_V and CXX_V.find('Sun C++') >= 0
480main['ICC'] = CXX_V and CXX_V.find('Intel') >= 0
481if main['GCC'] + main['SUNCC'] + main['ICC'] > 1:
482 print 'Error: How can we have two at the same time?'
483 Exit(1)
484
485# Set up default C++ compiler flags
486if main['GCC']:
487 main.Append(CCFLAGS=['-pipe'])
488 main.Append(CCFLAGS=['-fno-strict-aliasing'])
489 main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef'])
490 main.Append(CXXFLAGS=['-Wno-deprecated'])
491 # Read the GCC version to check for versions with bugs
492 # Note CCVERSION doesn't work here because it is run with the CC
493 # before we override it from the command line
494 gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False)
495 if not compareVersions(gcc_version, '4.4.1') or \
496 not compareVersions(gcc_version, '4.4.2'):
497 print 'Info: Tree vectorizer in GCC 4.4.1 & 4.4.2 is buggy, disabling.'
498 main.Append(CCFLAGS=['-fno-tree-vectorize'])
499elif main['ICC']:
500 pass #Fix me... add warning flags once we clean up icc warnings
501elif main['SUNCC']:
502 main.Append(CCFLAGS=['-Qoption ccfe'])
503 main.Append(CCFLAGS=['-features=gcc'])
504 main.Append(CCFLAGS=['-features=extensions'])
505 main.Append(CCFLAGS=['-library=stlport4'])
506 main.Append(CCFLAGS=['-xar'])
507 #main.Append(CCFLAGS=['-instances=semiexplicit'])
508else:
509 print 'Error: Don\'t know what compiler options to use for your compiler.'
510 print ' Please fix SConstruct and src/SConscript and try again.'
511 Exit(1)
512
513# Set up common yacc/bison flags (needed for Ruby)
514main['YACCFLAGS'] = '-d'
515main['YACCHXXFILESUFFIX'] = '.hh'
516
517# Do this after we save setting back, or else we'll tack on an
518# extra 'qdo' every time we run scons.
519if main['BATCH']:
520 main['CC'] = main['BATCH_CMD'] + ' ' + main['CC']
521 main['CXX'] = main['BATCH_CMD'] + ' ' + main['CXX']
522 main['AS'] = main['BATCH_CMD'] + ' ' + main['AS']
523 main['AR'] = main['BATCH_CMD'] + ' ' + main['AR']
524 main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB']
525
526if sys.platform == 'cygwin':
527 # cygwin has some header file issues...
528 main.Append(CCFLAGS=["-Wno-uninitialized"])
529
530# Check for SWIG
531if not main.has_key('SWIG'):
532 print 'Error: SWIG utility not found.'
533 print ' Please install (see http://www.swig.org) and retry.'
534 Exit(1)
535
536# Check for appropriate SWIG version
537swig_version = readCommand(('swig', '-version'), exception='').split()
538# First 3 words should be "SWIG Version x.y.z"
539if len(swig_version) < 3 or \
540 swig_version[0] != 'SWIG' or swig_version[1] != 'Version':
541 print 'Error determining SWIG version.'
542 Exit(1)
543
544min_swig_version = '1.3.28'
545if compareVersions(swig_version[2], min_swig_version) < 0:
546 print 'Error: SWIG version', min_swig_version, 'or newer required.'
547 print ' Installed version:', swig_version[2]
548 Exit(1)
549
550# Set up SWIG flags & scanner
551swig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
552main.Append(SWIGFLAGS=swig_flags)
553
554# filter out all existing swig scanners, they mess up the dependency
555# stuff for some reason
556scanners = []
557for scanner in main['SCANNERS']:
558 skeys = scanner.skeys
559 if skeys == '.i':
560 continue
561
562 if isinstance(skeys, (list, tuple)) and '.i' in skeys:
563 continue
564
565 scanners.append(scanner)
566
567# add the new swig scanner that we like better
568from SCons.Scanner import ClassicCPP as CPPScanner
569swig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
570scanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re))
571
572# replace the scanners list that has what we want
573main['SCANNERS'] = scanners
574
575# Add a custom Check function to the Configure context so that we can
576# figure out if the compiler adds leading underscores to global
577# variables. This is needed for the autogenerated asm files that we
578# use for embedding the python code.
579def CheckLeading(context):
580 context.Message("Checking for leading underscore in global variables...")
581 # 1) Define a global variable called x from asm so the C compiler
582 # won't change the symbol at all.
583 # 2) Declare that variable.
584 # 3) Use the variable
585 #
586 # If the compiler prepends an underscore, this will successfully
587 # link because the external symbol 'x' will be called '_x' which
588 # was defined by the asm statement. If the compiler does not
589 # prepend an underscore, this will not successfully link because
590 # '_x' will have been defined by assembly, while the C portion of
591 # the code will be trying to use 'x'
592 ret = context.TryLink('''
593 asm(".globl _x; _x: .byte 0");
594 extern int x;
595 int main() { return x; }
596 ''', extension=".c")
597 context.env.Append(LEADING_UNDERSCORE=ret)
598 context.Result(ret)
599 return ret
600
601# Platform-specific configuration. Note again that we assume that all
602# builds under a given build root run on the same host platform.
603conf = Configure(main,
604 conf_dir = joinpath(build_root, '.scons_config'),
605 log_file = joinpath(build_root, 'scons_config.log'),
606 custom_tests = { 'CheckLeading' : CheckLeading })
607
608# Check for leading underscores. Don't really need to worry either
609# way so don't need to check the return code.
610conf.CheckLeading()
611
612# Check if we should compile a 64 bit binary on Mac OS X/Darwin
613try:
614 import platform
615 uname = platform.uname()
616 if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0:
617 if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
618 main.Append(CCFLAGS=['-arch', 'x86_64'])
619 main.Append(CFLAGS=['-arch', 'x86_64'])
620 main.Append(LINKFLAGS=['-arch', 'x86_64'])
621 main.Append(ASFLAGS=['-arch', 'x86_64'])
622except:
623 pass
624
625# Recent versions of scons substitute a "Null" object for Configure()
626# when configuration isn't necessary, e.g., if the "--help" option is
627# present. Unfortuantely this Null object always returns false,
628# breaking all our configuration checks. We replace it with our own
629# more optimistic null object that returns True instead.
630if not conf:
631 def NullCheck(*args, **kwargs):
632 return True
633
634 class NullConf:
635 def __init__(self, env):
636 self.env = env
637 def Finish(self):
638 return self.env
639 def __getattr__(self, mname):
640 return NullCheck
641
642 conf = NullConf(main)
643
644# Find Python include and library directories for embedding the
645# interpreter. For consistency, we will use the same Python
646# installation used to run scons (and thus this script). If you want
647# to link in an alternate version, see above for instructions on how
648# to invoke scons with a different copy of the Python interpreter.
649from distutils import sysconfig
650
651py_getvar = sysconfig.get_config_var
652
653py_debug = getattr(sys, 'pydebug', False)
654py_version = 'python' + py_getvar('VERSION') + (py_debug and "_d" or "")
655
656py_general_include = sysconfig.get_python_inc()
657py_platform_include = sysconfig.get_python_inc(plat_specific=True)
658py_includes = [ py_general_include ]
659if py_platform_include != py_general_include:
660 py_includes.append(py_platform_include)
661
662py_lib_path = [ py_getvar('LIBDIR') ]
663# add the prefix/lib/pythonX.Y/config dir, but only if there is no
664# shared library in prefix/lib/.
665if not py_getvar('Py_ENABLE_SHARED'):
666 py_lib_path.append(py_getvar('LIBPL'))
667
668py_libs = []
669for lib in py_getvar('LIBS').split() + py_getvar('SYSLIBS').split():
670 assert lib.startswith('-l')
671 lib = lib[2:]
672 if lib not in py_libs:
673 py_libs.append(lib)
674py_libs.append(py_version)
675
676main.Append(CPPPATH=py_includes)
677main.Append(LIBPATH=py_lib_path)
678
679# Cache build files in the supplied directory.
680if main['M5_BUILD_CACHE']:
681 print 'Using build cache located at', main['M5_BUILD_CACHE']
682 CacheDir(main['M5_BUILD_CACHE'])
683
684
685# verify that this stuff works
686if not conf.CheckHeader('Python.h', '<>'):
687 print "Error: can't find Python.h header in", py_includes
688 Exit(1)
689
690for lib in py_libs:
691 if not conf.CheckLib(lib):
692 print "Error: can't find library %s required by python" % lib
693 Exit(1)
694
695# On Solaris you need to use libsocket for socket ops
696if not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
697 if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
698 print "Can't find library with socket calls (e.g. accept())"
699 Exit(1)
700
701# Check for zlib. If the check passes, libz will be automatically
702# added to the LIBS environment variable.
703if not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
704 print 'Error: did not find needed zlib compression library '\
705 'and/or zlib.h header file.'
706 print ' Please install zlib and try again.'
707 Exit(1)
708
709# Check for librt.
710have_posix_clock = \
711 conf.CheckLibWithHeader(None, 'time.h', 'C',
712 'clock_nanosleep(0,0,NULL,NULL);') or \
713 conf.CheckLibWithHeader('rt', 'time.h', 'C',
714 'clock_nanosleep(0,0,NULL,NULL);')
715
716if not have_posix_clock:
717 print "Can't find library for POSIX clocks."
718
719# Check for <fenv.h> (C99 FP environment control)
720have_fenv = conf.CheckHeader('fenv.h', '<>')
721if not have_fenv:
722 print "Warning: Header file <fenv.h> not found."
723 print " This host has no IEEE FP rounding mode control."
724
725######################################################################
726#
727# Check for mysql.
728#
729mysql_config = WhereIs('mysql_config')
730have_mysql = bool(mysql_config)
731
732# Check MySQL version.
733if have_mysql:
734 mysql_version = readCommand(mysql_config + ' --version')
735 min_mysql_version = '4.1'
736 if compareVersions(mysql_version, min_mysql_version) < 0:
737 print 'Warning: MySQL', min_mysql_version, 'or newer required.'
738 print ' Version', mysql_version, 'detected.'
739 have_mysql = False
740
741# Set up mysql_config commands.
742if have_mysql:
743 mysql_config_include = mysql_config + ' --include'
744 if os.system(mysql_config_include + ' > /dev/null') != 0:
745 # older mysql_config versions don't support --include, use
746 # --cflags instead
747 mysql_config_include = mysql_config + ' --cflags | sed s/\\\'//g'
748 # This seems to work in all versions
749 mysql_config_libs = mysql_config + ' --libs'
750
751######################################################################
752#
753# Finish the configuration
754#
755main = conf.Finish()
756
757######################################################################
758#
759# Collect all non-global variables
760#
761
762# Define the universe of supported ISAs
763all_isa_list = [ ]
764Export('all_isa_list')
765
766class CpuModel(object):
767 '''The CpuModel class encapsulates everything the ISA parser needs to
768 know about a particular CPU model.'''
769
770 # Dict of available CPU model objects. Accessible as CpuModel.dict.
771 dict = {}
772 list = []
773 defaults = []
774
775 # Constructor. Automatically adds models to CpuModel.dict.
776 def __init__(self, name, filename, includes, strings, default=False):
777 self.name = name # name of model
778 self.filename = filename # filename for output exec code
779 self.includes = includes # include files needed in exec file
780 # The 'strings' dict holds all the per-CPU symbols we can
781 # substitute into templates etc.
782 self.strings = strings
783
784 # This cpu is enabled by default
785 self.default = default
786
787 # Add self to dict
788 if name in CpuModel.dict:
789 raise AttributeError, "CpuModel '%s' already registered" % name
790 CpuModel.dict[name] = self
791 CpuModel.list.append(name)
792
793Export('CpuModel')
794
795# Sticky variables get saved in the variables file so they persist from
796# one invocation to the next (unless overridden, in which case the new
797# value becomes sticky).
798sticky_vars = Variables(args=ARGUMENTS)
799Export('sticky_vars')
800
801# Sticky variables that should be exported
802export_vars = []
803Export('export_vars')
804
805# Walk the tree and execute all SConsopts scripts that wil add to the
806# above variables
807for bdir in [ base_dir ] + extras_dir_list:
808 for root, dirs, files in os.walk(bdir):
809 if 'SConsopts' in files:
810 print "Reading", joinpath(root, 'SConsopts')
811 SConscript(joinpath(root, 'SConsopts'))
812
813all_isa_list.sort()
814
815sticky_vars.AddVariables(
816 EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list),
817 BoolVariable('FULL_SYSTEM', 'Full-system support', False),
818 ListVariable('CPU_MODELS', 'CPU models',
819 sorted(n for n,m in CpuModel.dict.iteritems() if m.default),
820 sorted(CpuModel.list)),
821 BoolVariable('NO_FAST_ALLOC', 'Disable fast object allocator', False),
822 BoolVariable('FAST_ALLOC_DEBUG', 'Enable fast object allocator debugging',
823 False),
824 BoolVariable('FAST_ALLOC_STATS', 'Enable fast object allocator statistics',
825 False),
826 BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
827 False),
828 BoolVariable('SS_COMPATIBLE_FP',
829 'Make floating-point results compatible with SimpleScalar',
830 False),
831 BoolVariable('USE_SSE2',
832 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
833 False),
834 BoolVariable('USE_MYSQL', 'Use MySQL for stats output', have_mysql),
835 BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock),
836 BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
837 BoolVariable('USE_CHECKER', 'Use checker for detailed CPU models', False),
838 BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False),
839 BoolVariable('RUBY', 'Build with Ruby', False),
840 )
841
842# These variables get exported to #defines in config/*.hh (see src/SConscript).
843export_vars += ['FULL_SYSTEM', 'USE_FENV', 'USE_MYSQL',
844 'NO_FAST_ALLOC', 'FAST_ALLOC_DEBUG', 'FAST_ALLOC_STATS',
845 'SS_COMPATIBLE_FP', 'USE_CHECKER', 'TARGET_ISA', 'CP_ANNOTATE',
846 'USE_POSIX_CLOCK' ]
847
848###################################################
849#
850# Define a SCons builder for configuration flag headers.
851#
852###################################################
853
854# This function generates a config header file that #defines the
855# variable symbol to the current variable setting (0 or 1). The source
856# operands are the name of the variable and a Value node containing the
857# value of the variable.
858def build_config_file(target, source, env):
859 (variable, value) = [s.get_contents() for s in source]
860 f = file(str(target[0]), 'w')
861 print >> f, '#define', variable, value
862 f.close()
863 return None
864
865# Generate the message to be printed when building the config file.
866def build_config_file_string(target, source, env):
867 (variable, value) = [s.get_contents() for s in source]
868 return "Defining %s as %s in %s." % (variable, value, target[0])
869
870# Combine the two functions into a scons Action object.
871config_action = Action(build_config_file, build_config_file_string)
872
873# The emitter munges the source & target node lists to reflect what
874# we're really doing.
875def config_emitter(target, source, env):
876 # extract variable name from Builder arg
877 variable = str(target[0])
878 # True target is config header file
879 target = joinpath('config', variable.lower() + '.hh')
880 val = env[variable]
881 if isinstance(val, bool):
882 # Force value to 0/1
883 val = int(val)
884 elif isinstance(val, str):
885 val = '"' + val + '"'
886
887 # Sources are variable name & value (packaged in SCons Value nodes)
888 return ([target], [Value(variable), Value(val)])
889
890config_builder = Builder(emitter = config_emitter, action = config_action)
891
892main.Append(BUILDERS = { 'ConfigFile' : config_builder })
893
894# libelf build is shared across all configs in the build root.
895main.SConscript('ext/libelf/SConscript',
896 variant_dir = joinpath(build_root, 'libelf'))
897
898# gzstream build is shared across all configs in the build root.
899main.SConscript('ext/gzstream/SConscript',
900 variant_dir = joinpath(build_root, 'gzstream'))
901
902###################################################
903#
904# This function is used to set up a directory with switching headers
905#
906###################################################
907
908main['ALL_ISA_LIST'] = all_isa_list
909def make_switching_dir(dname, switch_headers, env):
910 # Generate the header. target[0] is the full path of the output
911 # header to generate. 'source' is a dummy variable, since we get the
912 # list of ISAs from env['ALL_ISA_LIST'].
913 def gen_switch_hdr(target, source, env):
914 fname = str(target[0])
915 f = open(fname, 'w')
916 isa = env['TARGET_ISA'].lower()
917 print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname))
918 f.close()
919
920 # Build SCons Action object. 'varlist' specifies env vars that this
921 # action depends on; when env['ALL_ISA_LIST'] changes these actions
922 # should get re-executed.
923 switch_hdr_action = MakeAction(gen_switch_hdr,
924 Transform("GENERATE"), varlist=['ALL_ISA_LIST'])
925
926 # Instantiate actions for each header
927 for hdr in switch_headers:
928 env.Command(hdr, [], switch_hdr_action)
929Export('make_switching_dir')
930
931###################################################
932#
933# Define build environments for selected configurations.
934#
935###################################################
936
937for variant_path in variant_paths:
938 print "Building in", variant_path
939
940 # Make a copy of the build-root environment to use for this config.
941 env = main.Clone()
942 env['BUILDDIR'] = variant_path
943
944 # variant_dir is the tail component of build path, and is used to
945 # determine the build parameters (e.g., 'ALPHA_SE')
946 (build_root, variant_dir) = splitpath(variant_path)
947
948 # Set env variables according to the build directory config.
949 sticky_vars.files = []
950 # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
951 # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
952 # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
953 current_vars_file = joinpath(build_root, 'variables', variant_dir)
954 if isfile(current_vars_file):
955 sticky_vars.files.append(current_vars_file)
956 print "Using saved variables file %s" % current_vars_file
957 else:
958 # Build dir-specific variables file doesn't exist.
959
960 # Make sure the directory is there so we can create it later
961 opt_dir = dirname(current_vars_file)
962 if not isdir(opt_dir):
963 mkdir(opt_dir)
964
965 # Get default build variables from source tree. Variables are
966 # normally determined by name of $VARIANT_DIR, but can be
967 # overriden by 'default=' arg on command line.
968 default_vars_file = joinpath('build_opts',
969 ARGUMENTS.get('default', variant_dir))
970 if isfile(default_vars_file):
971 sticky_vars.files.append(default_vars_file)
972 print "Variables file %s not found,\n using defaults in %s" \
973 % (current_vars_file, default_vars_file)
974 else:
975 print "Error: cannot find variables file %s or %s" \
976 % (current_vars_file, default_vars_file)
977 Exit(1)
978
979 # Apply current variable settings to env
980 sticky_vars.Update(env)
981
982 help_text += "\nSticky variables for %s:\n" % variant_dir \
983 + sticky_vars.GenerateHelpText(env)
984
985 # Process variable settings.
986
987 if not have_fenv and env['USE_FENV']:
988 print "Warning: <fenv.h> not available; " \
989 "forcing USE_FENV to False in", variant_dir + "."
990 env['USE_FENV'] = False
991
992 if not env['USE_FENV']:
993 print "Warning: No IEEE FP rounding mode control in", variant_dir + "."
994 print " FP results may deviate slightly from other platforms."
995
996 if env['EFENCE']:
997 env.Append(LIBS=['efence'])
998
999 if env['USE_MYSQL']:
1000 if not have_mysql:
1001 print "Warning: MySQL not available; " \
1002 "forcing USE_MYSQL to False in", variant_dir + "."
1003 env['USE_MYSQL'] = False
1004 else:
1005 print "Compiling in", variant_dir, "with MySQL support."
1006 env.ParseConfig(mysql_config_libs)
1007 env.ParseConfig(mysql_config_include)
1008
1009 # Save sticky variable settings back to current variables file
1010 sticky_vars.Save(current_vars_file, env)
1011
1012 if env['USE_SSE2']:
1013 env.Append(CCFLAGS=['-msse2'])
1014
1015 # The src/SConscript file sets up the build rules in 'env' according
1016 # to the configured variables. It returns a list of environments,
1017 # one for each variant build (debug, opt, etc.)
1018 envList = SConscript('src/SConscript', variant_dir = variant_path,
1019 exports = 'env')
1020
1021 # Set up the regression tests for each build.
1022 for e in envList:
1023 SConscript('tests/SConscript',
1024 variant_dir = joinpath(variant_path, 'tests', e.Label),
1025 exports = { 'env' : e }, duplicate = False)
1026
1027Help(help_text)
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# Update main environment with values from ARGUMENTS & global_sticky_vars_file
342global_sticky_vars.Update(main)
343global_nonsticky_vars.Update(main)
344global_help_texts = {
345 "global_sticky" : global_sticky_vars.GenerateHelpText(main),
346 "global_nonsticky" : global_nonsticky_vars.GenerateHelpText(main)
347}
348
349# base help text
350help_text = '''
351Usage: scons [scons options] [build options] [target(s)]
352
353Global sticky options:
354%(global_sticky)s
355Global nonsticky options:
356%(global_nonsticky)s
357''' % global_help_texts
358
359# Save sticky variable settings back to current variables file
360global_sticky_vars.Save(global_sticky_vars_file, main)
361
362# Parse EXTRAS variable to build list of all directories where we're
363# look for sources etc. This list is exported as base_dir_list.
364base_dir = main.srcdir.abspath
365if main['EXTRAS']:
366 extras_dir_list = main['EXTRAS'].split(':')
367else:
368 extras_dir_list = []
369
370Export('base_dir')
371Export('extras_dir_list')
372
373# the ext directory should be on the #includes path
374main.Append(CPPPATH=[Dir('ext')])
375
376def strip_build_path(path, env):
377 path = str(path)
378 variant_base = env['BUILDROOT'] + os.path.sep
379 if path.startswith(variant_base):
380 path = path[len(variant_base):]
381 elif path.startswith('build/'):
382 path = path[6:]
383 return path
384
385# Generate a string of the form:
386# common/path/prefix/src1, src2 -> tgt1, tgt2
387# to print while building.
388class Transform(object):
389 # all specific color settings should be here and nowhere else
390 tool_color = termcap.Normal
391 pfx_color = termcap.Yellow
392 srcs_color = termcap.Yellow + termcap.Bold
393 arrow_color = termcap.Blue + termcap.Bold
394 tgts_color = termcap.Yellow + termcap.Bold
395
396 def __init__(self, tool, max_sources=99):
397 self.format = self.tool_color + (" [%8s] " % tool) \
398 + self.pfx_color + "%s" \
399 + self.srcs_color + "%s" \
400 + self.arrow_color + " -> " \
401 + self.tgts_color + "%s" \
402 + termcap.Normal
403 self.max_sources = max_sources
404
405 def __call__(self, target, source, env, for_signature=None):
406 # truncate source list according to max_sources param
407 source = source[0:self.max_sources]
408 def strip(f):
409 return strip_build_path(str(f), env)
410 if len(source) > 0:
411 srcs = map(strip, source)
412 else:
413 srcs = ['']
414 tgts = map(strip, target)
415 # surprisingly, os.path.commonprefix is a dumb char-by-char string
416 # operation that has nothing to do with paths.
417 com_pfx = os.path.commonprefix(srcs + tgts)
418 com_pfx_len = len(com_pfx)
419 if com_pfx:
420 # do some cleanup and sanity checking on common prefix
421 if com_pfx[-1] == ".":
422 # prefix matches all but file extension: ok
423 # back up one to change 'foo.cc -> o' to 'foo.cc -> .o'
424 com_pfx = com_pfx[0:-1]
425 elif com_pfx[-1] == "/":
426 # common prefix is directory path: OK
427 pass
428 else:
429 src0_len = len(srcs[0])
430 tgt0_len = len(tgts[0])
431 if src0_len == com_pfx_len:
432 # source is a substring of target, OK
433 pass
434 elif tgt0_len == com_pfx_len:
435 # target is a substring of source, need to back up to
436 # avoid empty string on RHS of arrow
437 sep_idx = com_pfx.rfind(".")
438 if sep_idx != -1:
439 com_pfx = com_pfx[0:sep_idx]
440 else:
441 com_pfx = ''
442 elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".":
443 # still splitting at file extension: ok
444 pass
445 else:
446 # probably a fluke; ignore it
447 com_pfx = ''
448 # recalculate length in case com_pfx was modified
449 com_pfx_len = len(com_pfx)
450 def fmt(files):
451 f = map(lambda s: s[com_pfx_len:], files)
452 return ', '.join(f)
453 return self.format % (com_pfx, fmt(srcs), fmt(tgts))
454
455Export('Transform')
456
457
458if main['VERBOSE']:
459 def MakeAction(action, string, *args, **kwargs):
460 return Action(action, *args, **kwargs)
461else:
462 MakeAction = Action
463 main['CCCOMSTR'] = Transform("CC")
464 main['CXXCOMSTR'] = Transform("CXX")
465 main['ASCOMSTR'] = Transform("AS")
466 main['SWIGCOMSTR'] = Transform("SWIG")
467 main['ARCOMSTR'] = Transform("AR", 0)
468 main['LINKCOMSTR'] = Transform("LINK", 0)
469 main['RANLIBCOMSTR'] = Transform("RANLIB", 0)
470 main['M4COMSTR'] = Transform("M4")
471 main['SHCCCOMSTR'] = Transform("SHCC")
472 main['SHCXXCOMSTR'] = Transform("SHCXX")
473Export('MakeAction')
474
475CXX_version = readCommand([main['CXX'],'--version'], exception=False)
476CXX_V = readCommand([main['CXX'],'-V'], exception=False)
477
478main['GCC'] = CXX_version and CXX_version.find('g++') >= 0
479main['SUNCC'] = CXX_V and CXX_V.find('Sun C++') >= 0
480main['ICC'] = CXX_V and CXX_V.find('Intel') >= 0
481if main['GCC'] + main['SUNCC'] + main['ICC'] > 1:
482 print 'Error: How can we have two at the same time?'
483 Exit(1)
484
485# Set up default C++ compiler flags
486if main['GCC']:
487 main.Append(CCFLAGS=['-pipe'])
488 main.Append(CCFLAGS=['-fno-strict-aliasing'])
489 main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef'])
490 main.Append(CXXFLAGS=['-Wno-deprecated'])
491 # Read the GCC version to check for versions with bugs
492 # Note CCVERSION doesn't work here because it is run with the CC
493 # before we override it from the command line
494 gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False)
495 if not compareVersions(gcc_version, '4.4.1') or \
496 not compareVersions(gcc_version, '4.4.2'):
497 print 'Info: Tree vectorizer in GCC 4.4.1 & 4.4.2 is buggy, disabling.'
498 main.Append(CCFLAGS=['-fno-tree-vectorize'])
499elif main['ICC']:
500 pass #Fix me... add warning flags once we clean up icc warnings
501elif main['SUNCC']:
502 main.Append(CCFLAGS=['-Qoption ccfe'])
503 main.Append(CCFLAGS=['-features=gcc'])
504 main.Append(CCFLAGS=['-features=extensions'])
505 main.Append(CCFLAGS=['-library=stlport4'])
506 main.Append(CCFLAGS=['-xar'])
507 #main.Append(CCFLAGS=['-instances=semiexplicit'])
508else:
509 print 'Error: Don\'t know what compiler options to use for your compiler.'
510 print ' Please fix SConstruct and src/SConscript and try again.'
511 Exit(1)
512
513# Set up common yacc/bison flags (needed for Ruby)
514main['YACCFLAGS'] = '-d'
515main['YACCHXXFILESUFFIX'] = '.hh'
516
517# Do this after we save setting back, or else we'll tack on an
518# extra 'qdo' every time we run scons.
519if main['BATCH']:
520 main['CC'] = main['BATCH_CMD'] + ' ' + main['CC']
521 main['CXX'] = main['BATCH_CMD'] + ' ' + main['CXX']
522 main['AS'] = main['BATCH_CMD'] + ' ' + main['AS']
523 main['AR'] = main['BATCH_CMD'] + ' ' + main['AR']
524 main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB']
525
526if sys.platform == 'cygwin':
527 # cygwin has some header file issues...
528 main.Append(CCFLAGS=["-Wno-uninitialized"])
529
530# Check for SWIG
531if not main.has_key('SWIG'):
532 print 'Error: SWIG utility not found.'
533 print ' Please install (see http://www.swig.org) and retry.'
534 Exit(1)
535
536# Check for appropriate SWIG version
537swig_version = readCommand(('swig', '-version'), exception='').split()
538# First 3 words should be "SWIG Version x.y.z"
539if len(swig_version) < 3 or \
540 swig_version[0] != 'SWIG' or swig_version[1] != 'Version':
541 print 'Error determining SWIG version.'
542 Exit(1)
543
544min_swig_version = '1.3.28'
545if compareVersions(swig_version[2], min_swig_version) < 0:
546 print 'Error: SWIG version', min_swig_version, 'or newer required.'
547 print ' Installed version:', swig_version[2]
548 Exit(1)
549
550# Set up SWIG flags & scanner
551swig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
552main.Append(SWIGFLAGS=swig_flags)
553
554# filter out all existing swig scanners, they mess up the dependency
555# stuff for some reason
556scanners = []
557for scanner in main['SCANNERS']:
558 skeys = scanner.skeys
559 if skeys == '.i':
560 continue
561
562 if isinstance(skeys, (list, tuple)) and '.i' in skeys:
563 continue
564
565 scanners.append(scanner)
566
567# add the new swig scanner that we like better
568from SCons.Scanner import ClassicCPP as CPPScanner
569swig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
570scanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re))
571
572# replace the scanners list that has what we want
573main['SCANNERS'] = scanners
574
575# Add a custom Check function to the Configure context so that we can
576# figure out if the compiler adds leading underscores to global
577# variables. This is needed for the autogenerated asm files that we
578# use for embedding the python code.
579def CheckLeading(context):
580 context.Message("Checking for leading underscore in global variables...")
581 # 1) Define a global variable called x from asm so the C compiler
582 # won't change the symbol at all.
583 # 2) Declare that variable.
584 # 3) Use the variable
585 #
586 # If the compiler prepends an underscore, this will successfully
587 # link because the external symbol 'x' will be called '_x' which
588 # was defined by the asm statement. If the compiler does not
589 # prepend an underscore, this will not successfully link because
590 # '_x' will have been defined by assembly, while the C portion of
591 # the code will be trying to use 'x'
592 ret = context.TryLink('''
593 asm(".globl _x; _x: .byte 0");
594 extern int x;
595 int main() { return x; }
596 ''', extension=".c")
597 context.env.Append(LEADING_UNDERSCORE=ret)
598 context.Result(ret)
599 return ret
600
601# Platform-specific configuration. Note again that we assume that all
602# builds under a given build root run on the same host platform.
603conf = Configure(main,
604 conf_dir = joinpath(build_root, '.scons_config'),
605 log_file = joinpath(build_root, 'scons_config.log'),
606 custom_tests = { 'CheckLeading' : CheckLeading })
607
608# Check for leading underscores. Don't really need to worry either
609# way so don't need to check the return code.
610conf.CheckLeading()
611
612# Check if we should compile a 64 bit binary on Mac OS X/Darwin
613try:
614 import platform
615 uname = platform.uname()
616 if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0:
617 if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
618 main.Append(CCFLAGS=['-arch', 'x86_64'])
619 main.Append(CFLAGS=['-arch', 'x86_64'])
620 main.Append(LINKFLAGS=['-arch', 'x86_64'])
621 main.Append(ASFLAGS=['-arch', 'x86_64'])
622except:
623 pass
624
625# Recent versions of scons substitute a "Null" object for Configure()
626# when configuration isn't necessary, e.g., if the "--help" option is
627# present. Unfortuantely this Null object always returns false,
628# breaking all our configuration checks. We replace it with our own
629# more optimistic null object that returns True instead.
630if not conf:
631 def NullCheck(*args, **kwargs):
632 return True
633
634 class NullConf:
635 def __init__(self, env):
636 self.env = env
637 def Finish(self):
638 return self.env
639 def __getattr__(self, mname):
640 return NullCheck
641
642 conf = NullConf(main)
643
644# Find Python include and library directories for embedding the
645# interpreter. For consistency, we will use the same Python
646# installation used to run scons (and thus this script). If you want
647# to link in an alternate version, see above for instructions on how
648# to invoke scons with a different copy of the Python interpreter.
649from distutils import sysconfig
650
651py_getvar = sysconfig.get_config_var
652
653py_debug = getattr(sys, 'pydebug', False)
654py_version = 'python' + py_getvar('VERSION') + (py_debug and "_d" or "")
655
656py_general_include = sysconfig.get_python_inc()
657py_platform_include = sysconfig.get_python_inc(plat_specific=True)
658py_includes = [ py_general_include ]
659if py_platform_include != py_general_include:
660 py_includes.append(py_platform_include)
661
662py_lib_path = [ py_getvar('LIBDIR') ]
663# add the prefix/lib/pythonX.Y/config dir, but only if there is no
664# shared library in prefix/lib/.
665if not py_getvar('Py_ENABLE_SHARED'):
666 py_lib_path.append(py_getvar('LIBPL'))
667
668py_libs = []
669for lib in py_getvar('LIBS').split() + py_getvar('SYSLIBS').split():
670 assert lib.startswith('-l')
671 lib = lib[2:]
672 if lib not in py_libs:
673 py_libs.append(lib)
674py_libs.append(py_version)
675
676main.Append(CPPPATH=py_includes)
677main.Append(LIBPATH=py_lib_path)
678
679# Cache build files in the supplied directory.
680if main['M5_BUILD_CACHE']:
681 print 'Using build cache located at', main['M5_BUILD_CACHE']
682 CacheDir(main['M5_BUILD_CACHE'])
683
684
685# verify that this stuff works
686if not conf.CheckHeader('Python.h', '<>'):
687 print "Error: can't find Python.h header in", py_includes
688 Exit(1)
689
690for lib in py_libs:
691 if not conf.CheckLib(lib):
692 print "Error: can't find library %s required by python" % lib
693 Exit(1)
694
695# On Solaris you need to use libsocket for socket ops
696if not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
697 if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
698 print "Can't find library with socket calls (e.g. accept())"
699 Exit(1)
700
701# Check for zlib. If the check passes, libz will be automatically
702# added to the LIBS environment variable.
703if not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
704 print 'Error: did not find needed zlib compression library '\
705 'and/or zlib.h header file.'
706 print ' Please install zlib and try again.'
707 Exit(1)
708
709# Check for librt.
710have_posix_clock = \
711 conf.CheckLibWithHeader(None, 'time.h', 'C',
712 'clock_nanosleep(0,0,NULL,NULL);') or \
713 conf.CheckLibWithHeader('rt', 'time.h', 'C',
714 'clock_nanosleep(0,0,NULL,NULL);')
715
716if not have_posix_clock:
717 print "Can't find library for POSIX clocks."
718
719# Check for <fenv.h> (C99 FP environment control)
720have_fenv = conf.CheckHeader('fenv.h', '<>')
721if not have_fenv:
722 print "Warning: Header file <fenv.h> not found."
723 print " This host has no IEEE FP rounding mode control."
724
725######################################################################
726#
727# Check for mysql.
728#
729mysql_config = WhereIs('mysql_config')
730have_mysql = bool(mysql_config)
731
732# Check MySQL version.
733if have_mysql:
734 mysql_version = readCommand(mysql_config + ' --version')
735 min_mysql_version = '4.1'
736 if compareVersions(mysql_version, min_mysql_version) < 0:
737 print 'Warning: MySQL', min_mysql_version, 'or newer required.'
738 print ' Version', mysql_version, 'detected.'
739 have_mysql = False
740
741# Set up mysql_config commands.
742if have_mysql:
743 mysql_config_include = mysql_config + ' --include'
744 if os.system(mysql_config_include + ' > /dev/null') != 0:
745 # older mysql_config versions don't support --include, use
746 # --cflags instead
747 mysql_config_include = mysql_config + ' --cflags | sed s/\\\'//g'
748 # This seems to work in all versions
749 mysql_config_libs = mysql_config + ' --libs'
750
751######################################################################
752#
753# Finish the configuration
754#
755main = conf.Finish()
756
757######################################################################
758#
759# Collect all non-global variables
760#
761
762# Define the universe of supported ISAs
763all_isa_list = [ ]
764Export('all_isa_list')
765
766class CpuModel(object):
767 '''The CpuModel class encapsulates everything the ISA parser needs to
768 know about a particular CPU model.'''
769
770 # Dict of available CPU model objects. Accessible as CpuModel.dict.
771 dict = {}
772 list = []
773 defaults = []
774
775 # Constructor. Automatically adds models to CpuModel.dict.
776 def __init__(self, name, filename, includes, strings, default=False):
777 self.name = name # name of model
778 self.filename = filename # filename for output exec code
779 self.includes = includes # include files needed in exec file
780 # The 'strings' dict holds all the per-CPU symbols we can
781 # substitute into templates etc.
782 self.strings = strings
783
784 # This cpu is enabled by default
785 self.default = default
786
787 # Add self to dict
788 if name in CpuModel.dict:
789 raise AttributeError, "CpuModel '%s' already registered" % name
790 CpuModel.dict[name] = self
791 CpuModel.list.append(name)
792
793Export('CpuModel')
794
795# Sticky variables get saved in the variables file so they persist from
796# one invocation to the next (unless overridden, in which case the new
797# value becomes sticky).
798sticky_vars = Variables(args=ARGUMENTS)
799Export('sticky_vars')
800
801# Sticky variables that should be exported
802export_vars = []
803Export('export_vars')
804
805# Walk the tree and execute all SConsopts scripts that wil add to the
806# above variables
807for bdir in [ base_dir ] + extras_dir_list:
808 for root, dirs, files in os.walk(bdir):
809 if 'SConsopts' in files:
810 print "Reading", joinpath(root, 'SConsopts')
811 SConscript(joinpath(root, 'SConsopts'))
812
813all_isa_list.sort()
814
815sticky_vars.AddVariables(
816 EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list),
817 BoolVariable('FULL_SYSTEM', 'Full-system support', False),
818 ListVariable('CPU_MODELS', 'CPU models',
819 sorted(n for n,m in CpuModel.dict.iteritems() if m.default),
820 sorted(CpuModel.list)),
821 BoolVariable('NO_FAST_ALLOC', 'Disable fast object allocator', False),
822 BoolVariable('FAST_ALLOC_DEBUG', 'Enable fast object allocator debugging',
823 False),
824 BoolVariable('FAST_ALLOC_STATS', 'Enable fast object allocator statistics',
825 False),
826 BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
827 False),
828 BoolVariable('SS_COMPATIBLE_FP',
829 'Make floating-point results compatible with SimpleScalar',
830 False),
831 BoolVariable('USE_SSE2',
832 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
833 False),
834 BoolVariable('USE_MYSQL', 'Use MySQL for stats output', have_mysql),
835 BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock),
836 BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
837 BoolVariable('USE_CHECKER', 'Use checker for detailed CPU models', False),
838 BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False),
839 BoolVariable('RUBY', 'Build with Ruby', False),
840 )
841
842# These variables get exported to #defines in config/*.hh (see src/SConscript).
843export_vars += ['FULL_SYSTEM', 'USE_FENV', 'USE_MYSQL',
844 'NO_FAST_ALLOC', 'FAST_ALLOC_DEBUG', 'FAST_ALLOC_STATS',
845 'SS_COMPATIBLE_FP', 'USE_CHECKER', 'TARGET_ISA', 'CP_ANNOTATE',
846 'USE_POSIX_CLOCK' ]
847
848###################################################
849#
850# Define a SCons builder for configuration flag headers.
851#
852###################################################
853
854# This function generates a config header file that #defines the
855# variable symbol to the current variable setting (0 or 1). The source
856# operands are the name of the variable and a Value node containing the
857# value of the variable.
858def build_config_file(target, source, env):
859 (variable, value) = [s.get_contents() for s in source]
860 f = file(str(target[0]), 'w')
861 print >> f, '#define', variable, value
862 f.close()
863 return None
864
865# Generate the message to be printed when building the config file.
866def build_config_file_string(target, source, env):
867 (variable, value) = [s.get_contents() for s in source]
868 return "Defining %s as %s in %s." % (variable, value, target[0])
869
870# Combine the two functions into a scons Action object.
871config_action = Action(build_config_file, build_config_file_string)
872
873# The emitter munges the source & target node lists to reflect what
874# we're really doing.
875def config_emitter(target, source, env):
876 # extract variable name from Builder arg
877 variable = str(target[0])
878 # True target is config header file
879 target = joinpath('config', variable.lower() + '.hh')
880 val = env[variable]
881 if isinstance(val, bool):
882 # Force value to 0/1
883 val = int(val)
884 elif isinstance(val, str):
885 val = '"' + val + '"'
886
887 # Sources are variable name & value (packaged in SCons Value nodes)
888 return ([target], [Value(variable), Value(val)])
889
890config_builder = Builder(emitter = config_emitter, action = config_action)
891
892main.Append(BUILDERS = { 'ConfigFile' : config_builder })
893
894# libelf build is shared across all configs in the build root.
895main.SConscript('ext/libelf/SConscript',
896 variant_dir = joinpath(build_root, 'libelf'))
897
898# gzstream build is shared across all configs in the build root.
899main.SConscript('ext/gzstream/SConscript',
900 variant_dir = joinpath(build_root, 'gzstream'))
901
902###################################################
903#
904# This function is used to set up a directory with switching headers
905#
906###################################################
907
908main['ALL_ISA_LIST'] = all_isa_list
909def make_switching_dir(dname, switch_headers, env):
910 # Generate the header. target[0] is the full path of the output
911 # header to generate. 'source' is a dummy variable, since we get the
912 # list of ISAs from env['ALL_ISA_LIST'].
913 def gen_switch_hdr(target, source, env):
914 fname = str(target[0])
915 f = open(fname, 'w')
916 isa = env['TARGET_ISA'].lower()
917 print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname))
918 f.close()
919
920 # Build SCons Action object. 'varlist' specifies env vars that this
921 # action depends on; when env['ALL_ISA_LIST'] changes these actions
922 # should get re-executed.
923 switch_hdr_action = MakeAction(gen_switch_hdr,
924 Transform("GENERATE"), varlist=['ALL_ISA_LIST'])
925
926 # Instantiate actions for each header
927 for hdr in switch_headers:
928 env.Command(hdr, [], switch_hdr_action)
929Export('make_switching_dir')
930
931###################################################
932#
933# Define build environments for selected configurations.
934#
935###################################################
936
937for variant_path in variant_paths:
938 print "Building in", variant_path
939
940 # Make a copy of the build-root environment to use for this config.
941 env = main.Clone()
942 env['BUILDDIR'] = variant_path
943
944 # variant_dir is the tail component of build path, and is used to
945 # determine the build parameters (e.g., 'ALPHA_SE')
946 (build_root, variant_dir) = splitpath(variant_path)
947
948 # Set env variables according to the build directory config.
949 sticky_vars.files = []
950 # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
951 # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
952 # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
953 current_vars_file = joinpath(build_root, 'variables', variant_dir)
954 if isfile(current_vars_file):
955 sticky_vars.files.append(current_vars_file)
956 print "Using saved variables file %s" % current_vars_file
957 else:
958 # Build dir-specific variables file doesn't exist.
959
960 # Make sure the directory is there so we can create it later
961 opt_dir = dirname(current_vars_file)
962 if not isdir(opt_dir):
963 mkdir(opt_dir)
964
965 # Get default build variables from source tree. Variables are
966 # normally determined by name of $VARIANT_DIR, but can be
967 # overriden by 'default=' arg on command line.
968 default_vars_file = joinpath('build_opts',
969 ARGUMENTS.get('default', variant_dir))
970 if isfile(default_vars_file):
971 sticky_vars.files.append(default_vars_file)
972 print "Variables file %s not found,\n using defaults in %s" \
973 % (current_vars_file, default_vars_file)
974 else:
975 print "Error: cannot find variables file %s or %s" \
976 % (current_vars_file, default_vars_file)
977 Exit(1)
978
979 # Apply current variable settings to env
980 sticky_vars.Update(env)
981
982 help_text += "\nSticky variables for %s:\n" % variant_dir \
983 + sticky_vars.GenerateHelpText(env)
984
985 # Process variable settings.
986
987 if not have_fenv and env['USE_FENV']:
988 print "Warning: <fenv.h> not available; " \
989 "forcing USE_FENV to False in", variant_dir + "."
990 env['USE_FENV'] = False
991
992 if not env['USE_FENV']:
993 print "Warning: No IEEE FP rounding mode control in", variant_dir + "."
994 print " FP results may deviate slightly from other platforms."
995
996 if env['EFENCE']:
997 env.Append(LIBS=['efence'])
998
999 if env['USE_MYSQL']:
1000 if not have_mysql:
1001 print "Warning: MySQL not available; " \
1002 "forcing USE_MYSQL to False in", variant_dir + "."
1003 env['USE_MYSQL'] = False
1004 else:
1005 print "Compiling in", variant_dir, "with MySQL support."
1006 env.ParseConfig(mysql_config_libs)
1007 env.ParseConfig(mysql_config_include)
1008
1009 # Save sticky variable settings back to current variables file
1010 sticky_vars.Save(current_vars_file, env)
1011
1012 if env['USE_SSE2']:
1013 env.Append(CCFLAGS=['-msse2'])
1014
1015 # The src/SConscript file sets up the build rules in 'env' according
1016 # to the configured variables. It returns a list of environments,
1017 # one for each variant build (debug, opt, etc.)
1018 envList = SConscript('src/SConscript', variant_dir = variant_path,
1019 exports = 'env')
1020
1021 # Set up the regression tests for each build.
1022 for e in envList:
1023 SConscript('tests/SConscript',
1024 variant_dir = joinpath(variant_path, 'tests', e.Label),
1025 exports = { 'env' : e }, duplicate = False)
1026
1027Help(help_text)