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