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