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
66# Python library imports
67import sys
68import os
69
70# Check for recent-enough Python and SCons versions. If your system's
71# default installation of Python is not recent enough, you can use a
72# non-default installation of the Python interpreter by either (1)
73# rearranging your PATH so that scons finds the non-default 'python'
74# first or (2) explicitly invoking an alternative interpreter on the
75# scons script, e.g., "/usr/local/bin/python2.4 `which scons` [args]".
76EnsurePythonVersion(2,4)
77
78# Ironically, SCons 0.96 dies if you give EnsureSconsVersion a
79# 3-element version number.
80min_scons_version = (0,96,91)
81try:
82 EnsureSConsVersion(*min_scons_version)
83except:
84 print "Error checking current SCons version."
85 print "SCons", ".".join(map(str,min_scons_version)), "or greater required."
86 Exit(2)
87
88
89# The absolute path to the current directory (where this file lives).
90ROOT = Dir('.').abspath
91
92# Paths to the M5 and external source trees.
93SRCDIR = os.path.join(ROOT, 'src')
94
95# tell python where to find m5 python code
96sys.path.append(os.path.join(ROOT, 'src/python'))
97
98###################################################
99#
100# Figure out which configurations to set up based on the path(s) of
101# the target(s).
102#
103###################################################
104
105# Find default configuration & binary.
106Default(os.environ.get('M5_DEFAULT_BINARY', 'build/ALPHA_SE/m5.debug'))
107
108# Ask SCons which directory it was invoked from.
109launch_dir = GetLaunchDir()
110
111# Make targets relative to invocation directory
112abs_targets = map(lambda x: os.path.normpath(os.path.join(launch_dir, str(x))),
113 BUILD_TARGETS)
114
115# helper function: find last occurrence of element in list
116def rfind(l, elt, offs = -1):
117 for i in range(len(l)+offs, 0, -1):
118 if l[i] == elt:
119 return i
120 raise ValueError, "element not found"
121
122# helper function: compare dotted version numbers.
123# E.g., compare_version('1.3.25', '1.4.1')
124# returns -1, 0, 1 if v1 is <, ==, > v2
125def compare_versions(v1, v2):
126 # Convert dotted strings to lists
127 v1 = map(int, v1.split('.'))
128 v2 = map(int, v2.split('.'))
129 # Compare corresponding elements of lists
130 for n1,n2 in zip(v1, v2):
131 if n1 < n2: return -1
132 if n1 > n2: return 1
133 # all corresponding values are equal... see if one has extra values
134 if len(v1) < len(v2): return -1
135 if len(v1) > len(v2): return 1
136 return 0
137
138# Each target must have 'build' in the interior of the path; the
139# directory below this will determine the build parameters. For
140# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
141# recognize that ALPHA_SE specifies the configuration because it
142# follow 'build' in the bulid path.
143
144# Generate a list of the unique build roots and configs that the
145# collected targets reference.
146build_paths = []
147build_root = None
148for t in abs_targets:
149 path_dirs = t.split('/')
150 try:
151 build_top = rfind(path_dirs, 'build', -2)
152 except:
153 print "Error: no non-leaf 'build' dir found on target path", t
154 Exit(1)
155 this_build_root = os.path.join('/',*path_dirs[:build_top+1])
156 if not build_root:
157 build_root = this_build_root
158 else:
159 if this_build_root != build_root:
160 print "Error: build targets not under same build root\n"\
161 " %s\n %s" % (build_root, this_build_root)
162 Exit(1)
163 build_path = os.path.join('/',*path_dirs[:build_top+2])
164 if build_path not in build_paths:
165 build_paths.append(build_path)
166
167###################################################
168#
169# Set up the default build environment. This environment is copied
170# and modified according to each selected configuration.
171#
172###################################################
173
174env = Environment(ENV = os.environ, # inherit user's environment vars
175 ROOT = ROOT,
176 SRCDIR = SRCDIR)
177
| 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
66# Python library imports
67import sys
68import os
69
70# Check for recent-enough Python and SCons versions. If your system's
71# default installation of Python is not recent enough, you can use a
72# non-default installation of the Python interpreter by either (1)
73# rearranging your PATH so that scons finds the non-default 'python'
74# first or (2) explicitly invoking an alternative interpreter on the
75# scons script, e.g., "/usr/local/bin/python2.4 `which scons` [args]".
76EnsurePythonVersion(2,4)
77
78# Ironically, SCons 0.96 dies if you give EnsureSconsVersion a
79# 3-element version number.
80min_scons_version = (0,96,91)
81try:
82 EnsureSConsVersion(*min_scons_version)
83except:
84 print "Error checking current SCons version."
85 print "SCons", ".".join(map(str,min_scons_version)), "or greater required."
86 Exit(2)
87
88
89# The absolute path to the current directory (where this file lives).
90ROOT = Dir('.').abspath
91
92# Paths to the M5 and external source trees.
93SRCDIR = os.path.join(ROOT, 'src')
94
95# tell python where to find m5 python code
96sys.path.append(os.path.join(ROOT, 'src/python'))
97
98###################################################
99#
100# Figure out which configurations to set up based on the path(s) of
101# the target(s).
102#
103###################################################
104
105# Find default configuration & binary.
106Default(os.environ.get('M5_DEFAULT_BINARY', 'build/ALPHA_SE/m5.debug'))
107
108# Ask SCons which directory it was invoked from.
109launch_dir = GetLaunchDir()
110
111# Make targets relative to invocation directory
112abs_targets = map(lambda x: os.path.normpath(os.path.join(launch_dir, str(x))),
113 BUILD_TARGETS)
114
115# helper function: find last occurrence of element in list
116def rfind(l, elt, offs = -1):
117 for i in range(len(l)+offs, 0, -1):
118 if l[i] == elt:
119 return i
120 raise ValueError, "element not found"
121
122# helper function: compare dotted version numbers.
123# E.g., compare_version('1.3.25', '1.4.1')
124# returns -1, 0, 1 if v1 is <, ==, > v2
125def compare_versions(v1, v2):
126 # Convert dotted strings to lists
127 v1 = map(int, v1.split('.'))
128 v2 = map(int, v2.split('.'))
129 # Compare corresponding elements of lists
130 for n1,n2 in zip(v1, v2):
131 if n1 < n2: return -1
132 if n1 > n2: return 1
133 # all corresponding values are equal... see if one has extra values
134 if len(v1) < len(v2): return -1
135 if len(v1) > len(v2): return 1
136 return 0
137
138# Each target must have 'build' in the interior of the path; the
139# directory below this will determine the build parameters. For
140# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
141# recognize that ALPHA_SE specifies the configuration because it
142# follow 'build' in the bulid path.
143
144# Generate a list of the unique build roots and configs that the
145# collected targets reference.
146build_paths = []
147build_root = None
148for t in abs_targets:
149 path_dirs = t.split('/')
150 try:
151 build_top = rfind(path_dirs, 'build', -2)
152 except:
153 print "Error: no non-leaf 'build' dir found on target path", t
154 Exit(1)
155 this_build_root = os.path.join('/',*path_dirs[:build_top+1])
156 if not build_root:
157 build_root = this_build_root
158 else:
159 if this_build_root != build_root:
160 print "Error: build targets not under same build root\n"\
161 " %s\n %s" % (build_root, this_build_root)
162 Exit(1)
163 build_path = os.path.join('/',*path_dirs[:build_top+2])
164 if build_path not in build_paths:
165 build_paths.append(build_path)
166
167###################################################
168#
169# Set up the default build environment. This environment is copied
170# and modified according to each selected configuration.
171#
172###################################################
173
174env = Environment(ENV = os.environ, # inherit user's environment vars
175 ROOT = ROOT,
176 SRCDIR = SRCDIR)
177
|
178env.SConsignFile(os.path.join(build_root,"sconsign"))
179
180# Default duplicate option is to use hard links, but this messes up
181# when you use emacs to edit a file in the target dir, as emacs moves
182# file to file~ then copies to file, breaking the link. Symbolic
183# (soft) links work better.
184env.SetOption('duplicate', 'soft-copy')
185
186# I waffle on this setting... it does avoid a few painful but
187# unnecessary builds, but it also seems to make trivial builds take
188# noticeably longer.
189if False:
190 env.TargetSignatures('content')
191
192# M5_PLY is used by isa_parser.py to find the PLY package.
193env.Append(ENV = { 'M5_PLY' : Dir('ext/ply') })
194
195# Set up default C++ compiler flags
196env.Append(CCFLAGS='-pipe')
197env.Append(CCFLAGS='-fno-strict-aliasing')
198env.Append(CCFLAGS=Split('-Wall -Wno-sign-compare -Werror -Wundef'))
199if sys.platform == 'cygwin':
200 # cygwin has some header file issues...
201 env.Append(CCFLAGS=Split("-Wno-uninitialized"))
202env.Append(CPPPATH=[Dir('ext/dnet')])
203
204# Check for SWIG
205if not env.has_key('SWIG'):
206 print 'Error: SWIG utility not found.'
207 print ' Please install (see http://www.swig.org) and retry.'
208 Exit(1)
209
210# Check for appropriate SWIG version
211swig_version = os.popen('swig -version').read().split()
212# First 3 words should be "SWIG Version x.y.z"
213if swig_version[0] != 'SWIG' or swig_version[1] != 'Version':
214 print 'Error determining SWIG version.'
215 Exit(1)
216
217min_swig_version = '1.3.28'
218if compare_versions(swig_version[2], min_swig_version) < 0:
219 print 'Error: SWIG version', min_swig_version, 'or newer required.'
220 print ' Installed version:', swig_version[2]
221 Exit(1)
222
223# Set up SWIG flags & scanner
224env.Append(SWIGFLAGS=Split('-c++ -python -modern $_CPPINCFLAGS'))
225
226import SCons.Scanner
227
228swig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
229
230swig_scanner = SCons.Scanner.ClassicCPP("SwigScan", ".i", "CPPPATH",
231 swig_inc_re)
232
233env.Append(SCANNERS = swig_scanner)
234
235# Platform-specific configuration. Note again that we assume that all
236# builds under a given build root run on the same host platform.
237conf = Configure(env,
238 conf_dir = os.path.join(build_root, '.scons_config'),
239 log_file = os.path.join(build_root, 'scons_config.log'))
240
241# Find Python include and library directories for embedding the
242# interpreter. For consistency, we will use the same Python
243# installation used to run scons (and thus this script). If you want
244# to link in an alternate version, see above for instructions on how
245# to invoke scons with a different copy of the Python interpreter.
246
247# Get brief Python version name (e.g., "python2.4") for locating
248# include & library files
249py_version_name = 'python' + sys.version[:3]
250
251# include path, e.g. /usr/local/include/python2.4
252py_header_path = os.path.join(sys.exec_prefix, 'include', py_version_name)
253env.Append(CPPPATH = py_header_path)
254# verify that it works
255if not conf.CheckHeader('Python.h', '<>'):
256 print "Error: can't find Python.h header in", py_header_path
257 Exit(1)
258
259# add library path too if it's not in the default place
260py_lib_path = None
261if sys.exec_prefix != '/usr':
262 py_lib_path = os.path.join(sys.exec_prefix, 'lib')
263elif sys.platform == 'cygwin':
264 # cygwin puts the .dll in /bin for some reason
265 py_lib_path = '/bin'
266if py_lib_path:
267 env.Append(LIBPATH = py_lib_path)
268 print 'Adding', py_lib_path, 'to LIBPATH for', py_version_name
269if not conf.CheckLib(py_version_name):
270 print "Error: can't find Python library", py_version_name
271 Exit(1)
272
273# On Solaris you need to use libsocket for socket ops
274if not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
275 if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
276 print "Can't find library with socket calls (e.g. accept())"
277 Exit(1)
278
279# Check for zlib. If the check passes, libz will be automatically
280# added to the LIBS environment variable.
281if not conf.CheckLibWithHeader('z', 'zlib.h', 'C++'):
282 print 'Error: did not find needed zlib compression library '\
283 'and/or zlib.h header file.'
284 print ' Please install zlib and try again.'
285 Exit(1)
286
287# Check for <fenv.h> (C99 FP environment control)
288have_fenv = conf.CheckHeader('fenv.h', '<>')
289if not have_fenv:
290 print "Warning: Header file <fenv.h> not found."
291 print " This host has no IEEE FP rounding mode control."
292
293# Check for mysql.
294mysql_config = WhereIs('mysql_config')
295have_mysql = mysql_config != None
296
297# Check MySQL version.
298if have_mysql:
299 mysql_version = os.popen(mysql_config + ' --version').read()
300 min_mysql_version = '4.1'
301 if compare_versions(mysql_version, min_mysql_version) < 0:
302 print 'Warning: MySQL', min_mysql_version, 'or newer required.'
303 print ' Version', mysql_version, 'detected.'
304 have_mysql = False
305
306# Set up mysql_config commands.
307if have_mysql:
308 mysql_config_include = mysql_config + ' --include'
309 if os.system(mysql_config_include + ' > /dev/null') != 0:
310 # older mysql_config versions don't support --include, use
311 # --cflags instead
312 mysql_config_include = mysql_config + ' --cflags | sed s/\\\'//g'
313 # This seems to work in all versions
314 mysql_config_libs = mysql_config + ' --libs'
315
316env = conf.Finish()
317
318# Define the universe of supported ISAs
319env['ALL_ISA_LIST'] = ['alpha', 'sparc', 'mips']
320
321# Define the universe of supported CPU models
322env['ALL_CPU_LIST'] = ['AtomicSimpleCPU', 'TimingSimpleCPU',
323 'O3CPU', 'OzoneCPU']
324
325if os.path.isdir(os.path.join(SRCDIR, 'src/encumbered/cpu/full')):
326 env['ALL_CPU_LIST'] += ['FullCPU']
327
328# Sticky options get saved in the options file so they persist from
329# one invocation to the next (unless overridden, in which case the new
330# value becomes sticky).
331sticky_opts = Options(args=ARGUMENTS)
332sticky_opts.AddOptions(
333 EnumOption('TARGET_ISA', 'Target ISA', 'alpha', env['ALL_ISA_LIST']),
334 BoolOption('FULL_SYSTEM', 'Full-system support', False),
335 # There's a bug in scons 0.96.1 that causes ListOptions with list
336 # values (more than one value) not to be able to be restored from
337 # a saved option file. If this causes trouble then upgrade to
338 # scons 0.96.90 or later.
339 ListOption('CPU_MODELS', 'CPU models', 'AtomicSimpleCPU,TimingSimpleCPU',
340 env['ALL_CPU_LIST']),
341 BoolOption('ALPHA_TLASER',
342 'Model Alpha TurboLaser platform (vs. Tsunami)', False),
343 BoolOption('NO_FAST_ALLOC', 'Disable fast object allocator', False),
344 BoolOption('EFENCE', 'Link with Electric Fence malloc debugger',
345 False),
346 BoolOption('SS_COMPATIBLE_FP',
347 'Make floating-point results compatible with SimpleScalar',
348 False),
349 BoolOption('USE_SSE2',
350 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
351 False),
352 BoolOption('USE_MYSQL', 'Use MySQL for stats output', have_mysql),
353 BoolOption('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
354 BoolOption('USE_CHECKER', 'Use checker for detailed CPU models', False),
355 ('CC', 'C compiler', os.environ.get('CC', env['CC'])),
356 ('CXX', 'C++ compiler', os.environ.get('CXX', env['CXX'])),
357 BoolOption('BATCH', 'Use batch pool for build and tests', False),
358 ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
359 ('PYTHONHOME',
360 'Override the default PYTHONHOME for this system (use with caution)',
361 '%s:%s' % (sys.prefix, sys.exec_prefix))
362 )
363
364# Non-sticky options only apply to the current build.
365nonsticky_opts = Options(args=ARGUMENTS)
366nonsticky_opts.AddOptions(
367 BoolOption('update_ref', 'Update test reference outputs', False)
368 )
369
370# These options get exported to #defines in config/*.hh (see src/SConscript).
371env.ExportOptions = ['FULL_SYSTEM', 'ALPHA_TLASER', 'USE_FENV', \
372 'USE_MYSQL', 'NO_FAST_ALLOC', 'SS_COMPATIBLE_FP', \
373 'USE_CHECKER', 'PYTHONHOME', 'TARGET_ISA']
374
375# Define a handy 'no-op' action
376def no_action(target, source, env):
377 return 0
378
379env.NoAction = Action(no_action, None)
380
381###################################################
382#
383# Define a SCons builder for configuration flag headers.
384#
385###################################################
386
387# This function generates a config header file that #defines the
388# option symbol to the current option setting (0 or 1). The source
389# operands are the name of the option and a Value node containing the
390# value of the option.
391def build_config_file(target, source, env):
392 (option, value) = [s.get_contents() for s in source]
393 f = file(str(target[0]), 'w')
394 print >> f, '#define', option, value
395 f.close()
396 return None
397
398# Generate the message to be printed when building the config file.
399def build_config_file_string(target, source, env):
400 (option, value) = [s.get_contents() for s in source]
401 return "Defining %s as %s in %s." % (option, value, target[0])
402
403# Combine the two functions into a scons Action object.
404config_action = Action(build_config_file, build_config_file_string)
405
406# The emitter munges the source & target node lists to reflect what
407# we're really doing.
408def config_emitter(target, source, env):
409 # extract option name from Builder arg
410 option = str(target[0])
411 # True target is config header file
412 target = os.path.join('config', option.lower() + '.hh')
413 val = env[option]
414 if isinstance(val, bool):
415 # Force value to 0/1
416 val = int(val)
417 elif isinstance(val, str):
418 val = '"' + val + '"'
419
420 # Sources are option name & value (packaged in SCons Value nodes)
421 return ([target], [Value(option), Value(val)])
422
423config_builder = Builder(emitter = config_emitter, action = config_action)
424
425env.Append(BUILDERS = { 'ConfigFile' : config_builder })
426
427###################################################
428#
429# Define a SCons builder for copying files. This is used by the
430# Python zipfile code in src/python/SConscript, but is placed up here
431# since it's potentially more generally applicable.
432#
433###################################################
434
435copy_builder = Builder(action = Copy("$TARGET", "$SOURCE"))
436
437env.Append(BUILDERS = { 'CopyFile' : copy_builder })
438
439###################################################
440#
441# Define a simple SCons builder to concatenate files.
442#
443# Used to append the Python zip archive to the executable.
444#
445###################################################
446
447concat_builder = Builder(action = Action(['cat $SOURCES > $TARGET',
448 'chmod +x $TARGET']))
449
450env.Append(BUILDERS = { 'Concat' : concat_builder })
451
452
453# base help text
454help_text = '''
455Usage: scons [scons options] [build options] [target(s)]
456
457'''
458
459# libelf build is shared across all configs in the build root.
460env.SConscript('ext/libelf/SConscript',
461 build_dir = os.path.join(build_root, 'libelf'),
462 exports = 'env')
463
464###################################################
465#
466# This function is used to set up a directory with switching headers
467#
468###################################################
469
470def make_switching_dir(dirname, switch_headers, env):
471 # Generate the header. target[0] is the full path of the output
472 # header to generate. 'source' is a dummy variable, since we get the
473 # list of ISAs from env['ALL_ISA_LIST'].
474 def gen_switch_hdr(target, source, env):
475 fname = str(target[0])
476 basename = os.path.basename(fname)
477 f = open(fname, 'w')
478 f.write('#include "arch/isa_specific.hh"\n')
479 cond = '#if'
480 for isa in env['ALL_ISA_LIST']:
481 f.write('%s THE_ISA == %s_ISA\n#include "%s/%s/%s"\n'
482 % (cond, isa.upper(), dirname, isa, basename))
483 cond = '#elif'
484 f.write('#else\n#error "THE_ISA not set"\n#endif\n')
485 f.close()
486 return 0
487
488 # String to print when generating header
489 def gen_switch_hdr_string(target, source, env):
490 return "Generating switch header " + str(target[0])
491
492 # Build SCons Action object. 'varlist' specifies env vars that this
493 # action depends on; when env['ALL_ISA_LIST'] changes these actions
494 # should get re-executed.
495 switch_hdr_action = Action(gen_switch_hdr, gen_switch_hdr_string,
496 varlist=['ALL_ISA_LIST'])
497
498 # Instantiate actions for each header
499 for hdr in switch_headers:
500 env.Command(hdr, [], switch_hdr_action)
501
502env.make_switching_dir = make_switching_dir
503
504###################################################
505#
506# Define build environments for selected configurations.
507#
508###################################################
509
510# rename base env
511base_env = env
512
513for build_path in build_paths:
514 print "Building in", build_path
515 # build_dir is the tail component of build path, and is used to
516 # determine the build parameters (e.g., 'ALPHA_SE')
517 (build_root, build_dir) = os.path.split(build_path)
518 # Make a copy of the build-root environment to use for this config.
519 env = base_env.Copy()
520
521 # Set env options according to the build directory config.
522 sticky_opts.files = []
523 # Options for $BUILD_ROOT/$BUILD_DIR are stored in
524 # $BUILD_ROOT/options/$BUILD_DIR so you can nuke
525 # $BUILD_ROOT/$BUILD_DIR without losing your options settings.
526 current_opts_file = os.path.join(build_root, 'options', build_dir)
527 if os.path.isfile(current_opts_file):
528 sticky_opts.files.append(current_opts_file)
529 print "Using saved options file %s" % current_opts_file
530 else:
531 # Build dir-specific options file doesn't exist.
532
533 # Make sure the directory is there so we can create it later
534 opt_dir = os.path.dirname(current_opts_file)
535 if not os.path.isdir(opt_dir):
536 os.mkdir(opt_dir)
537
538 # Get default build options from source tree. Options are
539 # normally determined by name of $BUILD_DIR, but can be
540 # overriden by 'default=' arg on command line.
541 default_opts_file = os.path.join('build_opts',
542 ARGUMENTS.get('default', build_dir))
543 if os.path.isfile(default_opts_file):
544 sticky_opts.files.append(default_opts_file)
545 print "Options file %s not found,\n using defaults in %s" \
546 % (current_opts_file, default_opts_file)
547 else:
548 print "Error: cannot find options file %s or %s" \
549 % (current_opts_file, default_opts_file)
550 Exit(1)
551
552 # Apply current option settings to env
553 sticky_opts.Update(env)
554 nonsticky_opts.Update(env)
555
556 help_text += "Sticky options for %s:\n" % build_dir \
557 + sticky_opts.GenerateHelpText(env) \
558 + "\nNon-sticky options for %s:\n" % build_dir \
559 + nonsticky_opts.GenerateHelpText(env)
560
561 # Process option settings.
562
563 if not have_fenv and env['USE_FENV']:
564 print "Warning: <fenv.h> not available; " \
565 "forcing USE_FENV to False in", build_dir + "."
566 env['USE_FENV'] = False
567
568 if not env['USE_FENV']:
569 print "Warning: No IEEE FP rounding mode control in", build_dir + "."
570 print " FP results may deviate slightly from other platforms."
571
572 if env['EFENCE']:
573 env.Append(LIBS=['efence'])
574
575 if env['USE_MYSQL']:
576 if not have_mysql:
577 print "Warning: MySQL not available; " \
578 "forcing USE_MYSQL to False in", build_dir + "."
579 env['USE_MYSQL'] = False
580 else:
581 print "Compiling in", build_dir, "with MySQL support."
582 env.ParseConfig(mysql_config_libs)
583 env.ParseConfig(mysql_config_include)
584
585 # Save sticky option settings back to current options file
586 sticky_opts.Save(current_opts_file, env)
587
588 # Do this after we save setting back, or else we'll tack on an
589 # extra 'qdo' every time we run scons.
590 if env['BATCH']:
591 env['CC'] = env['BATCH_CMD'] + ' ' + env['CC']
592 env['CXX'] = env['BATCH_CMD'] + ' ' + env['CXX']
593
594 if env['USE_SSE2']:
595 env.Append(CCFLAGS='-msse2')
596
597 # The src/SConscript file sets up the build rules in 'env' according
598 # to the configured options. It returns a list of environments,
599 # one for each variant build (debug, opt, etc.)
600 envList = SConscript('src/SConscript', build_dir = build_path,
601 exports = 'env')
602
603 # Set up the regression tests for each build.
604 for e in envList:
605 SConscript('tests/SConscript',
606 build_dir = os.path.join(build_path, 'tests', e.Label),
607 exports = { 'env' : e }, duplicate = False)
608
609Help(help_text)
610
611
612###################################################
613#
614# Let SCons do its thing. At this point SCons will use the defined
615# build environments to build the requested targets.
616#
617###################################################
618
| 186env.SConsignFile(os.path.join(build_root,"sconsign"))
187
188# Default duplicate option is to use hard links, but this messes up
189# when you use emacs to edit a file in the target dir, as emacs moves
190# file to file~ then copies to file, breaking the link. Symbolic
191# (soft) links work better.
192env.SetOption('duplicate', 'soft-copy')
193
194# I waffle on this setting... it does avoid a few painful but
195# unnecessary builds, but it also seems to make trivial builds take
196# noticeably longer.
197if False:
198 env.TargetSignatures('content')
199
200# M5_PLY is used by isa_parser.py to find the PLY package.
201env.Append(ENV = { 'M5_PLY' : Dir('ext/ply') })
202
203# Set up default C++ compiler flags
204env.Append(CCFLAGS='-pipe')
205env.Append(CCFLAGS='-fno-strict-aliasing')
206env.Append(CCFLAGS=Split('-Wall -Wno-sign-compare -Werror -Wundef'))
207if sys.platform == 'cygwin':
208 # cygwin has some header file issues...
209 env.Append(CCFLAGS=Split("-Wno-uninitialized"))
210env.Append(CPPPATH=[Dir('ext/dnet')])
211
212# Check for SWIG
213if not env.has_key('SWIG'):
214 print 'Error: SWIG utility not found.'
215 print ' Please install (see http://www.swig.org) and retry.'
216 Exit(1)
217
218# Check for appropriate SWIG version
219swig_version = os.popen('swig -version').read().split()
220# First 3 words should be "SWIG Version x.y.z"
221if swig_version[0] != 'SWIG' or swig_version[1] != 'Version':
222 print 'Error determining SWIG version.'
223 Exit(1)
224
225min_swig_version = '1.3.28'
226if compare_versions(swig_version[2], min_swig_version) < 0:
227 print 'Error: SWIG version', min_swig_version, 'or newer required.'
228 print ' Installed version:', swig_version[2]
229 Exit(1)
230
231# Set up SWIG flags & scanner
232env.Append(SWIGFLAGS=Split('-c++ -python -modern $_CPPINCFLAGS'))
233
234import SCons.Scanner
235
236swig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
237
238swig_scanner = SCons.Scanner.ClassicCPP("SwigScan", ".i", "CPPPATH",
239 swig_inc_re)
240
241env.Append(SCANNERS = swig_scanner)
242
243# Platform-specific configuration. Note again that we assume that all
244# builds under a given build root run on the same host platform.
245conf = Configure(env,
246 conf_dir = os.path.join(build_root, '.scons_config'),
247 log_file = os.path.join(build_root, 'scons_config.log'))
248
249# Find Python include and library directories for embedding the
250# interpreter. For consistency, we will use the same Python
251# installation used to run scons (and thus this script). If you want
252# to link in an alternate version, see above for instructions on how
253# to invoke scons with a different copy of the Python interpreter.
254
255# Get brief Python version name (e.g., "python2.4") for locating
256# include & library files
257py_version_name = 'python' + sys.version[:3]
258
259# include path, e.g. /usr/local/include/python2.4
260py_header_path = os.path.join(sys.exec_prefix, 'include', py_version_name)
261env.Append(CPPPATH = py_header_path)
262# verify that it works
263if not conf.CheckHeader('Python.h', '<>'):
264 print "Error: can't find Python.h header in", py_header_path
265 Exit(1)
266
267# add library path too if it's not in the default place
268py_lib_path = None
269if sys.exec_prefix != '/usr':
270 py_lib_path = os.path.join(sys.exec_prefix, 'lib')
271elif sys.platform == 'cygwin':
272 # cygwin puts the .dll in /bin for some reason
273 py_lib_path = '/bin'
274if py_lib_path:
275 env.Append(LIBPATH = py_lib_path)
276 print 'Adding', py_lib_path, 'to LIBPATH for', py_version_name
277if not conf.CheckLib(py_version_name):
278 print "Error: can't find Python library", py_version_name
279 Exit(1)
280
281# On Solaris you need to use libsocket for socket ops
282if not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
283 if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
284 print "Can't find library with socket calls (e.g. accept())"
285 Exit(1)
286
287# Check for zlib. If the check passes, libz will be automatically
288# added to the LIBS environment variable.
289if not conf.CheckLibWithHeader('z', 'zlib.h', 'C++'):
290 print 'Error: did not find needed zlib compression library '\
291 'and/or zlib.h header file.'
292 print ' Please install zlib and try again.'
293 Exit(1)
294
295# Check for <fenv.h> (C99 FP environment control)
296have_fenv = conf.CheckHeader('fenv.h', '<>')
297if not have_fenv:
298 print "Warning: Header file <fenv.h> not found."
299 print " This host has no IEEE FP rounding mode control."
300
301# Check for mysql.
302mysql_config = WhereIs('mysql_config')
303have_mysql = mysql_config != None
304
305# Check MySQL version.
306if have_mysql:
307 mysql_version = os.popen(mysql_config + ' --version').read()
308 min_mysql_version = '4.1'
309 if compare_versions(mysql_version, min_mysql_version) < 0:
310 print 'Warning: MySQL', min_mysql_version, 'or newer required.'
311 print ' Version', mysql_version, 'detected.'
312 have_mysql = False
313
314# Set up mysql_config commands.
315if have_mysql:
316 mysql_config_include = mysql_config + ' --include'
317 if os.system(mysql_config_include + ' > /dev/null') != 0:
318 # older mysql_config versions don't support --include, use
319 # --cflags instead
320 mysql_config_include = mysql_config + ' --cflags | sed s/\\\'//g'
321 # This seems to work in all versions
322 mysql_config_libs = mysql_config + ' --libs'
323
324env = conf.Finish()
325
326# Define the universe of supported ISAs
327env['ALL_ISA_LIST'] = ['alpha', 'sparc', 'mips']
328
329# Define the universe of supported CPU models
330env['ALL_CPU_LIST'] = ['AtomicSimpleCPU', 'TimingSimpleCPU',
331 'O3CPU', 'OzoneCPU']
332
333if os.path.isdir(os.path.join(SRCDIR, 'src/encumbered/cpu/full')):
334 env['ALL_CPU_LIST'] += ['FullCPU']
335
336# Sticky options get saved in the options file so they persist from
337# one invocation to the next (unless overridden, in which case the new
338# value becomes sticky).
339sticky_opts = Options(args=ARGUMENTS)
340sticky_opts.AddOptions(
341 EnumOption('TARGET_ISA', 'Target ISA', 'alpha', env['ALL_ISA_LIST']),
342 BoolOption('FULL_SYSTEM', 'Full-system support', False),
343 # There's a bug in scons 0.96.1 that causes ListOptions with list
344 # values (more than one value) not to be able to be restored from
345 # a saved option file. If this causes trouble then upgrade to
346 # scons 0.96.90 or later.
347 ListOption('CPU_MODELS', 'CPU models', 'AtomicSimpleCPU,TimingSimpleCPU',
348 env['ALL_CPU_LIST']),
349 BoolOption('ALPHA_TLASER',
350 'Model Alpha TurboLaser platform (vs. Tsunami)', False),
351 BoolOption('NO_FAST_ALLOC', 'Disable fast object allocator', False),
352 BoolOption('EFENCE', 'Link with Electric Fence malloc debugger',
353 False),
354 BoolOption('SS_COMPATIBLE_FP',
355 'Make floating-point results compatible with SimpleScalar',
356 False),
357 BoolOption('USE_SSE2',
358 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
359 False),
360 BoolOption('USE_MYSQL', 'Use MySQL for stats output', have_mysql),
361 BoolOption('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
362 BoolOption('USE_CHECKER', 'Use checker for detailed CPU models', False),
363 ('CC', 'C compiler', os.environ.get('CC', env['CC'])),
364 ('CXX', 'C++ compiler', os.environ.get('CXX', env['CXX'])),
365 BoolOption('BATCH', 'Use batch pool for build and tests', False),
366 ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
367 ('PYTHONHOME',
368 'Override the default PYTHONHOME for this system (use with caution)',
369 '%s:%s' % (sys.prefix, sys.exec_prefix))
370 )
371
372# Non-sticky options only apply to the current build.
373nonsticky_opts = Options(args=ARGUMENTS)
374nonsticky_opts.AddOptions(
375 BoolOption('update_ref', 'Update test reference outputs', False)
376 )
377
378# These options get exported to #defines in config/*.hh (see src/SConscript).
379env.ExportOptions = ['FULL_SYSTEM', 'ALPHA_TLASER', 'USE_FENV', \
380 'USE_MYSQL', 'NO_FAST_ALLOC', 'SS_COMPATIBLE_FP', \
381 'USE_CHECKER', 'PYTHONHOME', 'TARGET_ISA']
382
383# Define a handy 'no-op' action
384def no_action(target, source, env):
385 return 0
386
387env.NoAction = Action(no_action, None)
388
389###################################################
390#
391# Define a SCons builder for configuration flag headers.
392#
393###################################################
394
395# This function generates a config header file that #defines the
396# option symbol to the current option setting (0 or 1). The source
397# operands are the name of the option and a Value node containing the
398# value of the option.
399def build_config_file(target, source, env):
400 (option, value) = [s.get_contents() for s in source]
401 f = file(str(target[0]), 'w')
402 print >> f, '#define', option, value
403 f.close()
404 return None
405
406# Generate the message to be printed when building the config file.
407def build_config_file_string(target, source, env):
408 (option, value) = [s.get_contents() for s in source]
409 return "Defining %s as %s in %s." % (option, value, target[0])
410
411# Combine the two functions into a scons Action object.
412config_action = Action(build_config_file, build_config_file_string)
413
414# The emitter munges the source & target node lists to reflect what
415# we're really doing.
416def config_emitter(target, source, env):
417 # extract option name from Builder arg
418 option = str(target[0])
419 # True target is config header file
420 target = os.path.join('config', option.lower() + '.hh')
421 val = env[option]
422 if isinstance(val, bool):
423 # Force value to 0/1
424 val = int(val)
425 elif isinstance(val, str):
426 val = '"' + val + '"'
427
428 # Sources are option name & value (packaged in SCons Value nodes)
429 return ([target], [Value(option), Value(val)])
430
431config_builder = Builder(emitter = config_emitter, action = config_action)
432
433env.Append(BUILDERS = { 'ConfigFile' : config_builder })
434
435###################################################
436#
437# Define a SCons builder for copying files. This is used by the
438# Python zipfile code in src/python/SConscript, but is placed up here
439# since it's potentially more generally applicable.
440#
441###################################################
442
443copy_builder = Builder(action = Copy("$TARGET", "$SOURCE"))
444
445env.Append(BUILDERS = { 'CopyFile' : copy_builder })
446
447###################################################
448#
449# Define a simple SCons builder to concatenate files.
450#
451# Used to append the Python zip archive to the executable.
452#
453###################################################
454
455concat_builder = Builder(action = Action(['cat $SOURCES > $TARGET',
456 'chmod +x $TARGET']))
457
458env.Append(BUILDERS = { 'Concat' : concat_builder })
459
460
461# base help text
462help_text = '''
463Usage: scons [scons options] [build options] [target(s)]
464
465'''
466
467# libelf build is shared across all configs in the build root.
468env.SConscript('ext/libelf/SConscript',
469 build_dir = os.path.join(build_root, 'libelf'),
470 exports = 'env')
471
472###################################################
473#
474# This function is used to set up a directory with switching headers
475#
476###################################################
477
478def make_switching_dir(dirname, switch_headers, env):
479 # Generate the header. target[0] is the full path of the output
480 # header to generate. 'source' is a dummy variable, since we get the
481 # list of ISAs from env['ALL_ISA_LIST'].
482 def gen_switch_hdr(target, source, env):
483 fname = str(target[0])
484 basename = os.path.basename(fname)
485 f = open(fname, 'w')
486 f.write('#include "arch/isa_specific.hh"\n')
487 cond = '#if'
488 for isa in env['ALL_ISA_LIST']:
489 f.write('%s THE_ISA == %s_ISA\n#include "%s/%s/%s"\n'
490 % (cond, isa.upper(), dirname, isa, basename))
491 cond = '#elif'
492 f.write('#else\n#error "THE_ISA not set"\n#endif\n')
493 f.close()
494 return 0
495
496 # String to print when generating header
497 def gen_switch_hdr_string(target, source, env):
498 return "Generating switch header " + str(target[0])
499
500 # Build SCons Action object. 'varlist' specifies env vars that this
501 # action depends on; when env['ALL_ISA_LIST'] changes these actions
502 # should get re-executed.
503 switch_hdr_action = Action(gen_switch_hdr, gen_switch_hdr_string,
504 varlist=['ALL_ISA_LIST'])
505
506 # Instantiate actions for each header
507 for hdr in switch_headers:
508 env.Command(hdr, [], switch_hdr_action)
509
510env.make_switching_dir = make_switching_dir
511
512###################################################
513#
514# Define build environments for selected configurations.
515#
516###################################################
517
518# rename base env
519base_env = env
520
521for build_path in build_paths:
522 print "Building in", build_path
523 # build_dir is the tail component of build path, and is used to
524 # determine the build parameters (e.g., 'ALPHA_SE')
525 (build_root, build_dir) = os.path.split(build_path)
526 # Make a copy of the build-root environment to use for this config.
527 env = base_env.Copy()
528
529 # Set env options according to the build directory config.
530 sticky_opts.files = []
531 # Options for $BUILD_ROOT/$BUILD_DIR are stored in
532 # $BUILD_ROOT/options/$BUILD_DIR so you can nuke
533 # $BUILD_ROOT/$BUILD_DIR without losing your options settings.
534 current_opts_file = os.path.join(build_root, 'options', build_dir)
535 if os.path.isfile(current_opts_file):
536 sticky_opts.files.append(current_opts_file)
537 print "Using saved options file %s" % current_opts_file
538 else:
539 # Build dir-specific options file doesn't exist.
540
541 # Make sure the directory is there so we can create it later
542 opt_dir = os.path.dirname(current_opts_file)
543 if not os.path.isdir(opt_dir):
544 os.mkdir(opt_dir)
545
546 # Get default build options from source tree. Options are
547 # normally determined by name of $BUILD_DIR, but can be
548 # overriden by 'default=' arg on command line.
549 default_opts_file = os.path.join('build_opts',
550 ARGUMENTS.get('default', build_dir))
551 if os.path.isfile(default_opts_file):
552 sticky_opts.files.append(default_opts_file)
553 print "Options file %s not found,\n using defaults in %s" \
554 % (current_opts_file, default_opts_file)
555 else:
556 print "Error: cannot find options file %s or %s" \
557 % (current_opts_file, default_opts_file)
558 Exit(1)
559
560 # Apply current option settings to env
561 sticky_opts.Update(env)
562 nonsticky_opts.Update(env)
563
564 help_text += "Sticky options for %s:\n" % build_dir \
565 + sticky_opts.GenerateHelpText(env) \
566 + "\nNon-sticky options for %s:\n" % build_dir \
567 + nonsticky_opts.GenerateHelpText(env)
568
569 # Process option settings.
570
571 if not have_fenv and env['USE_FENV']:
572 print "Warning: <fenv.h> not available; " \
573 "forcing USE_FENV to False in", build_dir + "."
574 env['USE_FENV'] = False
575
576 if not env['USE_FENV']:
577 print "Warning: No IEEE FP rounding mode control in", build_dir + "."
578 print " FP results may deviate slightly from other platforms."
579
580 if env['EFENCE']:
581 env.Append(LIBS=['efence'])
582
583 if env['USE_MYSQL']:
584 if not have_mysql:
585 print "Warning: MySQL not available; " \
586 "forcing USE_MYSQL to False in", build_dir + "."
587 env['USE_MYSQL'] = False
588 else:
589 print "Compiling in", build_dir, "with MySQL support."
590 env.ParseConfig(mysql_config_libs)
591 env.ParseConfig(mysql_config_include)
592
593 # Save sticky option settings back to current options file
594 sticky_opts.Save(current_opts_file, env)
595
596 # Do this after we save setting back, or else we'll tack on an
597 # extra 'qdo' every time we run scons.
598 if env['BATCH']:
599 env['CC'] = env['BATCH_CMD'] + ' ' + env['CC']
600 env['CXX'] = env['BATCH_CMD'] + ' ' + env['CXX']
601
602 if env['USE_SSE2']:
603 env.Append(CCFLAGS='-msse2')
604
605 # The src/SConscript file sets up the build rules in 'env' according
606 # to the configured options. It returns a list of environments,
607 # one for each variant build (debug, opt, etc.)
608 envList = SConscript('src/SConscript', build_dir = build_path,
609 exports = 'env')
610
611 # Set up the regression tests for each build.
612 for e in envList:
613 SConscript('tests/SConscript',
614 build_dir = os.path.join(build_path, 'tests', e.Label),
615 exports = { 'env' : e }, duplicate = False)
616
617Help(help_text)
618
619
620###################################################
621#
622# Let SCons do its thing. At this point SCons will use the defined
623# build environments to build the requested targets.
624#
625###################################################
626
|