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