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