3 # Copyright (c) 2009 The Hewlett-Packard Development Company
4 # Copyright (c) 2004-2005 The Regents of The University of Michigan
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.
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.
30 # Authors: Steve Reinhardt
33 ###################################################
35 # SCons top-level build description (SConstruct) file.
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).
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.
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
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
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
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
66 ###################################################
68 # Check for recent-enough Python and SCons versions.
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)
78 For more details, see:
79 http://m5sim.org/wiki/index.php/Compiling_M5
83 # We ensure the python version early because we have stuff that
86 EnsurePythonVersion(2, 4)
89 You can use a non-default installation of the Python interpreter by
90 either (1) rearranging your PATH so that scons finds the non-default
91 'python' first or (2) explicitly invoking an alternative interpreter
94 For more details, see:
95 http://m5sim.org/wiki/index.php/Using_a_non-default_Python_installation
104 from os
import mkdir
, environ
105 from os
.path
import abspath
, basename
, dirname
, expanduser
, normpath
106 from os
.path
import exists
, isdir
, isfile
107 from os
.path
import join
as joinpath
, split
as splitpath
112 def read_command(cmd
, **kwargs
):
113 """run the command cmd, read the results and return them
114 this is sorta like `cmd` in shell"""
115 from subprocess
import Popen
, PIPE
, STDOUT
117 if isinstance(cmd
, str):
120 no_exception
= 'exception' in kwargs
121 exception
= kwargs
.pop('exception', None)
123 kwargs
.setdefault('shell', False)
124 kwargs
.setdefault('stdout', PIPE
)
125 kwargs
.setdefault('stderr', STDOUT
)
126 kwargs
.setdefault('close_fds', True)
128 subp
= Popen(cmd
, **kwargs
)
134 return subp
.communicate()[0]
136 # helper function: compare arrays or strings of version numbers.
137 # E.g., compare_version((1,3,25), (1,4,1)')
138 # returns -1, 0, 1 if v1 is <, ==, > v2
139 def compare_versions(v1
, v2
):
140 def make_version_list(v
):
141 if isinstance(v
, (list,tuple)):
143 elif isinstance(v
, str):
144 return map(lambda x
: int(re
.match('\d+', x
).group()), v
.split('.'))
148 v1
= make_version_list(v1
)
149 v2
= make_version_list(v2
)
150 # Compare corresponding elements of lists
151 for n1
,n2
in zip(v1
, v2
):
152 if n1
< n2
: return -1
154 # all corresponding values are equal... see if one has extra values
155 if len(v1
) < len(v2
): return -1
156 if len(v1
) > len(v2
): return 1
159 ########################################################################
161 # Set up the base build environment.
163 ########################################################################
164 use_vars
= set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'PATH', 'RANLIB' ])
167 for key
,val
in os
.environ
.iteritems():
168 if key
in use_vars
or key
.startswith("M5"):
171 env
= Environment(ENV
=use_env
)
172 env
.root
= Dir(".") # The current directory (where this file lives).
173 env
.srcdir
= Dir("src") # The source directory
175 ########################################################################
179 # If the M5 directory is a mercurial repository, we should do some
182 ########################################################################
184 hgdir
= env
.root
.Dir(".hg")
186 mercurial_style_message
= """
187 You're missing the M5 style hook.
188 Please install the hook so we can ensure that all code fits a common style.
190 All you'd need to do is add the following lines to your repository .hg/hgrc
191 or your personal .hgrc
195 style = %s/util/style.py
198 pretxncommit.style = python:style.check_whitespace
201 mercurial_bin_not_found
= """
202 Mercurial binary cannot be found, unfortunately this means that we
203 cannot easily determine the version of M5 that you are running and
204 this makes error messages more difficult to collect. Please consider
205 installing mercurial if you choose to post an error message
208 mercurial_lib_not_found
= """
209 Mercurial libraries cannot be found, ignoring style hook
210 If you are actually a M5 developer, please fix this and
211 run the style hook. It is important.
215 # 1) Grab repository revision if we know it.
216 cmd
= "hg id -n -i -t -b"
218 hg_info
= read_command(cmd
, cwd
=env
.root
.abspath
).strip()
221 print mercurial_bin_not_found
223 env
['HG_INFO'] = hg_info
225 # 2) Ensure that the style hook is in place.
228 if ARGUMENTS
.get('IGNORE_STYLE') != 'True':
229 from mercurial
import ui
232 print mercurial_lib_not_found
235 ui
.readconfig(hgdir
.File('hgrc').abspath
)
236 style_hook
= ui
.config('hooks', 'pretxncommit.style', None)
239 print mercurial_style_message
242 print ".hg directory not found"
244 ###################################################
246 # Figure out which configurations to set up based on the path(s) of
249 ###################################################
251 # Find default configuration & binary.
252 Default(environ
.get('M5_DEFAULT_BINARY', 'build/ALPHA_SE/m5.debug'))
254 # helper function: find last occurrence of element in list
255 def rfind(l
, elt
, offs
= -1):
256 for i
in range(len(l
)+offs
, 0, -1):
259 raise ValueError, "element not found"
261 # Each target must have 'build' in the interior of the path; the
262 # directory below this will determine the build parameters. For
263 # example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
264 # recognize that ALPHA_SE specifies the configuration because it
265 # follow 'build' in the bulid path.
267 # Generate absolute paths to targets so we can see where the build dir is
268 if COMMAND_LINE_TARGETS
:
269 # Ask SCons which directory it was invoked from
270 launch_dir
= GetLaunchDir()
271 # Make targets relative to invocation directory
272 abs_targets
= [ normpath(joinpath(launch_dir
, str(x
))) for x
in \
273 COMMAND_LINE_TARGETS
]
275 # Default targets are relative to root of tree
276 abs_targets
= [ normpath(joinpath(ROOT
, str(x
))) for x
in \
280 # Generate a list of the unique build roots and configs that the
281 # collected targets reference.
284 for t
in abs_targets
:
285 path_dirs
= t
.split('/')
287 build_top
= rfind(path_dirs
, 'build', -2)
289 print "Error: no non-leaf 'build' dir found on target path", t
291 this_build_root
= joinpath('/',*path_dirs
[:build_top
+1])
293 build_root
= this_build_root
295 if this_build_root
!= build_root
:
296 print "Error: build targets not under same build root\n"\
297 " %s\n %s" % (build_root
, this_build_root
)
299 variant_path
= joinpath('/',*path_dirs
[:build_top
+2])
300 if variant_path
not in variant_paths
:
301 variant_paths
.append(variant_path
)
303 # Make sure build_root exists (might not if this is the first build there)
304 if not isdir(build_root
):
309 env
.SConsignFile(joinpath(build_root
, "sconsign"))
311 # Default duplicate option is to use hard links, but this messes up
312 # when you use emacs to edit a file in the target dir, as emacs moves
313 # file to file~ then copies to file, breaking the link. Symbolic
314 # (soft) links work better.
315 env
.SetOption('duplicate', 'soft-copy')
318 # Set up global sticky variables... these are common to an entire build
319 # tree (not specific to a particular build like ALPHA_SE)
322 # Variable validators & converters for global sticky variables
323 def PathListMakeAbsolute(val
):
326 f
= lambda p
: abspath(expanduser(p
))
327 return ':'.join(map(f
, val
.split(':')))
329 def PathListAllExist(key
, val
, env
):
332 paths
= val
.split(':')
335 raise SCons
.Errors
.UserError("Path does not exist: '%s'" % path
)
337 global_sticky_vars_file
= joinpath(build_root
, 'variables.global')
339 global_sticky_vars
= Variables(global_sticky_vars_file
, args
=ARGUMENTS
)
341 global_sticky_vars
.AddVariables(
342 ('CC', 'C compiler', environ
.get('CC', env
['CC'])),
343 ('CXX', 'C++ compiler', environ
.get('CXX', env
['CXX'])),
344 ('BATCH', 'Use batch pool for build and tests', False),
345 ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
346 ('EXTRAS', 'Add Extra directories to the compilation', '',
347 PathListAllExist
, PathListMakeAbsolute
)
352 Usage: scons [scons options] [build options] [target(s)]
354 Global sticky options:
357 help_text
+= global_sticky_vars
.GenerateHelpText(env
)
359 # Update env with values from ARGUMENTS & file global_sticky_vars_file
360 global_sticky_vars
.Update(env
)
362 # Save sticky variable settings back to current variables file
363 global_sticky_vars
.Save(global_sticky_vars_file
, env
)
365 # Parse EXTRAS variable to build list of all directories where we're
366 # look for sources etc. This list is exported as base_dir_list.
367 base_dir
= env
.srcdir
.abspath
369 extras_dir_list
= env
['EXTRAS'].split(':')
374 Export('extras_dir_list')
376 # M5_PLY is used by isa_parser.py to find the PLY package.
377 env
.Append(ENV
= { 'M5_PLY' : str(Dir('ext/ply')) })
379 CXX_version
= read_command([env
['CXX'],'--version'], exception
=False)
380 CXX_V
= read_command([env
['CXX'],'-V'], exception
=False)
382 env
['GCC'] = CXX_version
and CXX_version
.find('g++') >= 0
383 env
['SUNCC'] = CXX_V
and CXX_V
.find('Sun C++') >= 0
384 env
['ICC'] = CXX_V
and CXX_V
.find('Intel') >= 0
385 if env
['GCC'] + env
['SUNCC'] + env
['ICC'] > 1:
386 print 'Error: How can we have two at the same time?'
389 # Set up default C++ compiler flags
391 env
.Append(CCFLAGS
='-pipe')
392 env
.Append(CCFLAGS
='-fno-strict-aliasing')
393 env
.Append(CCFLAGS
=Split('-Wall -Wno-sign-compare -Werror -Wundef'))
394 env
.Append(CXXFLAGS
='-Wno-deprecated')
396 pass #Fix me... add warning flags once we clean up icc warnings
398 env
.Append(CCFLAGS
='-Qoption ccfe')
399 env
.Append(CCFLAGS
='-features=gcc')
400 env
.Append(CCFLAGS
='-features=extensions')
401 env
.Append(CCFLAGS
='-library=stlport4')
402 env
.Append(CCFLAGS
='-xar')
403 #env.Append(CCFLAGS='-instances=semiexplicit')
405 print 'Error: Don\'t know what compiler options to use for your compiler.'
406 print ' Please fix SConstruct and src/SConscript and try again.'
409 # Do this after we save setting back, or else we'll tack on an
410 # extra 'qdo' every time we run scons.
412 env
['CC'] = env
['BATCH_CMD'] + ' ' + env
['CC']
413 env
['CXX'] = env
['BATCH_CMD'] + ' ' + env
['CXX']
414 env
['AS'] = env
['BATCH_CMD'] + ' ' + env
['AS']
415 env
['AR'] = env
['BATCH_CMD'] + ' ' + env
['AR']
416 env
['RANLIB'] = env
['BATCH_CMD'] + ' ' + env
['RANLIB']
418 if sys
.platform
== 'cygwin':
419 # cygwin has some header file issues...
420 env
.Append(CCFLAGS
=Split("-Wno-uninitialized"))
421 env
.Append(CPPPATH
=[Dir('ext/dnet')])
424 if not env
.has_key('SWIG'):
425 print 'Error: SWIG utility not found.'
426 print ' Please install (see http://www.swig.org) and retry.'
429 # Check for appropriate SWIG version
430 swig_version
= read_command(('swig', '-version'), exception
='').split()
431 # First 3 words should be "SWIG Version x.y.z"
432 if len(swig_version
) < 3 or \
433 swig_version
[0] != 'SWIG' or swig_version
[1] != 'Version':
434 print 'Error determining SWIG version.'
437 min_swig_version
= '1.3.28'
438 if compare_versions(swig_version
[2], min_swig_version
) < 0:
439 print 'Error: SWIG version', min_swig_version
, 'or newer required.'
440 print ' Installed version:', swig_version
[2]
443 # Set up SWIG flags & scanner
444 swig_flags
=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
445 env
.Append(SWIGFLAGS
=swig_flags
)
447 # filter out all existing swig scanners, they mess up the dependency
448 # stuff for some reason
450 for scanner
in env
['SCANNERS']:
451 skeys
= scanner
.skeys
455 if isinstance(skeys
, (list, tuple)) and '.i' in skeys
:
458 scanners
.append(scanner
)
460 # add the new swig scanner that we like better
461 from SCons
.Scanner
import ClassicCPP
as CPPScanner
462 swig_inc_re
= '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
463 scanners
.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re
))
465 # replace the scanners list that has what we want
466 env
['SCANNERS'] = scanners
468 # Add a custom Check function to the Configure context so that we can
469 # figure out if the compiler adds leading underscores to global
470 # variables. This is needed for the autogenerated asm files that we
471 # use for embedding the python code.
472 def CheckLeading(context
):
473 context
.Message("Checking for leading underscore in global variables...")
474 # 1) Define a global variable called x from asm so the C compiler
475 # won't change the symbol at all.
476 # 2) Declare that variable.
477 # 3) Use the variable
479 # If the compiler prepends an underscore, this will successfully
480 # link because the external symbol 'x' will be called '_x' which
481 # was defined by the asm statement. If the compiler does not
482 # prepend an underscore, this will not successfully link because
483 # '_x' will have been defined by assembly, while the C portion of
484 # the code will be trying to use 'x'
485 ret
= context
.TryLink('''
486 asm(".globl _x; _x: .byte 0");
488 int main() { return x; }
490 context
.env
.Append(LEADING_UNDERSCORE
=ret
)
494 # Platform-specific configuration. Note again that we assume that all
495 # builds under a given build root run on the same host platform.
496 conf
= Configure(env
,
497 conf_dir
= joinpath(build_root
, '.scons_config'),
498 log_file
= joinpath(build_root
, 'scons_config.log'),
499 custom_tests
= { 'CheckLeading' : CheckLeading
})
501 # Check for leading underscores. Don't really need to worry either
502 # way so don't need to check the return code.
505 # Check if we should compile a 64 bit binary on Mac OS X/Darwin
508 uname
= platform
.uname()
509 if uname
[0] == 'Darwin' and compare_versions(uname
[2], '9.0.0') >= 0:
510 if int(read_command('sysctl -n hw.cpu64bit_capable')[0]):
511 env
.Append(CCFLAGS
='-arch x86_64')
512 env
.Append(CFLAGS
='-arch x86_64')
513 env
.Append(LINKFLAGS
='-arch x86_64')
514 env
.Append(ASFLAGS
='-arch x86_64')
518 # Recent versions of scons substitute a "Null" object for Configure()
519 # when configuration isn't necessary, e.g., if the "--help" option is
520 # present. Unfortuantely this Null object always returns false,
521 # breaking all our configuration checks. We replace it with our own
522 # more optimistic null object that returns True instead.
524 def NullCheck(*args
, **kwargs
):
528 def __init__(self
, env
):
532 def __getattr__(self
, mname
):
537 # Find Python include and library directories for embedding the
538 # interpreter. For consistency, we will use the same Python
539 # installation used to run scons (and thus this script). If you want
540 # to link in an alternate version, see above for instructions on how
541 # to invoke scons with a different copy of the Python interpreter.
542 from distutils
import sysconfig
544 py_getvar
= sysconfig
.get_config_var
546 py_version
= 'python' + py_getvar('VERSION')
548 py_general_include
= sysconfig
.get_python_inc()
549 py_platform_include
= sysconfig
.get_python_inc(plat_specific
=True)
550 py_includes
= [ py_general_include
]
551 if py_platform_include
!= py_general_include
:
552 py_includes
.append(py_platform_include
)
555 # add the prefix/lib/pythonX.Y/config dir, but only if there is no
556 # shared library in prefix/lib/.
557 if not py_getvar('Py_ENABLE_SHARED'):
558 py_lib_path
.append('-L' + py_getvar('LIBPL'))
561 for lib
in py_getvar('LIBS').split() + py_getvar('SYSLIBS').split():
562 if lib
not in py_libs
:
564 py_libs
.append('-l' + py_version
)
566 env
.Append(CPPPATH
=py_includes
)
567 env
.Append(LIBPATH
=py_lib_path
)
568 #env.Append(LIBS=py_libs)
570 # verify that this stuff works
571 if not conf
.CheckHeader('Python.h', '<>'):
572 print "Error: can't find Python.h header in", py_includes
576 assert lib
.startswith('-l')
578 if not conf
.CheckLib(lib
):
579 print "Error: can't find library %s required by python" % lib
582 # On Solaris you need to use libsocket for socket ops
583 if not conf
.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
584 if not conf
.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
585 print "Can't find library with socket calls (e.g. accept())"
588 # Check for zlib. If the check passes, libz will be automatically
589 # added to the LIBS environment variable.
590 if not conf
.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
591 print 'Error: did not find needed zlib compression library '\
592 'and/or zlib.h header file.'
593 print ' Please install zlib and try again.'
596 # Check for <fenv.h> (C99 FP environment control)
597 have_fenv
= conf
.CheckHeader('fenv.h', '<>')
599 print "Warning: Header file <fenv.h> not found."
600 print " This host has no IEEE FP rounding mode control."
602 ######################################################################
606 mysql_config
= WhereIs('mysql_config')
607 have_mysql
= bool(mysql_config
)
609 # Check MySQL version.
611 mysql_version
= read_command(mysql_config
+ ' --version')
612 min_mysql_version
= '4.1'
613 if compare_versions(mysql_version
, min_mysql_version
) < 0:
614 print 'Warning: MySQL', min_mysql_version
, 'or newer required.'
615 print ' Version', mysql_version
, 'detected.'
618 # Set up mysql_config commands.
620 mysql_config_include
= mysql_config
+ ' --include'
621 if os
.system(mysql_config_include
+ ' > /dev/null') != 0:
622 # older mysql_config versions don't support --include, use
624 mysql_config_include
= mysql_config
+ ' --cflags | sed s/\\\'//g'
625 # This seems to work in all versions
626 mysql_config_libs
= mysql_config
+ ' --libs'
628 ######################################################################
630 # Finish the configuration
634 ######################################################################
636 # Collect all non-global variables
641 # Define the universe of supported ISAs
643 Export('all_isa_list')
645 # Define the universe of supported CPU models
648 Export('all_cpu_list', 'default_cpus')
650 # Sticky variables get saved in the variables file so they persist from
651 # one invocation to the next (unless overridden, in which case the new
652 # value becomes sticky).
653 sticky_vars
= Variables(args
=ARGUMENTS
)
654 Export('sticky_vars')
656 # Non-sticky variables only apply to the current build.
657 nonsticky_vars
= Variables(args
=ARGUMENTS
)
658 Export('nonsticky_vars')
660 # Walk the tree and execute all SConsopts scripts that wil add to the
662 for bdir
in [ base_dir
] + extras_dir_list
:
663 for root
, dirs
, files
in os
.walk(bdir
):
664 if 'SConsopts' in files
:
665 print "Reading", joinpath(root
, 'SConsopts')
666 SConscript(joinpath(root
, 'SConsopts'))
672 sticky_vars
.AddVariables(
673 EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list
),
674 BoolVariable('FULL_SYSTEM', 'Full-system support', False),
675 ListVariable('CPU_MODELS', 'CPU models', default_cpus
, all_cpu_list
),
676 BoolVariable('NO_FAST_ALLOC', 'Disable fast object allocator', False),
677 BoolVariable('FAST_ALLOC_DEBUG', 'Enable fast object allocator debugging',
679 BoolVariable('FAST_ALLOC_STATS', 'Enable fast object allocator statistics',
681 BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
683 BoolVariable('SS_COMPATIBLE_FP',
684 'Make floating-point results compatible with SimpleScalar',
686 BoolVariable('USE_SSE2',
687 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
689 BoolVariable('USE_MYSQL', 'Use MySQL for stats output', have_mysql
),
690 BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv
),
691 BoolVariable('USE_CHECKER', 'Use checker for detailed CPU models', False),
692 BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False),
695 nonsticky_vars
.AddVariables(
696 BoolVariable('update_ref', 'Update test reference outputs', False)
699 # These variables get exported to #defines in config/*.hh (see src/SConscript).
700 env
.ExportVariables
= ['FULL_SYSTEM', 'ALPHA_TLASER', 'USE_FENV', \
701 'USE_MYSQL', 'NO_FAST_ALLOC', 'FAST_ALLOC_DEBUG', \
702 'FAST_ALLOC_STATS', 'SS_COMPATIBLE_FP', \
703 'USE_CHECKER', 'TARGET_ISA', 'CP_ANNOTATE']
705 ###################################################
707 # Define a SCons builder for configuration flag headers.
709 ###################################################
711 # This function generates a config header file that #defines the
712 # variable symbol to the current variable setting (0 or 1). The source
713 # operands are the name of the variable and a Value node containing the
714 # value of the variable.
715 def build_config_file(target
, source
, env
):
716 (variable
, value
) = [s
.get_contents() for s
in source
]
717 f
= file(str(target
[0]), 'w')
718 print >> f
, '#define', variable
, value
722 # Generate the message to be printed when building the config file.
723 def build_config_file_string(target
, source
, env
):
724 (variable
, value
) = [s
.get_contents() for s
in source
]
725 return "Defining %s as %s in %s." % (variable
, value
, target
[0])
727 # Combine the two functions into a scons Action object.
728 config_action
= Action(build_config_file
, build_config_file_string
)
730 # The emitter munges the source & target node lists to reflect what
731 # we're really doing.
732 def config_emitter(target
, source
, env
):
733 # extract variable name from Builder arg
734 variable
= str(target
[0])
735 # True target is config header file
736 target
= joinpath('config', variable
.lower() + '.hh')
738 if isinstance(val
, bool):
741 elif isinstance(val
, str):
742 val
= '"' + val
+ '"'
744 # Sources are variable name & value (packaged in SCons Value nodes)
745 return ([target
], [Value(variable
), Value(val
)])
747 config_builder
= Builder(emitter
= config_emitter
, action
= config_action
)
749 env
.Append(BUILDERS
= { 'ConfigFile' : config_builder
})
751 # libelf build is shared across all configs in the build root.
752 env
.SConscript('ext/libelf/SConscript',
753 variant_dir
= joinpath(build_root
, 'libelf'))
755 # gzstream build is shared across all configs in the build root.
756 env
.SConscript('ext/gzstream/SConscript',
757 variant_dir
= joinpath(build_root
, 'gzstream'))
759 ###################################################
761 # This function is used to set up a directory with switching headers
763 ###################################################
765 env
['ALL_ISA_LIST'] = all_isa_list
766 def make_switching_dir(dname
, switch_headers
, env
):
767 # Generate the header. target[0] is the full path of the output
768 # header to generate. 'source' is a dummy variable, since we get the
769 # list of ISAs from env['ALL_ISA_LIST'].
770 def gen_switch_hdr(target
, source
, env
):
771 fname
= str(target
[0])
772 bname
= basename(fname
)
774 f
.write('#include "arch/isa_specific.hh"\n')
776 for isa
in all_isa_list
:
777 f
.write('%s THE_ISA == %s_ISA\n#include "%s/%s/%s"\n'
778 % (cond
, isa
.upper(), dname
, isa
, bname
))
780 f
.write('#else\n#error "THE_ISA not set"\n#endif\n')
784 # String to print when generating header
785 def gen_switch_hdr_string(target
, source
, env
):
786 return "Generating switch header " + str(target
[0])
788 # Build SCons Action object. 'varlist' specifies env vars that this
789 # action depends on; when env['ALL_ISA_LIST'] changes these actions
790 # should get re-executed.
791 switch_hdr_action
= Action(gen_switch_hdr
, gen_switch_hdr_string
,
792 varlist
=['ALL_ISA_LIST'])
794 # Instantiate actions for each header
795 for hdr
in switch_headers
:
796 env
.Command(hdr
, [], switch_hdr_action
)
797 Export('make_switching_dir')
799 ###################################################
801 # Define build environments for selected configurations.
803 ###################################################
808 for variant_path
in variant_paths
:
809 print "Building in", variant_path
811 # Make a copy of the build-root environment to use for this config.
812 env
= base_env
.Clone()
813 env
['BUILDDIR'] = variant_path
815 # variant_dir is the tail component of build path, and is used to
816 # determine the build parameters (e.g., 'ALPHA_SE')
817 (build_root
, variant_dir
) = splitpath(variant_path
)
819 # Set env variables according to the build directory config.
820 sticky_vars
.files
= []
821 # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
822 # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
823 # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
824 current_vars_file
= joinpath(build_root
, 'variables', variant_dir
)
825 if isfile(current_vars_file
):
826 sticky_vars
.files
.append(current_vars_file
)
827 print "Using saved variables file %s" % current_vars_file
829 # Build dir-specific variables file doesn't exist.
831 # Make sure the directory is there so we can create it later
832 opt_dir
= dirname(current_vars_file
)
833 if not isdir(opt_dir
):
836 # Get default build variables from source tree. Variables are
837 # normally determined by name of $VARIANT_DIR, but can be
838 # overriden by 'default=' arg on command line.
839 default_vars_file
= joinpath('build_opts',
840 ARGUMENTS
.get('default', variant_dir
))
841 if isfile(default_vars_file
):
842 sticky_vars
.files
.append(default_vars_file
)
843 print "Variables file %s not found,\n using defaults in %s" \
844 % (current_vars_file
, default_vars_file
)
846 print "Error: cannot find variables file %s or %s" \
847 % (current_vars_file
, default_vars_file
)
850 # Apply current variable settings to env
851 sticky_vars
.Update(env
)
852 nonsticky_vars
.Update(env
)
854 help_text
+= "\nSticky variables for %s:\n" % variant_dir \
855 + sticky_vars
.GenerateHelpText(env
) \
856 + "\nNon-sticky variables for %s:\n" % variant_dir \
857 + nonsticky_vars
.GenerateHelpText(env
)
859 # Process variable settings.
861 if not have_fenv
and env
['USE_FENV']:
862 print "Warning: <fenv.h> not available; " \
863 "forcing USE_FENV to False in", variant_dir
+ "."
864 env
['USE_FENV'] = False
866 if not env
['USE_FENV']:
867 print "Warning: No IEEE FP rounding mode control in", variant_dir
+ "."
868 print " FP results may deviate slightly from other platforms."
871 env
.Append(LIBS
=['efence'])
875 print "Warning: MySQL not available; " \
876 "forcing USE_MYSQL to False in", variant_dir
+ "."
877 env
['USE_MYSQL'] = False
879 print "Compiling in", variant_dir
, "with MySQL support."
880 env
.ParseConfig(mysql_config_libs
)
881 env
.ParseConfig(mysql_config_include
)
883 # Save sticky variable settings back to current variables file
884 sticky_vars
.Save(current_vars_file
, env
)
887 env
.Append(CCFLAGS
='-msse2')
889 # The src/SConscript file sets up the build rules in 'env' according
890 # to the configured variables. It returns a list of environments,
891 # one for each variant build (debug, opt, etc.)
892 envList
= SConscript('src/SConscript', variant_dir
= variant_path
,
895 # Set up the regression tests for each build.
897 SConscript('tests/SConscript',
898 variant_dir
= joinpath(variant_path
, 'tests', e
.Label
),
899 exports
= { 'env' : e
}, duplicate
= False)