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