3 # Copyright (c) 2004-2005 The Regents of The University of Michigan
6 # Redistribution and use in source and binary forms, with or without
7 # modification, are permitted provided that the following conditions are
8 # met: redistributions of source code must retain the above copyright
9 # notice, this list of conditions and the following disclaimer;
10 # redistributions in binary form must reproduce the above copyright
11 # notice, this list of conditions and the following disclaimer in the
12 # documentation and/or other materials provided with the distribution;
13 # neither the name of the copyright holders nor the names of its
14 # contributors may be used to endorse or promote products derived from
15 # this software without specific prior written permission.
17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 # Authors: Steve Reinhardt
31 ###################################################
33 # SCons top-level build description (SConstruct) file.
35 # While in this directory ('m5'), just type 'scons' to build the default
36 # configuration (see below), or type 'scons build/<CONFIG>/<binary>'
37 # to build some other configuration (e.g., 'build/ALPHA_FS/m5.opt' for
38 # the optimized full-system version).
40 # You can build M5 in a different directory as long as there is a
41 # 'build/<CONFIG>' somewhere along the target path. The build system
42 # expects that all configs under the same build directory are being
43 # built for the same host system.
47 # The following two commands are equivalent. The '-u' option tells
48 # scons to search up the directory tree for this SConstruct file.
49 # % cd <path-to-src>/m5 ; scons build/ALPHA_FS/m5.debug
50 # % cd <path-to-src>/m5/build/ALPHA_FS; scons -u m5.debug
52 # The following two commands are equivalent and demonstrate building
53 # in a directory outside of the source tree. The '-C' option tells
54 # scons to chdir to the specified directory to find this SConstruct
56 # % cd <path-to-src>/m5 ; scons /local/foo/build/ALPHA_FS/m5.debug
57 # % cd /local/foo/build/ALPHA_FS; scons -C <path-to-src>/m5 m5.debug
59 # You can use 'scons -H' to print scons options. If you're in this
60 # 'm5' directory (or use -u or -C to tell scons where to find this
61 # file), you can use 'scons -h' to print all the M5-specific build
64 ###################################################
70 from os
.path
import isdir
, isfile
, join
as joinpath
74 # Check for recent-enough Python and SCons versions. If your system's
75 # default installation of Python is not recent enough, you can use a
76 # non-default installation of the Python interpreter by either (1)
77 # rearranging your PATH so that scons finds the non-default 'python'
78 # first or (2) explicitly invoking an alternative interpreter on the
79 # scons script, e.g., "/usr/local/bin/python2.4 `which scons` [args]".
80 EnsurePythonVersion(2,4)
82 # Import subprocess after we check the version since it doesn't exist in
86 # helper function: compare arrays or strings of version numbers.
87 # E.g., compare_version((1,3,25), (1,4,1)')
88 # returns -1, 0, 1 if v1 is <, ==, > v2
89 def compare_versions(v1
, v2
):
90 def make_version_list(v
):
91 if isinstance(v
, (list,tuple)):
93 elif isinstance(v
, str):
94 return map(int, v
.split('.'))
98 v1
= make_version_list(v1
)
99 v2
= make_version_list(v2
)
100 # Compare corresponding elements of lists
101 for n1
,n2
in zip(v1
, v2
):
102 if n1
< n2
: return -1
104 # all corresponding values are equal... see if one has extra values
105 if len(v1
) < len(v2
): return -1
106 if len(v1
) > len(v2
): return 1
109 # SCons version numbers need special processing because they can have
110 # charecters and an release date embedded in them. This function does
111 # the magic to extract them in a similar way to the SCons internal function
112 # function does and then checks that the current version is not contained in
113 # a list of version tuples (bad_ver_strs)
114 def CheckSCons(bad_ver_strs
):
116 num_parts
= v
.split(' ')[0].split('.')
117 major
= int(num_parts
[0])
118 minor
= int(re
.match('\d+', num_parts
[1]).group())
121 if len(num_parts
) > 2:
122 try: rev
= int(re
.match('\d+', num_parts
[2]).group())
124 rev_parts
= num_parts
[2].split('d')
125 if len(rev_parts
) > 1:
126 rdate
= int(re
.match('\d+', rev_parts
[1]).group())
128 return (major
, minor
, rev
, rdate
)
130 sc_ver
= scons_ver(SCons
.__version
__)
131 for bad_ver
in bad_ver_strs
:
132 bv
= (scons_ver(bad_ver
[0]), scons_ver(bad_ver
[1]))
133 if compare_versions(sc_ver
, bv
[0]) != -1 and\
134 compare_versions(sc_ver
, bv
[1]) != 1:
135 print "The version of SCons that you have installed: ", SCons
.__version
__
136 print "has a bug that prevents it from working correctly with M5."
137 print "Please install a version NOT contained within the following",
138 print "ranges (inclusive):"
139 for bad_ver
in bad_ver_strs
:
140 print " %s - %s" % bad_ver
144 # We need a version that is 0.96.91 or newer
145 ('0.0.0', '0.96.90'),
146 # This range has a bug with linking directories into the build dir
147 # that only have header files in them
148 ('0.97.0d20071212', '0.98.0')
152 # The absolute path to the current directory (where this file lives).
153 ROOT
= Dir('.').abspath
155 # Path to the M5 source tree.
156 SRCDIR
= joinpath(ROOT
, 'src')
158 # tell python where to find m5 python code
159 sys
.path
.append(joinpath(ROOT
, 'src/python'))
161 def check_style_hook(ui
):
162 ui
.readconfig(joinpath(ROOT
, '.hg', 'hgrc'))
163 style_hook
= ui
.config('hooks', 'pretxncommit.style', None)
167 You're missing the M5 style hook.
168 Please install the hook so we can ensure that all code fits a common style.
170 All you'd need to do is add the following lines to your repository .hg/hgrc
171 or your personal .hgrc
175 style = %s/util/style.py
178 pretxncommit.style = python:style.check_whitespace
182 if ARGUMENTS
.get('IGNORE_STYLE') != 'True' and isdir(joinpath(ROOT
, '.hg')):
184 from mercurial
import ui
185 check_style_hook(ui
.ui())
189 ###################################################
191 # Figure out which configurations to set up based on the path(s) of
194 ###################################################
196 # Find default configuration & binary.
197 Default(os
.environ
.get('M5_DEFAULT_BINARY', 'build/ALPHA_SE/m5.debug'))
199 # helper function: find last occurrence of element in list
200 def rfind(l
, elt
, offs
= -1):
201 for i
in range(len(l
)+offs
, 0, -1):
204 raise ValueError, "element not found"
206 # Each target must have 'build' in the interior of the path; the
207 # directory below this will determine the build parameters. For
208 # example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
209 # recognize that ALPHA_SE specifies the configuration because it
210 # follow 'build' in the bulid path.
212 # Generate absolute paths to targets so we can see where the build dir is
213 if COMMAND_LINE_TARGETS
:
214 # Ask SCons which directory it was invoked from
215 launch_dir
= GetLaunchDir()
216 # Make targets relative to invocation directory
217 abs_targets
= map(lambda x
: os
.path
.normpath(joinpath(launch_dir
, str(x
))),
218 COMMAND_LINE_TARGETS
)
220 # Default targets are relative to root of tree
221 abs_targets
= map(lambda x
: os
.path
.normpath(joinpath(ROOT
, str(x
))),
225 # Generate a list of the unique build roots and configs that the
226 # collected targets reference.
229 for t
in abs_targets
:
230 path_dirs
= t
.split('/')
232 build_top
= rfind(path_dirs
, 'build', -2)
234 print "Error: no non-leaf 'build' dir found on target path", t
236 this_build_root
= joinpath('/',*path_dirs
[:build_top
+1])
238 build_root
= this_build_root
240 if this_build_root
!= build_root
:
241 print "Error: build targets not under same build root\n"\
242 " %s\n %s" % (build_root
, this_build_root
)
244 build_path
= joinpath('/',*path_dirs
[:build_top
+2])
245 if build_path
not in build_paths
:
246 build_paths
.append(build_path
)
248 # Make sure build_root exists (might not if this is the first build there)
249 if not isdir(build_root
):
252 ###################################################
254 # Set up the default build environment. This environment is copied
255 # and modified according to each selected configuration.
257 ###################################################
259 env
= Environment(ENV
= os
.environ
, # inherit user's environment vars
265 env
.SConsignFile(joinpath(build_root
,"sconsign"))
267 # Default duplicate option is to use hard links, but this messes up
268 # when you use emacs to edit a file in the target dir, as emacs moves
269 # file to file~ then copies to file, breaking the link. Symbolic
270 # (soft) links work better.
271 env
.SetOption('duplicate', 'soft-copy')
273 # I waffle on this setting... it does avoid a few painful but
274 # unnecessary builds, but it also seems to make trivial builds take
277 env
.TargetSignatures('content')
280 # Set up global sticky options... these are common to an entire build
281 # tree (not specific to a particular build like ALPHA_SE)
284 # Option validators & converters for global sticky options
285 def PathListMakeAbsolute(val
):
288 f
= lambda p
: os
.path
.abspath(os
.path
.expanduser(p
))
289 return ':'.join(map(f
, val
.split(':')))
291 def PathListAllExist(key
, val
, env
):
294 paths
= val
.split(':')
297 raise SCons
.Errors
.UserError("Path does not exist: '%s'" % path
)
299 global_sticky_opts_file
= joinpath(build_root
, 'options.global')
301 global_sticky_opts
= Options(global_sticky_opts_file
, args
=ARGUMENTS
)
303 global_sticky_opts
.AddOptions(
304 ('CC', 'C compiler', os
.environ
.get('CC', env
['CC'])),
305 ('CXX', 'C++ compiler', os
.environ
.get('CXX', env
['CXX'])),
306 ('BATCH', 'Use batch pool for build and tests', False),
307 ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
308 ('EXTRAS', 'Add Extra directories to the compilation', '',
309 PathListAllExist
, PathListMakeAbsolute
)
315 Usage: scons [scons options] [build options] [target(s)]
319 help_text
+= "Global sticky options:\n" \
320 + global_sticky_opts
.GenerateHelpText(env
)
322 # Update env with values from ARGUMENTS & file global_sticky_opts_file
323 global_sticky_opts
.Update(env
)
325 # Save sticky option settings back to current options file
326 global_sticky_opts
.Save(global_sticky_opts_file
, env
)
328 # Parse EXTRAS option to build list of all directories where we're
329 # look for sources etc. This list is exported as base_dir_list.
330 base_dir_list
= [joinpath(ROOT
, 'src')]
332 base_dir_list
+= env
['EXTRAS'].split(':')
334 Export('base_dir_list')
336 # M5_PLY is used by isa_parser.py to find the PLY package.
337 env
.Append(ENV
= { 'M5_PLY' : str(Dir('ext/ply')) })
341 env
['GCC'] = subprocess
.Popen(env
['CXX'] + ' --version', shell
=True,
342 stdout
=subprocess
.PIPE
, stderr
=subprocess
.STDOUT
,
343 close_fds
=True).communicate()[0].find('GCC') >= 0
344 env
['SUNCC'] = subprocess
.Popen(env
['CXX'] + ' -V', shell
=True,
345 stdout
=subprocess
.PIPE
, stderr
=subprocess
.STDOUT
,
346 close_fds
=True).communicate()[0].find('Sun C++') >= 0
347 env
['ICC'] = subprocess
.Popen(env
['CXX'] + ' -V', shell
=True,
348 stdout
=subprocess
.PIPE
, stderr
=subprocess
.STDOUT
,
349 close_fds
=True).communicate()[0].find('Intel') >= 0
350 if env
['GCC'] + env
['SUNCC'] + env
['ICC'] > 1:
351 print 'Error: How can we have two at the same time?'
355 # Set up default C++ compiler flags
357 env
.Append(CCFLAGS
='-pipe')
358 env
.Append(CCFLAGS
='-fno-strict-aliasing')
359 env
.Append(CCFLAGS
=Split('-Wall -Wno-sign-compare -Werror -Wundef'))
361 pass #Fix me... add warning flags once we clean up icc warnings
363 env
.Append(CCFLAGS
='-Qoption ccfe')
364 env
.Append(CCFLAGS
='-features=gcc')
365 env
.Append(CCFLAGS
='-features=extensions')
366 env
.Append(CCFLAGS
='-library=stlport4')
367 env
.Append(CCFLAGS
='-xar')
368 # env.Append(CCFLAGS='-instances=semiexplicit')
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.'
374 # Do this after we save setting back, or else we'll tack on an
375 # extra 'qdo' every time we run scons.
377 env
['CC'] = env
['BATCH_CMD'] + ' ' + env
['CC']
378 env
['CXX'] = env
['BATCH_CMD'] + ' ' + env
['CXX']
380 if sys
.platform
== 'cygwin':
381 # cygwin has some header file issues...
382 env
.Append(CCFLAGS
=Split("-Wno-uninitialized"))
383 env
.Append(CPPPATH
=[Dir('ext/dnet')])
386 if not env
.has_key('SWIG'):
387 print 'Error: SWIG utility not found.'
388 print ' Please install (see http://www.swig.org) and retry.'
391 # Check for appropriate SWIG version
392 swig_version
= os
.popen('swig -version').read().split()
393 # First 3 words should be "SWIG Version x.y.z"
394 if len(swig_version
) < 3 or \
395 swig_version
[0] != 'SWIG' or swig_version
[1] != 'Version':
396 print 'Error determining SWIG version.'
399 min_swig_version
= '1.3.28'
400 if compare_versions(swig_version
[2], min_swig_version
) < 0:
401 print 'Error: SWIG version', min_swig_version
, 'or newer required.'
402 print ' Installed version:', swig_version
[2]
405 # Set up SWIG flags & scanner
406 swig_flags
=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
407 env
.Append(SWIGFLAGS
=swig_flags
)
409 # filter out all existing swig scanners, they mess up the dependency
410 # stuff for some reason
412 for scanner
in env
['SCANNERS']:
413 skeys
= scanner
.skeys
417 if isinstance(skeys
, (list, tuple)) and '.i' in skeys
:
420 scanners
.append(scanner
)
422 # add the new swig scanner that we like better
423 from SCons
.Scanner
import ClassicCPP
as CPPScanner
424 swig_inc_re
= '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
425 scanners
.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re
))
427 # replace the scanners list that has what we want
428 env
['SCANNERS'] = scanners
430 # Platform-specific configuration. Note again that we assume that all
431 # builds under a given build root run on the same host platform.
432 conf
= Configure(env
,
433 conf_dir
= joinpath(build_root
, '.scons_config'),
434 log_file
= joinpath(build_root
, 'scons_config.log'))
436 # Check if we should compile a 64 bit binary on Mac OS X/Darwin
439 uname
= platform
.uname()
440 if uname
[0] == 'Darwin' and compare_versions(uname
[2], '9.0.0') >= 0:
441 if int(subprocess
.Popen('sysctl -n hw.cpu64bit_capable', shell
=True,
442 stdout
=subprocess
.PIPE
, stderr
=subprocess
.STDOUT
,
443 close_fds
=True).communicate()[0][0]):
444 env
.Append(CCFLAGS
='-arch x86_64')
445 env
.Append(CFLAGS
='-arch x86_64')
446 env
.Append(LINKFLAGS
='-arch x86_64')
447 env
.Append(ASFLAGS
='-arch x86_64')
451 # Recent versions of scons substitute a "Null" object for Configure()
452 # when configuration isn't necessary, e.g., if the "--help" option is
453 # present. Unfortuantely this Null object always returns false,
454 # breaking all our configuration checks. We replace it with our own
455 # more optimistic null object that returns True instead.
457 def NullCheck(*args
, **kwargs
):
461 def __init__(self
, env
):
465 def __getattr__(self
, mname
):
470 # Find Python include and library directories for embedding the
471 # interpreter. For consistency, we will use the same Python
472 # installation used to run scons (and thus this script). If you want
473 # to link in an alternate version, see above for instructions on how
474 # to invoke scons with a different copy of the Python interpreter.
476 # Get brief Python version name (e.g., "python2.4") for locating
477 # include & library files
478 py_version_name
= 'python' + sys
.version
[:3]
480 # include path, e.g. /usr/local/include/python2.4
481 py_header_path
= joinpath(sys
.exec_prefix
, 'include', py_version_name
)
482 env
.Append(CPPPATH
= py_header_path
)
483 # verify that it works
484 if not conf
.CheckHeader('Python.h', '<>'):
485 print "Error: can't find Python.h header in", py_header_path
488 # add library path too if it's not in the default place
490 if sys
.exec_prefix
!= '/usr':
491 py_lib_path
= joinpath(sys
.exec_prefix
, 'lib')
492 elif sys
.platform
== 'cygwin':
493 # cygwin puts the .dll in /bin for some reason
496 env
.Append(LIBPATH
= py_lib_path
)
497 print 'Adding', py_lib_path
, 'to LIBPATH for', py_version_name
498 if not conf
.CheckLib(py_version_name
):
499 print "Error: can't find Python library", py_version_name
502 # On Solaris you need to use libsocket for socket ops
503 if not conf
.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
504 if not conf
.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
505 print "Can't find library with socket calls (e.g. accept())"
508 # Check for zlib. If the check passes, libz will be automatically
509 # added to the LIBS environment variable.
510 if not conf
.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
511 print 'Error: did not find needed zlib compression library '\
512 'and/or zlib.h header file.'
513 print ' Please install zlib and try again.'
516 # Check for <fenv.h> (C99 FP environment control)
517 have_fenv
= conf
.CheckHeader('fenv.h', '<>')
519 print "Warning: Header file <fenv.h> not found."
520 print " This host has no IEEE FP rounding mode control."
523 mysql_config
= WhereIs('mysql_config')
524 have_mysql
= mysql_config
!= None
526 # Check MySQL version.
528 mysql_version
= os
.popen(mysql_config
+ ' --version').read()
529 min_mysql_version
= '4.1'
530 if compare_versions(mysql_version
, min_mysql_version
) < 0:
531 print 'Warning: MySQL', min_mysql_version
, 'or newer required.'
532 print ' Version', mysql_version
, 'detected.'
535 # Set up mysql_config commands.
537 mysql_config_include
= mysql_config
+ ' --include'
538 if os
.system(mysql_config_include
+ ' > /dev/null') != 0:
539 # older mysql_config versions don't support --include, use
541 mysql_config_include
= mysql_config
+ ' --cflags | sed s/\\\'//g'
542 # This seems to work in all versions
543 mysql_config_libs
= mysql_config
+ ' --libs'
547 # Define the universe of supported ISAs
549 Export('all_isa_list')
551 # Define the universe of supported CPU models
554 Export('all_cpu_list', 'default_cpus')
556 # Sticky options get saved in the options file so they persist from
557 # one invocation to the next (unless overridden, in which case the new
558 # value becomes sticky).
559 sticky_opts
= Options(args
=ARGUMENTS
)
560 Export('sticky_opts')
562 # Non-sticky options only apply to the current build.
563 nonsticky_opts
= Options(args
=ARGUMENTS
)
564 Export('nonsticky_opts')
566 # Walk the tree and execute all SConsopts scripts that wil add to the
568 for base_dir
in base_dir_list
:
569 for root
, dirs
, files
in os
.walk(base_dir
):
570 if 'SConsopts' in files
:
571 print "Reading", joinpath(root
, 'SConsopts')
572 SConscript(joinpath(root
, 'SConsopts'))
578 sticky_opts
.AddOptions(
579 EnumOption('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list
),
580 BoolOption('FULL_SYSTEM', 'Full-system support', False),
581 # There's a bug in scons 0.96.1 that causes ListOptions with list
582 # values (more than one value) not to be able to be restored from
583 # a saved option file. If this causes trouble then upgrade to
584 # scons 0.96.90 or later.
585 ListOption('CPU_MODELS', 'CPU models', default_cpus
, all_cpu_list
),
586 BoolOption('NO_FAST_ALLOC', 'Disable fast object allocator', False),
587 BoolOption('FAST_ALLOC_DEBUG', 'Enable fast object allocator debugging',
589 BoolOption('FAST_ALLOC_STATS', 'Enable fast object allocator statistics',
591 BoolOption('EFENCE', 'Link with Electric Fence malloc debugger',
593 BoolOption('SS_COMPATIBLE_FP',
594 'Make floating-point results compatible with SimpleScalar',
596 BoolOption('USE_SSE2',
597 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
599 BoolOption('USE_MYSQL', 'Use MySQL for stats output', have_mysql
),
600 BoolOption('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv
),
601 BoolOption('USE_CHECKER', 'Use checker for detailed CPU models', False),
603 'Override the default PYTHONHOME for this system (use with caution)',
604 '%s:%s' % (sys
.prefix
, sys
.exec_prefix
)),
607 nonsticky_opts
.AddOptions(
608 BoolOption('update_ref', 'Update test reference outputs', False)
611 # These options get exported to #defines in config/*.hh (see src/SConscript).
612 env
.ExportOptions
= ['FULL_SYSTEM', 'ALPHA_TLASER', 'USE_FENV', \
613 'USE_MYSQL', 'NO_FAST_ALLOC', 'FAST_ALLOC_DEBUG', \
614 'FAST_ALLOC_STATS', 'SS_COMPATIBLE_FP', \
615 'USE_CHECKER', 'PYTHONHOME', 'TARGET_ISA']
617 # Define a handy 'no-op' action
618 def no_action(target
, source
, env
):
621 env
.NoAction
= Action(no_action
, None)
623 ###################################################
625 # Define a SCons builder for configuration flag headers.
627 ###################################################
629 # This function generates a config header file that #defines the
630 # option symbol to the current option setting (0 or 1). The source
631 # operands are the name of the option and a Value node containing the
632 # value of the option.
633 def build_config_file(target
, source
, env
):
634 (option
, value
) = [s
.get_contents() for s
in source
]
635 f
= file(str(target
[0]), 'w')
636 print >> f
, '#define', option
, value
640 # Generate the message to be printed when building the config file.
641 def build_config_file_string(target
, source
, env
):
642 (option
, value
) = [s
.get_contents() for s
in source
]
643 return "Defining %s as %s in %s." % (option
, value
, target
[0])
645 # Combine the two functions into a scons Action object.
646 config_action
= Action(build_config_file
, build_config_file_string
)
648 # The emitter munges the source & target node lists to reflect what
649 # we're really doing.
650 def config_emitter(target
, source
, env
):
651 # extract option name from Builder arg
652 option
= str(target
[0])
653 # True target is config header file
654 target
= joinpath('config', option
.lower() + '.hh')
656 if isinstance(val
, bool):
659 elif isinstance(val
, str):
660 val
= '"' + val
+ '"'
662 # Sources are option name & value (packaged in SCons Value nodes)
663 return ([target
], [Value(option
), Value(val
)])
665 config_builder
= Builder(emitter
= config_emitter
, action
= config_action
)
667 env
.Append(BUILDERS
= { 'ConfigFile' : config_builder
})
669 ###################################################
671 # Define a SCons builder for copying files. This is used by the
672 # Python zipfile code in src/python/SConscript, but is placed up here
673 # since it's potentially more generally applicable.
675 ###################################################
677 copy_builder
= Builder(action
= Copy("$TARGET", "$SOURCE"))
679 env
.Append(BUILDERS
= { 'CopyFile' : copy_builder
})
681 ###################################################
683 # Define a simple SCons builder to concatenate files.
685 # Used to append the Python zip archive to the executable.
687 ###################################################
689 concat_builder
= Builder(action
= Action(['cat $SOURCES > $TARGET',
690 'chmod +x $TARGET']))
692 env
.Append(BUILDERS
= { 'Concat' : concat_builder
})
695 # libelf build is shared across all configs in the build root.
696 env
.SConscript('ext/libelf/SConscript',
697 build_dir
= joinpath(build_root
, 'libelf'),
700 ###################################################
702 # This function is used to set up a directory with switching headers
704 ###################################################
706 env
['ALL_ISA_LIST'] = all_isa_list
707 def make_switching_dir(dirname
, switch_headers
, env
):
708 # Generate the header. target[0] is the full path of the output
709 # header to generate. 'source' is a dummy variable, since we get the
710 # list of ISAs from env['ALL_ISA_LIST'].
711 def gen_switch_hdr(target
, source
, env
):
712 fname
= str(target
[0])
713 basename
= os
.path
.basename(fname
)
715 f
.write('#include "arch/isa_specific.hh"\n')
717 for isa
in all_isa_list
:
718 f
.write('%s THE_ISA == %s_ISA\n#include "%s/%s/%s"\n'
719 % (cond
, isa
.upper(), dirname
, isa
, basename
))
721 f
.write('#else\n#error "THE_ISA not set"\n#endif\n')
725 # String to print when generating header
726 def gen_switch_hdr_string(target
, source
, env
):
727 return "Generating switch header " + str(target
[0])
729 # Build SCons Action object. 'varlist' specifies env vars that this
730 # action depends on; when env['ALL_ISA_LIST'] changes these actions
731 # should get re-executed.
732 switch_hdr_action
= Action(gen_switch_hdr
, gen_switch_hdr_string
,
733 varlist
=['ALL_ISA_LIST'])
735 # Instantiate actions for each header
736 for hdr
in switch_headers
:
737 env
.Command(hdr
, [], switch_hdr_action
)
738 Export('make_switching_dir')
740 ###################################################
742 # Define build environments for selected configurations.
744 ###################################################
749 for build_path
in build_paths
:
750 print "Building in", build_path
752 # Make a copy of the build-root environment to use for this config.
753 env
= base_env
.Copy()
754 env
['BUILDDIR'] = build_path
756 # build_dir is the tail component of build path, and is used to
757 # determine the build parameters (e.g., 'ALPHA_SE')
758 (build_root
, build_dir
) = os
.path
.split(build_path
)
760 # Set env options according to the build directory config.
761 sticky_opts
.files
= []
762 # Options for $BUILD_ROOT/$BUILD_DIR are stored in
763 # $BUILD_ROOT/options/$BUILD_DIR so you can nuke
764 # $BUILD_ROOT/$BUILD_DIR without losing your options settings.
765 current_opts_file
= joinpath(build_root
, 'options', build_dir
)
766 if isfile(current_opts_file
):
767 sticky_opts
.files
.append(current_opts_file
)
768 print "Using saved options file %s" % current_opts_file
770 # Build dir-specific options file doesn't exist.
772 # Make sure the directory is there so we can create it later
773 opt_dir
= os
.path
.dirname(current_opts_file
)
774 if not isdir(opt_dir
):
777 # Get default build options from source tree. Options are
778 # normally determined by name of $BUILD_DIR, but can be
779 # overriden by 'default=' arg on command line.
780 default_opts_file
= joinpath('build_opts',
781 ARGUMENTS
.get('default', build_dir
))
782 if isfile(default_opts_file
):
783 sticky_opts
.files
.append(default_opts_file
)
784 print "Options file %s not found,\n using defaults in %s" \
785 % (current_opts_file
, default_opts_file
)
787 print "Error: cannot find options file %s or %s" \
788 % (current_opts_file
, default_opts_file
)
791 # Apply current option settings to env
792 sticky_opts
.Update(env
)
793 nonsticky_opts
.Update(env
)
795 help_text
+= "\nSticky options for %s:\n" % build_dir \
796 + sticky_opts
.GenerateHelpText(env
) \
797 + "\nNon-sticky options for %s:\n" % build_dir \
798 + nonsticky_opts
.GenerateHelpText(env
)
800 # Process option settings.
802 if not have_fenv
and env
['USE_FENV']:
803 print "Warning: <fenv.h> not available; " \
804 "forcing USE_FENV to False in", build_dir
+ "."
805 env
['USE_FENV'] = False
807 if not env
['USE_FENV']:
808 print "Warning: No IEEE FP rounding mode control in", build_dir
+ "."
809 print " FP results may deviate slightly from other platforms."
812 env
.Append(LIBS
=['efence'])
816 print "Warning: MySQL not available; " \
817 "forcing USE_MYSQL to False in", build_dir
+ "."
818 env
['USE_MYSQL'] = False
820 print "Compiling in", build_dir
, "with MySQL support."
821 env
.ParseConfig(mysql_config_libs
)
822 env
.ParseConfig(mysql_config_include
)
824 # Save sticky option settings back to current options file
825 sticky_opts
.Save(current_opts_file
, env
)
828 env
.Append(CCFLAGS
='-msse2')
830 # The src/SConscript file sets up the build rules in 'env' according
831 # to the configured options. It returns a list of environments,
832 # one for each variant build (debug, opt, etc.)
833 envList
= SConscript('src/SConscript', build_dir
= build_path
,
836 # Set up the regression tests for each build.
838 SConscript('tests/SConscript',
839 build_dir
= joinpath(build_path
, 'tests', e
.Label
),
840 exports
= { 'env' : e
}, duplicate
= False)
845 ###################################################
847 # Let SCons do its thing. At this point SCons will use the defined
848 # build environments to build the requested targets.
850 ###################################################