1# -*- mode:python -*-
2
3# Copyright (c) 2004-2005 The Regents of The University of Michigan
4# All rights reserved.
5#
6# Redistribution and use in source and binary forms, with or without
7# modification, are permitted provided that the following conditions are
8# met: redistributions of source code must retain the above copyright
9# notice, this list of conditions and the following disclaimer;
10# redistributions in binary form must reproduce the above copyright
11# notice, this list of conditions and the following disclaimer in the
12# documentation and/or other materials provided with the distribution;
13# neither the name of the copyright holders nor the names of its
14# contributors may be used to endorse or promote products derived from
15# this software without specific prior written permission.
16#
17# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28#
29# Authors: Steve Reinhardt
30
31###################################################
32#
33# SCons top-level build description (SConstruct) file.
34#
35# While in this directory ('m5'), just type 'scons' to build the default
36# configuration (see below), or type 'scons build/<CONFIG>/<binary>'
37# to build some other configuration (e.g., 'build/ALPHA_FS/m5.opt' for
38# the optimized full-system version).
39#
40# You can build M5 in a different directory as long as there is a
41# 'build/<CONFIG>' somewhere along the target path. The build system
42# expects that all configs under the same build directory are being
43# built for the same host system.
44#
45# Examples:
46#
47# The following two commands are equivalent. The '-u' option tells
48# scons to search up the directory tree for this SConstruct file.
49# % cd <path-to-src>/m5 ; scons build/ALPHA_FS/m5.debug
50# % cd <path-to-src>/m5/build/ALPHA_FS; scons -u m5.debug
51#
52# The following two commands are equivalent and demonstrate building
53# in a directory outside of the source tree. The '-C' option tells
54# scons to chdir to the specified directory to find this SConstruct
55# file.
56# % cd <path-to-src>/m5 ; scons /local/foo/build/ALPHA_FS/m5.debug
57# % cd /local/foo/build/ALPHA_FS; scons -C <path-to-src>/m5 m5.debug
58#
59# You can use 'scons -H' to print scons options. If you're in this
60# 'm5' directory (or use -u or -C to tell scons where to find this
61# file), you can use 'scons -h' to print all the M5-specific build
62# options as well.
63#
64###################################################
65
66import sys
67import os
68import re
69
70from os.path import isdir, isfile, join as joinpath
71
72import SCons
73
74# Check for recent-enough Python and SCons versions. If your system's
75# default installation of Python is not recent enough, you can use a
76# non-default installation of the Python interpreter by either (1)
77# rearranging your PATH so that scons finds the non-default 'python'
78# first or (2) explicitly invoking an alternative interpreter on the
79# scons script, e.g., "/usr/local/bin/python2.4 `which scons` [args]".
80EnsurePythonVersion(2,4)
81
82# Import subprocess after we check the version since it doesn't exist in
83# Python < 2.4.
84import subprocess
85
86# helper function: compare arrays or strings of version numbers.
87# E.g., compare_version((1,3,25), (1,4,1)')
88# returns -1, 0, 1 if v1 is <, ==, > v2
89def compare_versions(v1, v2):
90 def make_version_list(v):
91 if isinstance(v, (list,tuple)):
92 return v
93 elif isinstance(v, str):
94 return map(int, v.split('.'))
95 else:
96 raise TypeError
97
98 v1 = make_version_list(v1)
99 v2 = make_version_list(v2)
100 # Compare corresponding elements of lists
101 for n1,n2 in zip(v1, v2):
102 if n1 < n2: return -1
103 if n1 > n2: return 1
104 # all corresponding values are equal... see if one has extra values
105 if len(v1) < len(v2): return -1
106 if len(v1) > len(v2): return 1
107 return 0
108
109# SCons version numbers need special processing because they can have
110# charecters and an release date embedded in them. This function does
111# the magic to extract them in a similar way to the SCons internal function
112# function does and then checks that the current version is not contained in
113# a list of version tuples (bad_ver_strs)
114def CheckSCons(bad_ver_strs):
115 def scons_ver(v):
116 num_parts = v.split(' ')[0].split('.')
117 major = int(num_parts[0])
118 minor = int(re.match('\d+', num_parts[1]).group())
119 rev = 0
120 rdate = 0
121 if len(num_parts) > 2:
122 try: rev = int(re.match('\d+', num_parts[2]).group())
123 except: pass
124 rev_parts = num_parts[2].split('d')
125 if len(rev_parts) > 1:
126 rdate = int(re.match('\d+', rev_parts[1]).group())
127
128 return (major, minor, rev, rdate)
129
130 sc_ver = scons_ver(SCons.__version__)
131 for bad_ver in bad_ver_strs:
132 bv = (scons_ver(bad_ver[0]), scons_ver(bad_ver[1]))
133 if compare_versions(sc_ver, bv[0]) != -1 and\
134 compare_versions(sc_ver, bv[1]) != 1:
135 print "The version of SCons that you have installed: ", SCons.__version__
136 print "has a bug that prevents it from working correctly with M5."
137 print "Please install a version NOT contained within the following",
138 print "ranges (inclusive):"
139 for bad_ver in bad_ver_strs:
140 print " %s - %s" % bad_ver
141 Exit(2)
142
143CheckSCons((
144 # We need a version that is 0.96.91 or newer
145 ('0.0.0', '0.96.90'),
146 ))
147
148
149# The absolute path to the current directory (where this file lives).
150ROOT = Dir('.').abspath
151
152# Path to the M5 source tree.
153SRCDIR = joinpath(ROOT, 'src')
154
155# tell python where to find m5 python code
156sys.path.append(joinpath(ROOT, 'src/python'))
157
158def check_style_hook(ui):
159 ui.readconfig(joinpath(ROOT, '.hg', 'hgrc'))
160 style_hook = ui.config('hooks', 'pretxncommit.style', None)
161
162 if not style_hook:
163 print """\
164You're missing the M5 style hook.
165Please install the hook so we can ensure that all code fits a common style.
166
167All you'd need to do is add the following lines to your repository .hg/hgrc
168or your personal .hgrc
169----------------
170
171[extensions]
172style = %s/util/style.py
173
174[hooks]
175pretxncommit.style = python:style.check_whitespace
176""" % (ROOT)
177 sys.exit(1)
178
179if ARGUMENTS.get('IGNORE_STYLE') != 'True' and isdir(joinpath(ROOT, '.hg')):
180 try:
181 from mercurial import ui
182 check_style_hook(ui.ui())
183 except ImportError:
184 pass
185
186###################################################
187#
188# Figure out which configurations to set up based on the path(s) of
189# the target(s).
190#
191###################################################
192
193# Find default configuration & binary.
194Default(os.environ.get('M5_DEFAULT_BINARY', 'build/ALPHA_SE/m5.debug'))
195
196# helper function: find last occurrence of element in list
197def rfind(l, elt, offs = -1):
198 for i in range(len(l)+offs, 0, -1):
199 if l[i] == elt:
200 return i
201 raise ValueError, "element not found"
202
203# Each target must have 'build' in the interior of the path; the
204# directory below this will determine the build parameters. For
205# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
206# recognize that ALPHA_SE specifies the configuration because it
207# follow 'build' in the bulid path.
208
209# Generate absolute paths to targets so we can see where the build dir is
210if COMMAND_LINE_TARGETS:
211 # Ask SCons which directory it was invoked from
212 launch_dir = GetLaunchDir()
213 # Make targets relative to invocation directory
214 abs_targets = map(lambda x: os.path.normpath(joinpath(launch_dir, str(x))),
215 COMMAND_LINE_TARGETS)
216else:
217 # Default targets are relative to root of tree
218 abs_targets = map(lambda x: os.path.normpath(joinpath(ROOT, str(x))),
219 DEFAULT_TARGETS)
220
221
222# Generate a list of the unique build roots and configs that the
223# collected targets reference.
224build_paths = []
225build_root = None
226for t in abs_targets:
227 path_dirs = t.split('/')
228 try:
229 build_top = rfind(path_dirs, 'build', -2)
230 except:
231 print "Error: no non-leaf 'build' dir found on target path", t
232 Exit(1)
233 this_build_root = joinpath('/',*path_dirs[:build_top+1])
234 if not build_root:
235 build_root = this_build_root
236 else:
237 if this_build_root != build_root:
238 print "Error: build targets not under same build root\n"\
239 " %s\n %s" % (build_root, this_build_root)
240 Exit(1)
241 build_path = joinpath('/',*path_dirs[:build_top+2])
242 if build_path not in build_paths:
243 build_paths.append(build_path)
244
245# Make sure build_root exists (might not if this is the first build there)
246if not isdir(build_root):
247 os.mkdir(build_root)
248
249###################################################
250#
251# Set up the default build environment. This environment is copied
252# and modified according to each selected configuration.
253#
254###################################################
255
256env = Environment(ENV = os.environ, # inherit user's environment vars
257 ROOT = ROOT,
258 SRCDIR = SRCDIR)
259
260Export('env')
261
262env.SConsignFile(joinpath(build_root,"sconsign"))
263
264# Default duplicate option is to use hard links, but this messes up
265# when you use emacs to edit a file in the target dir, as emacs moves
266# file to file~ then copies to file, breaking the link. Symbolic
267# (soft) links work better.
268env.SetOption('duplicate', 'soft-copy')
269
270# I waffle on this setting... it does avoid a few painful but
271# unnecessary builds, but it also seems to make trivial builds take
272# noticeably longer.
273if False:
274 env.TargetSignatures('content')
275
276#
277# Set up global sticky options... these are common to an entire build
278# tree (not specific to a particular build like ALPHA_SE)
279#
280
281# Option validators & converters for global sticky options
282def PathListMakeAbsolute(val):
283 if not val:
284 return val
285 f = lambda p: os.path.abspath(os.path.expanduser(p))
286 return ':'.join(map(f, val.split(':')))
287
288def PathListAllExist(key, val, env):
289 if not val:
290 return
291 paths = val.split(':')
292 for path in paths:
293 if not isdir(path):
294 raise SCons.Errors.UserError("Path does not exist: '%s'" % path)
295
296global_sticky_opts_file = joinpath(build_root, 'options.global')
297
298global_sticky_opts = Options(global_sticky_opts_file, args=ARGUMENTS)
299
300global_sticky_opts.AddOptions(
301 ('CC', 'C compiler', os.environ.get('CC', env['CC'])),
302 ('CXX', 'C++ compiler', os.environ.get('CXX', env['CXX'])),
303 ('BATCH', 'Use batch pool for build and tests', False),
304 ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
305 ('EXTRAS', 'Add Extra directories to the compilation', '',
306 PathListAllExist, PathListMakeAbsolute)
307 )
308
309
310# base help text
311help_text = '''
312Usage: scons [scons options] [build options] [target(s)]
313
314'''
315
316help_text += "Global sticky options:\n" \
317 + global_sticky_opts.GenerateHelpText(env)
318
319# Update env with values from ARGUMENTS & file global_sticky_opts_file
320global_sticky_opts.Update(env)
321
322# Save sticky option settings back to current options file
323global_sticky_opts.Save(global_sticky_opts_file, env)
324
325# Parse EXTRAS option to build list of all directories where we're
326# look for sources etc. This list is exported as base_dir_list.
327base_dir_list = [joinpath(ROOT, 'src')]
328if env['EXTRAS']:
329 base_dir_list += env['EXTRAS'].split(':')
330
331Export('base_dir_list')
332
333# M5_PLY is used by isa_parser.py to find the PLY package.
334env.Append(ENV = { 'M5_PLY' : str(Dir('ext/ply')) })
335env['GCC'] = subprocess.Popen(env['CXX'] + ' --version', shell=True,
336 stdout=subprocess.PIPE, stderr=subprocess.STDOUT,
337 close_fds=True).communicate()[0].find('g++') >= 0
338env['SUNCC'] = subprocess.Popen(env['CXX'] + ' -V', shell=True,
339 stdout=subprocess.PIPE, stderr=subprocess.STDOUT,
340 close_fds=True).communicate()[0].find('Sun C++') >= 0
341env['ICC'] = subprocess.Popen(env['CXX'] + ' -V', shell=True,
342 stdout=subprocess.PIPE, stderr=subprocess.STDOUT,
343 close_fds=True).communicate()[0].find('Intel') >= 0
344if env['GCC'] + env['SUNCC'] + env['ICC'] > 1:
345 print 'Error: How can we have two at the same time?'
346 Exit(1)
347
348
349# Set up default C++ compiler flags
350if env['GCC']:
351 env.Append(CCFLAGS='-pipe')
352 env.Append(CCFLAGS='-fno-strict-aliasing')
353 env.Append(CCFLAGS=Split('-Wall -Wno-sign-compare -Werror -Wundef'))
| 1# -*- mode:python -*-
2
3# Copyright (c) 2004-2005 The Regents of The University of Michigan
4# All rights reserved.
5#
6# Redistribution and use in source and binary forms, with or without
7# modification, are permitted provided that the following conditions are
8# met: redistributions of source code must retain the above copyright
9# notice, this list of conditions and the following disclaimer;
10# redistributions in binary form must reproduce the above copyright
11# notice, this list of conditions and the following disclaimer in the
12# documentation and/or other materials provided with the distribution;
13# neither the name of the copyright holders nor the names of its
14# contributors may be used to endorse or promote products derived from
15# this software without specific prior written permission.
16#
17# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28#
29# Authors: Steve Reinhardt
30
31###################################################
32#
33# SCons top-level build description (SConstruct) file.
34#
35# While in this directory ('m5'), just type 'scons' to build the default
36# configuration (see below), or type 'scons build/<CONFIG>/<binary>'
37# to build some other configuration (e.g., 'build/ALPHA_FS/m5.opt' for
38# the optimized full-system version).
39#
40# You can build M5 in a different directory as long as there is a
41# 'build/<CONFIG>' somewhere along the target path. The build system
42# expects that all configs under the same build directory are being
43# built for the same host system.
44#
45# Examples:
46#
47# The following two commands are equivalent. The '-u' option tells
48# scons to search up the directory tree for this SConstruct file.
49# % cd <path-to-src>/m5 ; scons build/ALPHA_FS/m5.debug
50# % cd <path-to-src>/m5/build/ALPHA_FS; scons -u m5.debug
51#
52# The following two commands are equivalent and demonstrate building
53# in a directory outside of the source tree. The '-C' option tells
54# scons to chdir to the specified directory to find this SConstruct
55# file.
56# % cd <path-to-src>/m5 ; scons /local/foo/build/ALPHA_FS/m5.debug
57# % cd /local/foo/build/ALPHA_FS; scons -C <path-to-src>/m5 m5.debug
58#
59# You can use 'scons -H' to print scons options. If you're in this
60# 'm5' directory (or use -u or -C to tell scons where to find this
61# file), you can use 'scons -h' to print all the M5-specific build
62# options as well.
63#
64###################################################
65
66import sys
67import os
68import re
69
70from os.path import isdir, isfile, join as joinpath
71
72import SCons
73
74# Check for recent-enough Python and SCons versions. If your system's
75# default installation of Python is not recent enough, you can use a
76# non-default installation of the Python interpreter by either (1)
77# rearranging your PATH so that scons finds the non-default 'python'
78# first or (2) explicitly invoking an alternative interpreter on the
79# scons script, e.g., "/usr/local/bin/python2.4 `which scons` [args]".
80EnsurePythonVersion(2,4)
81
82# Import subprocess after we check the version since it doesn't exist in
83# Python < 2.4.
84import subprocess
85
86# helper function: compare arrays or strings of version numbers.
87# E.g., compare_version((1,3,25), (1,4,1)')
88# returns -1, 0, 1 if v1 is <, ==, > v2
89def compare_versions(v1, v2):
90 def make_version_list(v):
91 if isinstance(v, (list,tuple)):
92 return v
93 elif isinstance(v, str):
94 return map(int, v.split('.'))
95 else:
96 raise TypeError
97
98 v1 = make_version_list(v1)
99 v2 = make_version_list(v2)
100 # Compare corresponding elements of lists
101 for n1,n2 in zip(v1, v2):
102 if n1 < n2: return -1
103 if n1 > n2: return 1
104 # all corresponding values are equal... see if one has extra values
105 if len(v1) < len(v2): return -1
106 if len(v1) > len(v2): return 1
107 return 0
108
109# SCons version numbers need special processing because they can have
110# charecters and an release date embedded in them. This function does
111# the magic to extract them in a similar way to the SCons internal function
112# function does and then checks that the current version is not contained in
113# a list of version tuples (bad_ver_strs)
114def CheckSCons(bad_ver_strs):
115 def scons_ver(v):
116 num_parts = v.split(' ')[0].split('.')
117 major = int(num_parts[0])
118 minor = int(re.match('\d+', num_parts[1]).group())
119 rev = 0
120 rdate = 0
121 if len(num_parts) > 2:
122 try: rev = int(re.match('\d+', num_parts[2]).group())
123 except: pass
124 rev_parts = num_parts[2].split('d')
125 if len(rev_parts) > 1:
126 rdate = int(re.match('\d+', rev_parts[1]).group())
127
128 return (major, minor, rev, rdate)
129
130 sc_ver = scons_ver(SCons.__version__)
131 for bad_ver in bad_ver_strs:
132 bv = (scons_ver(bad_ver[0]), scons_ver(bad_ver[1]))
133 if compare_versions(sc_ver, bv[0]) != -1 and\
134 compare_versions(sc_ver, bv[1]) != 1:
135 print "The version of SCons that you have installed: ", SCons.__version__
136 print "has a bug that prevents it from working correctly with M5."
137 print "Please install a version NOT contained within the following",
138 print "ranges (inclusive):"
139 for bad_ver in bad_ver_strs:
140 print " %s - %s" % bad_ver
141 Exit(2)
142
143CheckSCons((
144 # We need a version that is 0.96.91 or newer
145 ('0.0.0', '0.96.90'),
146 ))
147
148
149# The absolute path to the current directory (where this file lives).
150ROOT = Dir('.').abspath
151
152# Path to the M5 source tree.
153SRCDIR = joinpath(ROOT, 'src')
154
155# tell python where to find m5 python code
156sys.path.append(joinpath(ROOT, 'src/python'))
157
158def check_style_hook(ui):
159 ui.readconfig(joinpath(ROOT, '.hg', 'hgrc'))
160 style_hook = ui.config('hooks', 'pretxncommit.style', None)
161
162 if not style_hook:
163 print """\
164You're missing the M5 style hook.
165Please install the hook so we can ensure that all code fits a common style.
166
167All you'd need to do is add the following lines to your repository .hg/hgrc
168or your personal .hgrc
169----------------
170
171[extensions]
172style = %s/util/style.py
173
174[hooks]
175pretxncommit.style = python:style.check_whitespace
176""" % (ROOT)
177 sys.exit(1)
178
179if ARGUMENTS.get('IGNORE_STYLE') != 'True' and isdir(joinpath(ROOT, '.hg')):
180 try:
181 from mercurial import ui
182 check_style_hook(ui.ui())
183 except ImportError:
184 pass
185
186###################################################
187#
188# Figure out which configurations to set up based on the path(s) of
189# the target(s).
190#
191###################################################
192
193# Find default configuration & binary.
194Default(os.environ.get('M5_DEFAULT_BINARY', 'build/ALPHA_SE/m5.debug'))
195
196# helper function: find last occurrence of element in list
197def rfind(l, elt, offs = -1):
198 for i in range(len(l)+offs, 0, -1):
199 if l[i] == elt:
200 return i
201 raise ValueError, "element not found"
202
203# Each target must have 'build' in the interior of the path; the
204# directory below this will determine the build parameters. For
205# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
206# recognize that ALPHA_SE specifies the configuration because it
207# follow 'build' in the bulid path.
208
209# Generate absolute paths to targets so we can see where the build dir is
210if COMMAND_LINE_TARGETS:
211 # Ask SCons which directory it was invoked from
212 launch_dir = GetLaunchDir()
213 # Make targets relative to invocation directory
214 abs_targets = map(lambda x: os.path.normpath(joinpath(launch_dir, str(x))),
215 COMMAND_LINE_TARGETS)
216else:
217 # Default targets are relative to root of tree
218 abs_targets = map(lambda x: os.path.normpath(joinpath(ROOT, str(x))),
219 DEFAULT_TARGETS)
220
221
222# Generate a list of the unique build roots and configs that the
223# collected targets reference.
224build_paths = []
225build_root = None
226for t in abs_targets:
227 path_dirs = t.split('/')
228 try:
229 build_top = rfind(path_dirs, 'build', -2)
230 except:
231 print "Error: no non-leaf 'build' dir found on target path", t
232 Exit(1)
233 this_build_root = joinpath('/',*path_dirs[:build_top+1])
234 if not build_root:
235 build_root = this_build_root
236 else:
237 if this_build_root != build_root:
238 print "Error: build targets not under same build root\n"\
239 " %s\n %s" % (build_root, this_build_root)
240 Exit(1)
241 build_path = joinpath('/',*path_dirs[:build_top+2])
242 if build_path not in build_paths:
243 build_paths.append(build_path)
244
245# Make sure build_root exists (might not if this is the first build there)
246if not isdir(build_root):
247 os.mkdir(build_root)
248
249###################################################
250#
251# Set up the default build environment. This environment is copied
252# and modified according to each selected configuration.
253#
254###################################################
255
256env = Environment(ENV = os.environ, # inherit user's environment vars
257 ROOT = ROOT,
258 SRCDIR = SRCDIR)
259
260Export('env')
261
262env.SConsignFile(joinpath(build_root,"sconsign"))
263
264# Default duplicate option is to use hard links, but this messes up
265# when you use emacs to edit a file in the target dir, as emacs moves
266# file to file~ then copies to file, breaking the link. Symbolic
267# (soft) links work better.
268env.SetOption('duplicate', 'soft-copy')
269
270# I waffle on this setting... it does avoid a few painful but
271# unnecessary builds, but it also seems to make trivial builds take
272# noticeably longer.
273if False:
274 env.TargetSignatures('content')
275
276#
277# Set up global sticky options... these are common to an entire build
278# tree (not specific to a particular build like ALPHA_SE)
279#
280
281# Option validators & converters for global sticky options
282def PathListMakeAbsolute(val):
283 if not val:
284 return val
285 f = lambda p: os.path.abspath(os.path.expanduser(p))
286 return ':'.join(map(f, val.split(':')))
287
288def PathListAllExist(key, val, env):
289 if not val:
290 return
291 paths = val.split(':')
292 for path in paths:
293 if not isdir(path):
294 raise SCons.Errors.UserError("Path does not exist: '%s'" % path)
295
296global_sticky_opts_file = joinpath(build_root, 'options.global')
297
298global_sticky_opts = Options(global_sticky_opts_file, args=ARGUMENTS)
299
300global_sticky_opts.AddOptions(
301 ('CC', 'C compiler', os.environ.get('CC', env['CC'])),
302 ('CXX', 'C++ compiler', os.environ.get('CXX', env['CXX'])),
303 ('BATCH', 'Use batch pool for build and tests', False),
304 ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
305 ('EXTRAS', 'Add Extra directories to the compilation', '',
306 PathListAllExist, PathListMakeAbsolute)
307 )
308
309
310# base help text
311help_text = '''
312Usage: scons [scons options] [build options] [target(s)]
313
314'''
315
316help_text += "Global sticky options:\n" \
317 + global_sticky_opts.GenerateHelpText(env)
318
319# Update env with values from ARGUMENTS & file global_sticky_opts_file
320global_sticky_opts.Update(env)
321
322# Save sticky option settings back to current options file
323global_sticky_opts.Save(global_sticky_opts_file, env)
324
325# Parse EXTRAS option to build list of all directories where we're
326# look for sources etc. This list is exported as base_dir_list.
327base_dir_list = [joinpath(ROOT, 'src')]
328if env['EXTRAS']:
329 base_dir_list += env['EXTRAS'].split(':')
330
331Export('base_dir_list')
332
333# M5_PLY is used by isa_parser.py to find the PLY package.
334env.Append(ENV = { 'M5_PLY' : str(Dir('ext/ply')) })
335env['GCC'] = subprocess.Popen(env['CXX'] + ' --version', shell=True,
336 stdout=subprocess.PIPE, stderr=subprocess.STDOUT,
337 close_fds=True).communicate()[0].find('g++') >= 0
338env['SUNCC'] = subprocess.Popen(env['CXX'] + ' -V', shell=True,
339 stdout=subprocess.PIPE, stderr=subprocess.STDOUT,
340 close_fds=True).communicate()[0].find('Sun C++') >= 0
341env['ICC'] = subprocess.Popen(env['CXX'] + ' -V', shell=True,
342 stdout=subprocess.PIPE, stderr=subprocess.STDOUT,
343 close_fds=True).communicate()[0].find('Intel') >= 0
344if env['GCC'] + env['SUNCC'] + env['ICC'] > 1:
345 print 'Error: How can we have two at the same time?'
346 Exit(1)
347
348
349# Set up default C++ compiler flags
350if env['GCC']:
351 env.Append(CCFLAGS='-pipe')
352 env.Append(CCFLAGS='-fno-strict-aliasing')
353 env.Append(CCFLAGS=Split('-Wall -Wno-sign-compare -Werror -Wundef'))
|
354elif env['ICC']:
355 pass #Fix me... add warning flags once we clean up icc warnings
356elif env['SUNCC']:
357 env.Append(CCFLAGS='-Qoption ccfe')
358 env.Append(CCFLAGS='-features=gcc')
359 env.Append(CCFLAGS='-features=extensions')
360 env.Append(CCFLAGS='-library=stlport4')
361 env.Append(CCFLAGS='-xar')
362# env.Append(CCFLAGS='-instances=semiexplicit')
363else:
364 print 'Error: Don\'t know what compiler options to use for your compiler.'
365 print ' Please fix SConstruct and src/SConscript and try again.'
366 Exit(1)
367
368# Do this after we save setting back, or else we'll tack on an
369# extra 'qdo' every time we run scons.
370if env['BATCH']:
371 env['CC'] = env['BATCH_CMD'] + ' ' + env['CC']
372 env['CXX'] = env['BATCH_CMD'] + ' ' + env['CXX']
373
374if sys.platform == 'cygwin':
375 # cygwin has some header file issues...
376 env.Append(CCFLAGS=Split("-Wno-uninitialized"))
377env.Append(CPPPATH=[Dir('ext/dnet')])
378
379# Check for SWIG
380if not env.has_key('SWIG'):
381 print 'Error: SWIG utility not found.'
382 print ' Please install (see http://www.swig.org) and retry.'
383 Exit(1)
384
385# Check for appropriate SWIG version
386swig_version = os.popen('swig -version').read().split()
387# First 3 words should be "SWIG Version x.y.z"
388if len(swig_version) < 3 or \
389 swig_version[0] != 'SWIG' or swig_version[1] != 'Version':
390 print 'Error determining SWIG version.'
391 Exit(1)
392
393min_swig_version = '1.3.28'
394if compare_versions(swig_version[2], min_swig_version) < 0:
395 print 'Error: SWIG version', min_swig_version, 'or newer required.'
396 print ' Installed version:', swig_version[2]
397 Exit(1)
398
399# Set up SWIG flags & scanner
400swig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
401env.Append(SWIGFLAGS=swig_flags)
402
403# filter out all existing swig scanners, they mess up the dependency
404# stuff for some reason
405scanners = []
406for scanner in env['SCANNERS']:
407 skeys = scanner.skeys
408 if skeys == '.i':
409 continue
410
411 if isinstance(skeys, (list, tuple)) and '.i' in skeys:
412 continue
413
414 scanners.append(scanner)
415
416# add the new swig scanner that we like better
417from SCons.Scanner import ClassicCPP as CPPScanner
418swig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
419scanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re))
420
421# replace the scanners list that has what we want
422env['SCANNERS'] = scanners
423
424# Add a custom Check function to the Configure context so that we can
425# figure out if the compiler adds leading underscores to global
426# variables. This is needed for the autogenerated asm files that we
427# use for embedding the python code.
428def CheckLeading(context):
429 context.Message("Checking for leading underscore in global variables...")
430 # 1) Define a global variable called x from asm so the C compiler
431 # won't change the symbol at all.
432 # 2) Declare that variable.
433 # 3) Use the variable
434 #
435 # If the compiler prepends an underscore, this will successfully
436 # link because the external symbol 'x' will be called '_x' which
437 # was defined by the asm statement. If the compiler does not
438 # prepend an underscore, this will not successfully link because
439 # '_x' will have been defined by assembly, while the C portion of
440 # the code will be trying to use 'x'
441 ret = context.TryLink('''
442 asm(".globl _x; _x: .byte 0");
443 extern int x;
444 int main() { return x; }
445 ''', extension=".c")
446 context.env.Append(LEADING_UNDERSCORE=ret)
447 context.Result(ret)
448 return ret
449
450# Platform-specific configuration. Note again that we assume that all
451# builds under a given build root run on the same host platform.
452conf = Configure(env,
453 conf_dir = joinpath(build_root, '.scons_config'),
454 log_file = joinpath(build_root, 'scons_config.log'),
455 custom_tests = { 'CheckLeading' : CheckLeading })
456
457# Check for leading underscores. Don't really need to worry either
458# way so don't need to check the return code.
459conf.CheckLeading()
460
461# Check if we should compile a 64 bit binary on Mac OS X/Darwin
462try:
463 import platform
464 uname = platform.uname()
465 if uname[0] == 'Darwin' and compare_versions(uname[2], '9.0.0') >= 0:
466 if int(subprocess.Popen('sysctl -n hw.cpu64bit_capable', shell=True,
467 stdout=subprocess.PIPE, stderr=subprocess.STDOUT,
468 close_fds=True).communicate()[0][0]):
469 env.Append(CCFLAGS='-arch x86_64')
470 env.Append(CFLAGS='-arch x86_64')
471 env.Append(LINKFLAGS='-arch x86_64')
472 env.Append(ASFLAGS='-arch x86_64')
473except:
474 pass
475
476# Recent versions of scons substitute a "Null" object for Configure()
477# when configuration isn't necessary, e.g., if the "--help" option is
478# present. Unfortuantely this Null object always returns false,
479# breaking all our configuration checks. We replace it with our own
480# more optimistic null object that returns True instead.
481if not conf:
482 def NullCheck(*args, **kwargs):
483 return True
484
485 class NullConf:
486 def __init__(self, env):
487 self.env = env
488 def Finish(self):
489 return self.env
490 def __getattr__(self, mname):
491 return NullCheck
492
493 conf = NullConf(env)
494
495# Find Python include and library directories for embedding the
496# interpreter. For consistency, we will use the same Python
497# installation used to run scons (and thus this script). If you want
498# to link in an alternate version, see above for instructions on how
499# to invoke scons with a different copy of the Python interpreter.
500
501# Get brief Python version name (e.g., "python2.4") for locating
502# include & library files
503py_version_name = 'python' + sys.version[:3]
504
505# include path, e.g. /usr/local/include/python2.4
506py_header_path = joinpath(sys.exec_prefix, 'include', py_version_name)
507env.Append(CPPPATH = py_header_path)
508# verify that it works
509if not conf.CheckHeader('Python.h', '<>'):
510 print "Error: can't find Python.h header in", py_header_path
511 Exit(1)
512
513# add library path too if it's not in the default place
514py_lib_path = None
515if sys.exec_prefix != '/usr':
516 py_lib_path = joinpath(sys.exec_prefix, 'lib')
517elif sys.platform == 'cygwin':
518 # cygwin puts the .dll in /bin for some reason
519 py_lib_path = '/bin'
520if py_lib_path:
521 env.Append(LIBPATH = py_lib_path)
522 print 'Adding', py_lib_path, 'to LIBPATH for', py_version_name
523if not conf.CheckLib(py_version_name):
524 print "Error: can't find Python library", py_version_name
525 Exit(1)
526
527# On Solaris you need to use libsocket for socket ops
528if not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
529 if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
530 print "Can't find library with socket calls (e.g. accept())"
531 Exit(1)
532
533# Check for zlib. If the check passes, libz will be automatically
534# added to the LIBS environment variable.
535if not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
536 print 'Error: did not find needed zlib compression library '\
537 'and/or zlib.h header file.'
538 print ' Please install zlib and try again.'
539 Exit(1)
540
541# Check for <fenv.h> (C99 FP environment control)
542have_fenv = conf.CheckHeader('fenv.h', '<>')
543if not have_fenv:
544 print "Warning: Header file <fenv.h> not found."
545 print " This host has no IEEE FP rounding mode control."
546
547# Check for mysql.
548mysql_config = WhereIs('mysql_config')
549have_mysql = mysql_config != None
550
551# Check MySQL version.
552if have_mysql:
553 mysql_version = os.popen(mysql_config + ' --version').read()
554 min_mysql_version = '4.1'
555 if compare_versions(mysql_version, min_mysql_version) < 0:
556 print 'Warning: MySQL', min_mysql_version, 'or newer required.'
557 print ' Version', mysql_version, 'detected.'
558 have_mysql = False
559
560# Set up mysql_config commands.
561if have_mysql:
562 mysql_config_include = mysql_config + ' --include'
563 if os.system(mysql_config_include + ' > /dev/null') != 0:
564 # older mysql_config versions don't support --include, use
565 # --cflags instead
566 mysql_config_include = mysql_config + ' --cflags | sed s/\\\'//g'
567 # This seems to work in all versions
568 mysql_config_libs = mysql_config + ' --libs'
569
570env = conf.Finish()
571
572# Define the universe of supported ISAs
573all_isa_list = [ ]
574Export('all_isa_list')
575
576# Define the universe of supported CPU models
577all_cpu_list = [ ]
578default_cpus = [ ]
579Export('all_cpu_list', 'default_cpus')
580
581# Sticky options get saved in the options file so they persist from
582# one invocation to the next (unless overridden, in which case the new
583# value becomes sticky).
584sticky_opts = Options(args=ARGUMENTS)
585Export('sticky_opts')
586
587# Non-sticky options only apply to the current build.
588nonsticky_opts = Options(args=ARGUMENTS)
589Export('nonsticky_opts')
590
591# Walk the tree and execute all SConsopts scripts that wil add to the
592# above options
593for base_dir in base_dir_list:
594 for root, dirs, files in os.walk(base_dir):
595 if 'SConsopts' in files:
596 print "Reading", joinpath(root, 'SConsopts')
597 SConscript(joinpath(root, 'SConsopts'))
598
599all_isa_list.sort()
600all_cpu_list.sort()
601default_cpus.sort()
602
603sticky_opts.AddOptions(
604 EnumOption('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list),
605 BoolOption('FULL_SYSTEM', 'Full-system support', False),
606 # There's a bug in scons 0.96.1 that causes ListOptions with list
607 # values (more than one value) not to be able to be restored from
608 # a saved option file. If this causes trouble then upgrade to
609 # scons 0.96.90 or later.
610 ListOption('CPU_MODELS', 'CPU models', default_cpus, all_cpu_list),
611 BoolOption('NO_FAST_ALLOC', 'Disable fast object allocator', False),
612 BoolOption('FAST_ALLOC_DEBUG', 'Enable fast object allocator debugging',
613 False),
614 BoolOption('FAST_ALLOC_STATS', 'Enable fast object allocator statistics',
615 False),
616 BoolOption('EFENCE', 'Link with Electric Fence malloc debugger',
617 False),
618 BoolOption('SS_COMPATIBLE_FP',
619 'Make floating-point results compatible with SimpleScalar',
620 False),
621 BoolOption('USE_SSE2',
622 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
623 False),
624 BoolOption('USE_MYSQL', 'Use MySQL for stats output', have_mysql),
625 BoolOption('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
626 BoolOption('USE_CHECKER', 'Use checker for detailed CPU models', False),
627 )
628
629nonsticky_opts.AddOptions(
630 BoolOption('update_ref', 'Update test reference outputs', False)
631 )
632
633# These options get exported to #defines in config/*.hh (see src/SConscript).
634env.ExportOptions = ['FULL_SYSTEM', 'ALPHA_TLASER', 'USE_FENV', \
635 'USE_MYSQL', 'NO_FAST_ALLOC', 'FAST_ALLOC_DEBUG', \
636 'FAST_ALLOC_STATS', 'SS_COMPATIBLE_FP', \
637 'USE_CHECKER', 'TARGET_ISA']
638
639# Define a handy 'no-op' action
640def no_action(target, source, env):
641 return 0
642
643env.NoAction = Action(no_action, None)
644
645###################################################
646#
647# Define a SCons builder for configuration flag headers.
648#
649###################################################
650
651# This function generates a config header file that #defines the
652# option symbol to the current option setting (0 or 1). The source
653# operands are the name of the option and a Value node containing the
654# value of the option.
655def build_config_file(target, source, env):
656 (option, value) = [s.get_contents() for s in source]
657 f = file(str(target[0]), 'w')
658 print >> f, '#define', option, value
659 f.close()
660 return None
661
662# Generate the message to be printed when building the config file.
663def build_config_file_string(target, source, env):
664 (option, value) = [s.get_contents() for s in source]
665 return "Defining %s as %s in %s." % (option, value, target[0])
666
667# Combine the two functions into a scons Action object.
668config_action = Action(build_config_file, build_config_file_string)
669
670# The emitter munges the source & target node lists to reflect what
671# we're really doing.
672def config_emitter(target, source, env):
673 # extract option name from Builder arg
674 option = str(target[0])
675 # True target is config header file
676 target = joinpath('config', option.lower() + '.hh')
677 val = env[option]
678 if isinstance(val, bool):
679 # Force value to 0/1
680 val = int(val)
681 elif isinstance(val, str):
682 val = '"' + val + '"'
683
684 # Sources are option name & value (packaged in SCons Value nodes)
685 return ([target], [Value(option), Value(val)])
686
687config_builder = Builder(emitter = config_emitter, action = config_action)
688
689env.Append(BUILDERS = { 'ConfigFile' : config_builder })
690
691###################################################
692#
693# Define a SCons builder for copying files. This is used by the
694# Python zipfile code in src/python/SConscript, but is placed up here
695# since it's potentially more generally applicable.
696#
697###################################################
698
699copy_builder = Builder(action = Copy("$TARGET", "$SOURCE"))
700
701env.Append(BUILDERS = { 'CopyFile' : copy_builder })
702
703###################################################
704#
705# Define a simple SCons builder to concatenate files.
706#
707# Used to append the Python zip archive to the executable.
708#
709###################################################
710
711concat_builder = Builder(action = Action(['cat $SOURCES > $TARGET',
712 'chmod +x $TARGET']))
713
714env.Append(BUILDERS = { 'Concat' : concat_builder })
715
716
717# libelf build is shared across all configs in the build root.
718env.SConscript('ext/libelf/SConscript',
719 build_dir = joinpath(build_root, 'libelf'),
720 exports = 'env')
721
722###################################################
723#
724# This function is used to set up a directory with switching headers
725#
726###################################################
727
728env['ALL_ISA_LIST'] = all_isa_list
729def make_switching_dir(dirname, switch_headers, env):
730 # Generate the header. target[0] is the full path of the output
731 # header to generate. 'source' is a dummy variable, since we get the
732 # list of ISAs from env['ALL_ISA_LIST'].
733 def gen_switch_hdr(target, source, env):
734 fname = str(target[0])
735 basename = os.path.basename(fname)
736 f = open(fname, 'w')
737 f.write('#include "arch/isa_specific.hh"\n')
738 cond = '#if'
739 for isa in all_isa_list:
740 f.write('%s THE_ISA == %s_ISA\n#include "%s/%s/%s"\n'
741 % (cond, isa.upper(), dirname, isa, basename))
742 cond = '#elif'
743 f.write('#else\n#error "THE_ISA not set"\n#endif\n')
744 f.close()
745 return 0
746
747 # String to print when generating header
748 def gen_switch_hdr_string(target, source, env):
749 return "Generating switch header " + str(target[0])
750
751 # Build SCons Action object. 'varlist' specifies env vars that this
752 # action depends on; when env['ALL_ISA_LIST'] changes these actions
753 # should get re-executed.
754 switch_hdr_action = Action(gen_switch_hdr, gen_switch_hdr_string,
755 varlist=['ALL_ISA_LIST'])
756
757 # Instantiate actions for each header
758 for hdr in switch_headers:
759 env.Command(hdr, [], switch_hdr_action)
760Export('make_switching_dir')
761
762###################################################
763#
764# Define build environments for selected configurations.
765#
766###################################################
767
768# rename base env
769base_env = env
770
771for build_path in build_paths:
772 print "Building in", build_path
773
774 # Make a copy of the build-root environment to use for this config.
775 env = base_env.Copy()
776 env['BUILDDIR'] = build_path
777
778 # build_dir is the tail component of build path, and is used to
779 # determine the build parameters (e.g., 'ALPHA_SE')
780 (build_root, build_dir) = os.path.split(build_path)
781
782 # Set env options according to the build directory config.
783 sticky_opts.files = []
784 # Options for $BUILD_ROOT/$BUILD_DIR are stored in
785 # $BUILD_ROOT/options/$BUILD_DIR so you can nuke
786 # $BUILD_ROOT/$BUILD_DIR without losing your options settings.
787 current_opts_file = joinpath(build_root, 'options', build_dir)
788 if isfile(current_opts_file):
789 sticky_opts.files.append(current_opts_file)
790 print "Using saved options file %s" % current_opts_file
791 else:
792 # Build dir-specific options file doesn't exist.
793
794 # Make sure the directory is there so we can create it later
795 opt_dir = os.path.dirname(current_opts_file)
796 if not isdir(opt_dir):
797 os.mkdir(opt_dir)
798
799 # Get default build options from source tree. Options are
800 # normally determined by name of $BUILD_DIR, but can be
801 # overriden by 'default=' arg on command line.
802 default_opts_file = joinpath('build_opts',
803 ARGUMENTS.get('default', build_dir))
804 if isfile(default_opts_file):
805 sticky_opts.files.append(default_opts_file)
806 print "Options file %s not found,\n using defaults in %s" \
807 % (current_opts_file, default_opts_file)
808 else:
809 print "Error: cannot find options file %s or %s" \
810 % (current_opts_file, default_opts_file)
811 Exit(1)
812
813 # Apply current option settings to env
814 sticky_opts.Update(env)
815 nonsticky_opts.Update(env)
816
817 help_text += "\nSticky options for %s:\n" % build_dir \
818 + sticky_opts.GenerateHelpText(env) \
819 + "\nNon-sticky options for %s:\n" % build_dir \
820 + nonsticky_opts.GenerateHelpText(env)
821
822 # Process option settings.
823
824 if not have_fenv and env['USE_FENV']:
825 print "Warning: <fenv.h> not available; " \
826 "forcing USE_FENV to False in", build_dir + "."
827 env['USE_FENV'] = False
828
829 if not env['USE_FENV']:
830 print "Warning: No IEEE FP rounding mode control in", build_dir + "."
831 print " FP results may deviate slightly from other platforms."
832
833 if env['EFENCE']:
834 env.Append(LIBS=['efence'])
835
836 if env['USE_MYSQL']:
837 if not have_mysql:
838 print "Warning: MySQL not available; " \
839 "forcing USE_MYSQL to False in", build_dir + "."
840 env['USE_MYSQL'] = False
841 else:
842 print "Compiling in", build_dir, "with MySQL support."
843 env.ParseConfig(mysql_config_libs)
844 env.ParseConfig(mysql_config_include)
845
846 # Save sticky option settings back to current options file
847 sticky_opts.Save(current_opts_file, env)
848
849 if env['USE_SSE2']:
850 env.Append(CCFLAGS='-msse2')
851
852 # The src/SConscript file sets up the build rules in 'env' according
853 # to the configured options. It returns a list of environments,
854 # one for each variant build (debug, opt, etc.)
855 envList = SConscript('src/SConscript', build_dir = build_path,
856 exports = 'env')
857
858 # Set up the regression tests for each build.
859 for e in envList:
860 SConscript('tests/SConscript',
861 build_dir = joinpath(build_path, 'tests', e.Label),
862 exports = { 'env' : e }, duplicate = False)
863
864Help(help_text)
865
866
867###################################################
868#
869# Let SCons do its thing. At this point SCons will use the defined
870# build environments to build the requested targets.
871#
872###################################################
873
| 355elif env['ICC']:
356 pass #Fix me... add warning flags once we clean up icc warnings
357elif env['SUNCC']:
358 env.Append(CCFLAGS='-Qoption ccfe')
359 env.Append(CCFLAGS='-features=gcc')
360 env.Append(CCFLAGS='-features=extensions')
361 env.Append(CCFLAGS='-library=stlport4')
362 env.Append(CCFLAGS='-xar')
363# env.Append(CCFLAGS='-instances=semiexplicit')
364else:
365 print 'Error: Don\'t know what compiler options to use for your compiler.'
366 print ' Please fix SConstruct and src/SConscript and try again.'
367 Exit(1)
368
369# Do this after we save setting back, or else we'll tack on an
370# extra 'qdo' every time we run scons.
371if env['BATCH']:
372 env['CC'] = env['BATCH_CMD'] + ' ' + env['CC']
373 env['CXX'] = env['BATCH_CMD'] + ' ' + env['CXX']
374
375if sys.platform == 'cygwin':
376 # cygwin has some header file issues...
377 env.Append(CCFLAGS=Split("-Wno-uninitialized"))
378env.Append(CPPPATH=[Dir('ext/dnet')])
379
380# Check for SWIG
381if not env.has_key('SWIG'):
382 print 'Error: SWIG utility not found.'
383 print ' Please install (see http://www.swig.org) and retry.'
384 Exit(1)
385
386# Check for appropriate SWIG version
387swig_version = os.popen('swig -version').read().split()
388# First 3 words should be "SWIG Version x.y.z"
389if len(swig_version) < 3 or \
390 swig_version[0] != 'SWIG' or swig_version[1] != 'Version':
391 print 'Error determining SWIG version.'
392 Exit(1)
393
394min_swig_version = '1.3.28'
395if compare_versions(swig_version[2], min_swig_version) < 0:
396 print 'Error: SWIG version', min_swig_version, 'or newer required.'
397 print ' Installed version:', swig_version[2]
398 Exit(1)
399
400# Set up SWIG flags & scanner
401swig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
402env.Append(SWIGFLAGS=swig_flags)
403
404# filter out all existing swig scanners, they mess up the dependency
405# stuff for some reason
406scanners = []
407for scanner in env['SCANNERS']:
408 skeys = scanner.skeys
409 if skeys == '.i':
410 continue
411
412 if isinstance(skeys, (list, tuple)) and '.i' in skeys:
413 continue
414
415 scanners.append(scanner)
416
417# add the new swig scanner that we like better
418from SCons.Scanner import ClassicCPP as CPPScanner
419swig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
420scanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re))
421
422# replace the scanners list that has what we want
423env['SCANNERS'] = scanners
424
425# Add a custom Check function to the Configure context so that we can
426# figure out if the compiler adds leading underscores to global
427# variables. This is needed for the autogenerated asm files that we
428# use for embedding the python code.
429def CheckLeading(context):
430 context.Message("Checking for leading underscore in global variables...")
431 # 1) Define a global variable called x from asm so the C compiler
432 # won't change the symbol at all.
433 # 2) Declare that variable.
434 # 3) Use the variable
435 #
436 # If the compiler prepends an underscore, this will successfully
437 # link because the external symbol 'x' will be called '_x' which
438 # was defined by the asm statement. If the compiler does not
439 # prepend an underscore, this will not successfully link because
440 # '_x' will have been defined by assembly, while the C portion of
441 # the code will be trying to use 'x'
442 ret = context.TryLink('''
443 asm(".globl _x; _x: .byte 0");
444 extern int x;
445 int main() { return x; }
446 ''', extension=".c")
447 context.env.Append(LEADING_UNDERSCORE=ret)
448 context.Result(ret)
449 return ret
450
451# Platform-specific configuration. Note again that we assume that all
452# builds under a given build root run on the same host platform.
453conf = Configure(env,
454 conf_dir = joinpath(build_root, '.scons_config'),
455 log_file = joinpath(build_root, 'scons_config.log'),
456 custom_tests = { 'CheckLeading' : CheckLeading })
457
458# Check for leading underscores. Don't really need to worry either
459# way so don't need to check the return code.
460conf.CheckLeading()
461
462# Check if we should compile a 64 bit binary on Mac OS X/Darwin
463try:
464 import platform
465 uname = platform.uname()
466 if uname[0] == 'Darwin' and compare_versions(uname[2], '9.0.0') >= 0:
467 if int(subprocess.Popen('sysctl -n hw.cpu64bit_capable', shell=True,
468 stdout=subprocess.PIPE, stderr=subprocess.STDOUT,
469 close_fds=True).communicate()[0][0]):
470 env.Append(CCFLAGS='-arch x86_64')
471 env.Append(CFLAGS='-arch x86_64')
472 env.Append(LINKFLAGS='-arch x86_64')
473 env.Append(ASFLAGS='-arch x86_64')
474except:
475 pass
476
477# Recent versions of scons substitute a "Null" object for Configure()
478# when configuration isn't necessary, e.g., if the "--help" option is
479# present. Unfortuantely this Null object always returns false,
480# breaking all our configuration checks. We replace it with our own
481# more optimistic null object that returns True instead.
482if not conf:
483 def NullCheck(*args, **kwargs):
484 return True
485
486 class NullConf:
487 def __init__(self, env):
488 self.env = env
489 def Finish(self):
490 return self.env
491 def __getattr__(self, mname):
492 return NullCheck
493
494 conf = NullConf(env)
495
496# Find Python include and library directories for embedding the
497# interpreter. For consistency, we will use the same Python
498# installation used to run scons (and thus this script). If you want
499# to link in an alternate version, see above for instructions on how
500# to invoke scons with a different copy of the Python interpreter.
501
502# Get brief Python version name (e.g., "python2.4") for locating
503# include & library files
504py_version_name = 'python' + sys.version[:3]
505
506# include path, e.g. /usr/local/include/python2.4
507py_header_path = joinpath(sys.exec_prefix, 'include', py_version_name)
508env.Append(CPPPATH = py_header_path)
509# verify that it works
510if not conf.CheckHeader('Python.h', '<>'):
511 print "Error: can't find Python.h header in", py_header_path
512 Exit(1)
513
514# add library path too if it's not in the default place
515py_lib_path = None
516if sys.exec_prefix != '/usr':
517 py_lib_path = joinpath(sys.exec_prefix, 'lib')
518elif sys.platform == 'cygwin':
519 # cygwin puts the .dll in /bin for some reason
520 py_lib_path = '/bin'
521if py_lib_path:
522 env.Append(LIBPATH = py_lib_path)
523 print 'Adding', py_lib_path, 'to LIBPATH for', py_version_name
524if not conf.CheckLib(py_version_name):
525 print "Error: can't find Python library", py_version_name
526 Exit(1)
527
528# On Solaris you need to use libsocket for socket ops
529if not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
530 if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
531 print "Can't find library with socket calls (e.g. accept())"
532 Exit(1)
533
534# Check for zlib. If the check passes, libz will be automatically
535# added to the LIBS environment variable.
536if not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
537 print 'Error: did not find needed zlib compression library '\
538 'and/or zlib.h header file.'
539 print ' Please install zlib and try again.'
540 Exit(1)
541
542# Check for <fenv.h> (C99 FP environment control)
543have_fenv = conf.CheckHeader('fenv.h', '<>')
544if not have_fenv:
545 print "Warning: Header file <fenv.h> not found."
546 print " This host has no IEEE FP rounding mode control."
547
548# Check for mysql.
549mysql_config = WhereIs('mysql_config')
550have_mysql = mysql_config != None
551
552# Check MySQL version.
553if have_mysql:
554 mysql_version = os.popen(mysql_config + ' --version').read()
555 min_mysql_version = '4.1'
556 if compare_versions(mysql_version, min_mysql_version) < 0:
557 print 'Warning: MySQL', min_mysql_version, 'or newer required.'
558 print ' Version', mysql_version, 'detected.'
559 have_mysql = False
560
561# Set up mysql_config commands.
562if have_mysql:
563 mysql_config_include = mysql_config + ' --include'
564 if os.system(mysql_config_include + ' > /dev/null') != 0:
565 # older mysql_config versions don't support --include, use
566 # --cflags instead
567 mysql_config_include = mysql_config + ' --cflags | sed s/\\\'//g'
568 # This seems to work in all versions
569 mysql_config_libs = mysql_config + ' --libs'
570
571env = conf.Finish()
572
573# Define the universe of supported ISAs
574all_isa_list = [ ]
575Export('all_isa_list')
576
577# Define the universe of supported CPU models
578all_cpu_list = [ ]
579default_cpus = [ ]
580Export('all_cpu_list', 'default_cpus')
581
582# Sticky options get saved in the options file so they persist from
583# one invocation to the next (unless overridden, in which case the new
584# value becomes sticky).
585sticky_opts = Options(args=ARGUMENTS)
586Export('sticky_opts')
587
588# Non-sticky options only apply to the current build.
589nonsticky_opts = Options(args=ARGUMENTS)
590Export('nonsticky_opts')
591
592# Walk the tree and execute all SConsopts scripts that wil add to the
593# above options
594for base_dir in base_dir_list:
595 for root, dirs, files in os.walk(base_dir):
596 if 'SConsopts' in files:
597 print "Reading", joinpath(root, 'SConsopts')
598 SConscript(joinpath(root, 'SConsopts'))
599
600all_isa_list.sort()
601all_cpu_list.sort()
602default_cpus.sort()
603
604sticky_opts.AddOptions(
605 EnumOption('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list),
606 BoolOption('FULL_SYSTEM', 'Full-system support', False),
607 # There's a bug in scons 0.96.1 that causes ListOptions with list
608 # values (more than one value) not to be able to be restored from
609 # a saved option file. If this causes trouble then upgrade to
610 # scons 0.96.90 or later.
611 ListOption('CPU_MODELS', 'CPU models', default_cpus, all_cpu_list),
612 BoolOption('NO_FAST_ALLOC', 'Disable fast object allocator', False),
613 BoolOption('FAST_ALLOC_DEBUG', 'Enable fast object allocator debugging',
614 False),
615 BoolOption('FAST_ALLOC_STATS', 'Enable fast object allocator statistics',
616 False),
617 BoolOption('EFENCE', 'Link with Electric Fence malloc debugger',
618 False),
619 BoolOption('SS_COMPATIBLE_FP',
620 'Make floating-point results compatible with SimpleScalar',
621 False),
622 BoolOption('USE_SSE2',
623 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
624 False),
625 BoolOption('USE_MYSQL', 'Use MySQL for stats output', have_mysql),
626 BoolOption('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
627 BoolOption('USE_CHECKER', 'Use checker for detailed CPU models', False),
628 )
629
630nonsticky_opts.AddOptions(
631 BoolOption('update_ref', 'Update test reference outputs', False)
632 )
633
634# These options get exported to #defines in config/*.hh (see src/SConscript).
635env.ExportOptions = ['FULL_SYSTEM', 'ALPHA_TLASER', 'USE_FENV', \
636 'USE_MYSQL', 'NO_FAST_ALLOC', 'FAST_ALLOC_DEBUG', \
637 'FAST_ALLOC_STATS', 'SS_COMPATIBLE_FP', \
638 'USE_CHECKER', 'TARGET_ISA']
639
640# Define a handy 'no-op' action
641def no_action(target, source, env):
642 return 0
643
644env.NoAction = Action(no_action, None)
645
646###################################################
647#
648# Define a SCons builder for configuration flag headers.
649#
650###################################################
651
652# This function generates a config header file that #defines the
653# option symbol to the current option setting (0 or 1). The source
654# operands are the name of the option and a Value node containing the
655# value of the option.
656def build_config_file(target, source, env):
657 (option, value) = [s.get_contents() for s in source]
658 f = file(str(target[0]), 'w')
659 print >> f, '#define', option, value
660 f.close()
661 return None
662
663# Generate the message to be printed when building the config file.
664def build_config_file_string(target, source, env):
665 (option, value) = [s.get_contents() for s in source]
666 return "Defining %s as %s in %s." % (option, value, target[0])
667
668# Combine the two functions into a scons Action object.
669config_action = Action(build_config_file, build_config_file_string)
670
671# The emitter munges the source & target node lists to reflect what
672# we're really doing.
673def config_emitter(target, source, env):
674 # extract option name from Builder arg
675 option = str(target[0])
676 # True target is config header file
677 target = joinpath('config', option.lower() + '.hh')
678 val = env[option]
679 if isinstance(val, bool):
680 # Force value to 0/1
681 val = int(val)
682 elif isinstance(val, str):
683 val = '"' + val + '"'
684
685 # Sources are option name & value (packaged in SCons Value nodes)
686 return ([target], [Value(option), Value(val)])
687
688config_builder = Builder(emitter = config_emitter, action = config_action)
689
690env.Append(BUILDERS = { 'ConfigFile' : config_builder })
691
692###################################################
693#
694# Define a SCons builder for copying files. This is used by the
695# Python zipfile code in src/python/SConscript, but is placed up here
696# since it's potentially more generally applicable.
697#
698###################################################
699
700copy_builder = Builder(action = Copy("$TARGET", "$SOURCE"))
701
702env.Append(BUILDERS = { 'CopyFile' : copy_builder })
703
704###################################################
705#
706# Define a simple SCons builder to concatenate files.
707#
708# Used to append the Python zip archive to the executable.
709#
710###################################################
711
712concat_builder = Builder(action = Action(['cat $SOURCES > $TARGET',
713 'chmod +x $TARGET']))
714
715env.Append(BUILDERS = { 'Concat' : concat_builder })
716
717
718# libelf build is shared across all configs in the build root.
719env.SConscript('ext/libelf/SConscript',
720 build_dir = joinpath(build_root, 'libelf'),
721 exports = 'env')
722
723###################################################
724#
725# This function is used to set up a directory with switching headers
726#
727###################################################
728
729env['ALL_ISA_LIST'] = all_isa_list
730def make_switching_dir(dirname, switch_headers, env):
731 # Generate the header. target[0] is the full path of the output
732 # header to generate. 'source' is a dummy variable, since we get the
733 # list of ISAs from env['ALL_ISA_LIST'].
734 def gen_switch_hdr(target, source, env):
735 fname = str(target[0])
736 basename = os.path.basename(fname)
737 f = open(fname, 'w')
738 f.write('#include "arch/isa_specific.hh"\n')
739 cond = '#if'
740 for isa in all_isa_list:
741 f.write('%s THE_ISA == %s_ISA\n#include "%s/%s/%s"\n'
742 % (cond, isa.upper(), dirname, isa, basename))
743 cond = '#elif'
744 f.write('#else\n#error "THE_ISA not set"\n#endif\n')
745 f.close()
746 return 0
747
748 # String to print when generating header
749 def gen_switch_hdr_string(target, source, env):
750 return "Generating switch header " + str(target[0])
751
752 # Build SCons Action object. 'varlist' specifies env vars that this
753 # action depends on; when env['ALL_ISA_LIST'] changes these actions
754 # should get re-executed.
755 switch_hdr_action = Action(gen_switch_hdr, gen_switch_hdr_string,
756 varlist=['ALL_ISA_LIST'])
757
758 # Instantiate actions for each header
759 for hdr in switch_headers:
760 env.Command(hdr, [], switch_hdr_action)
761Export('make_switching_dir')
762
763###################################################
764#
765# Define build environments for selected configurations.
766#
767###################################################
768
769# rename base env
770base_env = env
771
772for build_path in build_paths:
773 print "Building in", build_path
774
775 # Make a copy of the build-root environment to use for this config.
776 env = base_env.Copy()
777 env['BUILDDIR'] = build_path
778
779 # build_dir is the tail component of build path, and is used to
780 # determine the build parameters (e.g., 'ALPHA_SE')
781 (build_root, build_dir) = os.path.split(build_path)
782
783 # Set env options according to the build directory config.
784 sticky_opts.files = []
785 # Options for $BUILD_ROOT/$BUILD_DIR are stored in
786 # $BUILD_ROOT/options/$BUILD_DIR so you can nuke
787 # $BUILD_ROOT/$BUILD_DIR without losing your options settings.
788 current_opts_file = joinpath(build_root, 'options', build_dir)
789 if isfile(current_opts_file):
790 sticky_opts.files.append(current_opts_file)
791 print "Using saved options file %s" % current_opts_file
792 else:
793 # Build dir-specific options file doesn't exist.
794
795 # Make sure the directory is there so we can create it later
796 opt_dir = os.path.dirname(current_opts_file)
797 if not isdir(opt_dir):
798 os.mkdir(opt_dir)
799
800 # Get default build options from source tree. Options are
801 # normally determined by name of $BUILD_DIR, but can be
802 # overriden by 'default=' arg on command line.
803 default_opts_file = joinpath('build_opts',
804 ARGUMENTS.get('default', build_dir))
805 if isfile(default_opts_file):
806 sticky_opts.files.append(default_opts_file)
807 print "Options file %s not found,\n using defaults in %s" \
808 % (current_opts_file, default_opts_file)
809 else:
810 print "Error: cannot find options file %s or %s" \
811 % (current_opts_file, default_opts_file)
812 Exit(1)
813
814 # Apply current option settings to env
815 sticky_opts.Update(env)
816 nonsticky_opts.Update(env)
817
818 help_text += "\nSticky options for %s:\n" % build_dir \
819 + sticky_opts.GenerateHelpText(env) \
820 + "\nNon-sticky options for %s:\n" % build_dir \
821 + nonsticky_opts.GenerateHelpText(env)
822
823 # Process option settings.
824
825 if not have_fenv and env['USE_FENV']:
826 print "Warning: <fenv.h> not available; " \
827 "forcing USE_FENV to False in", build_dir + "."
828 env['USE_FENV'] = False
829
830 if not env['USE_FENV']:
831 print "Warning: No IEEE FP rounding mode control in", build_dir + "."
832 print " FP results may deviate slightly from other platforms."
833
834 if env['EFENCE']:
835 env.Append(LIBS=['efence'])
836
837 if env['USE_MYSQL']:
838 if not have_mysql:
839 print "Warning: MySQL not available; " \
840 "forcing USE_MYSQL to False in", build_dir + "."
841 env['USE_MYSQL'] = False
842 else:
843 print "Compiling in", build_dir, "with MySQL support."
844 env.ParseConfig(mysql_config_libs)
845 env.ParseConfig(mysql_config_include)
846
847 # Save sticky option settings back to current options file
848 sticky_opts.Save(current_opts_file, env)
849
850 if env['USE_SSE2']:
851 env.Append(CCFLAGS='-msse2')
852
853 # The src/SConscript file sets up the build rules in 'env' according
854 # to the configured options. It returns a list of environments,
855 # one for each variant build (debug, opt, etc.)
856 envList = SConscript('src/SConscript', build_dir = build_path,
857 exports = 'env')
858
859 # Set up the regression tests for each build.
860 for e in envList:
861 SConscript('tests/SConscript',
862 build_dir = joinpath(build_path, 'tests', e.Label),
863 exports = { 'env' : e }, duplicate = False)
864
865Help(help_text)
866
867
868###################################################
869#
870# Let SCons do its thing. At this point SCons will use the defined
871# build environments to build the requested targets.
872#
873###################################################
874
|