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