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(lambda x
: int(re
.match('\d+', x
).group()), 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'),
149 # The absolute path to the current directory (where this file lives).
150 ROOT
= Dir('.').abspath
152 # Path to the M5 source tree.
153 SRCDIR
= joinpath(ROOT
, 'src')
155 # tell python where to find m5 python code
156 sys
.path
.append(joinpath(ROOT
, 'src/python'))
158 def check_style_hook(ui
):
159 ui
.readconfig(joinpath(ROOT
, '.hg', 'hgrc'))
160 style_hook
= ui
.config('hooks', 'pretxncommit.style', None)
164 You're missing the M5 style hook.
165 Please install the hook so we can ensure that all code fits a common style.
167 All you'd need to do is add the following lines to your repository .hg/hgrc
168 or your personal .hgrc
172 style = %s/util/style.py
175 pretxncommit.style = python:style.check_whitespace
179 if ARGUMENTS
.get('IGNORE_STYLE') != 'True' and isdir(joinpath(ROOT
, '.hg')):
181 from mercurial
import ui
182 check_style_hook(ui
.ui())
186 ###################################################
188 # Figure out which configurations to set up based on the path(s) of
191 ###################################################
193 # Find default configuration & binary.
194 Default(os
.environ
.get('M5_DEFAULT_BINARY', 'build/ALPHA_SE/m5.debug'))
196 # helper function: find last occurrence of element in list
197 def rfind(l
, elt
, offs
= -1):
198 for i
in range(len(l
)+offs
, 0, -1):
201 raise ValueError, "element not found"
203 # Each target must have 'build' in the interior of the path; the
204 # directory below this will determine the build parameters. For
205 # example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
206 # recognize that ALPHA_SE specifies the configuration because it
207 # follow 'build' in the bulid path.
209 # Generate absolute paths to targets so we can see where the build dir is
210 if COMMAND_LINE_TARGETS
:
211 # Ask SCons which directory it was invoked from
212 launch_dir
= GetLaunchDir()
213 # Make targets relative to invocation directory
214 abs_targets
= map(lambda x
: os
.path
.normpath(joinpath(launch_dir
, str(x
))),
215 COMMAND_LINE_TARGETS
)
217 # Default targets are relative to root of tree
218 abs_targets
= map(lambda x
: os
.path
.normpath(joinpath(ROOT
, str(x
))),
222 # Generate a list of the unique build roots and configs that the
223 # collected targets reference.
226 for t
in abs_targets
:
227 path_dirs
= t
.split('/')
229 build_top
= rfind(path_dirs
, 'build', -2)
231 print "Error: no non-leaf 'build' dir found on target path", t
233 this_build_root
= joinpath('/',*path_dirs
[:build_top
+1])
235 build_root
= this_build_root
237 if this_build_root
!= build_root
:
238 print "Error: build targets not under same build root\n"\
239 " %s\n %s" % (build_root
, this_build_root
)
241 build_path
= joinpath('/',*path_dirs
[:build_top
+2])
242 if build_path
not in build_paths
:
243 build_paths
.append(build_path
)
245 # Make sure build_root exists (might not if this is the first build there)
246 if not isdir(build_root
):
249 ###################################################
251 # Set up the default build environment. This environment is copied
252 # and modified according to each selected configuration.
254 ###################################################
256 env
= Environment(ENV
= os
.environ
, # inherit user's environment vars
262 env
.SConsignFile(joinpath(build_root
,"sconsign"))
264 # Default duplicate option is to use hard links, but this messes up
265 # when you use emacs to edit a file in the target dir, as emacs moves
266 # file to file~ then copies to file, breaking the link. Symbolic
267 # (soft) links work better.
268 env
.SetOption('duplicate', 'soft-copy')
270 # I waffle on this setting... it does avoid a few painful but
271 # unnecessary builds, but it also seems to make trivial builds take
274 env
.TargetSignatures('content')
277 # Set up global sticky options... these are common to an entire build
278 # tree (not specific to a particular build like ALPHA_SE)
281 # Option validators & converters for global sticky options
282 def PathListMakeAbsolute(val
):
285 f
= lambda p
: os
.path
.abspath(os
.path
.expanduser(p
))
286 return ':'.join(map(f
, val
.split(':')))
288 def PathListAllExist(key
, val
, env
):
291 paths
= val
.split(':')
294 raise SCons
.Errors
.UserError("Path does not exist: '%s'" % path
)
296 global_sticky_opts_file
= joinpath(build_root
, 'options.global')
298 global_sticky_opts
= Options(global_sticky_opts_file
, args
=ARGUMENTS
)
300 global_sticky_opts
.AddOptions(
301 ('CC', 'C compiler', os
.environ
.get('CC', env
['CC'])),
302 ('CXX', 'C++ compiler', os
.environ
.get('CXX', env
['CXX'])),
303 ('BATCH', 'Use batch pool for build and tests', False),
304 ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
305 ('EXTRAS', 'Add Extra directories to the compilation', '',
306 PathListAllExist
, PathListMakeAbsolute
)
312 Usage: scons [scons options] [build options] [target(s)]
316 help_text
+= "Global sticky options:\n" \
317 + global_sticky_opts
.GenerateHelpText(env
)
319 # Update env with values from ARGUMENTS & file global_sticky_opts_file
320 global_sticky_opts
.Update(env
)
322 # Save sticky option settings back to current options file
323 global_sticky_opts
.Save(global_sticky_opts_file
, env
)
325 # Parse EXTRAS option to build list of all directories where we're
326 # look for sources etc. This list is exported as base_dir_list.
327 base_dir
= joinpath(ROOT
, 'src')
329 extras_dir_list
= env
['EXTRAS'].split(':')
334 Export('extras_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')) })
338 env
['GCC'] = subprocess
.Popen(env
['CXX'] + ' --version', shell
=True,
339 stdout
=subprocess
.PIPE
, stderr
=subprocess
.STDOUT
,
340 close_fds
=True).communicate()[0].find('g++') >= 0
341 env
['SUNCC'] = subprocess
.Popen(env
['CXX'] + ' -V', shell
=True,
342 stdout
=subprocess
.PIPE
, stderr
=subprocess
.STDOUT
,
343 close_fds
=True).communicate()[0].find('Sun C++') >= 0
344 env
['ICC'] = subprocess
.Popen(env
['CXX'] + ' -V', shell
=True,
345 stdout
=subprocess
.PIPE
, stderr
=subprocess
.STDOUT
,
346 close_fds
=True).communicate()[0].find('Intel') >= 0
347 if env
['GCC'] + env
['SUNCC'] + env
['ICC'] > 1:
348 print 'Error: How can we have two at the same time?'
352 # Set up default C++ compiler flags
354 env
.Append(CCFLAGS
='-pipe')
355 env
.Append(CCFLAGS
='-fno-strict-aliasing')
356 env
.Append(CCFLAGS
=Split('-Wall -Wno-sign-compare -Werror -Wundef'))
357 env
.Append(CXXFLAGS
='-Wno-deprecated')
359 pass #Fix me... add warning flags once we clean up icc warnings
361 env
.Append(CCFLAGS
='-Qoption ccfe')
362 env
.Append(CCFLAGS
='-features=gcc')
363 env
.Append(CCFLAGS
='-features=extensions')
364 env
.Append(CCFLAGS
='-library=stlport4')
365 env
.Append(CCFLAGS
='-xar')
366 # env.Append(CCFLAGS='-instances=semiexplicit')
368 print 'Error: Don\'t know what compiler options to use for your compiler.'
369 print ' Please fix SConstruct and src/SConscript and try again.'
372 # Do this after we save setting back, or else we'll tack on an
373 # extra 'qdo' every time we run scons.
375 env
['CC'] = env
['BATCH_CMD'] + ' ' + env
['CC']
376 env
['CXX'] = env
['BATCH_CMD'] + ' ' + env
['CXX']
377 env
['AS'] = env
['BATCH_CMD'] + ' ' + env
['AS']
378 env
['AR'] = env
['BATCH_CMD'] + ' ' + env
['AR']
379 env
['RANLIB'] = env
['BATCH_CMD'] + ' ' + env
['RANLIB']
381 if sys
.platform
== 'cygwin':
382 # cygwin has some header file issues...
383 env
.Append(CCFLAGS
=Split("-Wno-uninitialized"))
384 env
.Append(CPPPATH
=[Dir('ext/dnet')])
387 if not env
.has_key('SWIG'):
388 print 'Error: SWIG utility not found.'
389 print ' Please install (see http://www.swig.org) and retry.'
392 # Check for appropriate SWIG version
393 swig_version
= os
.popen('swig -version').read().split()
394 # First 3 words should be "SWIG Version x.y.z"
395 if len(swig_version
) < 3 or \
396 swig_version
[0] != 'SWIG' or swig_version
[1] != 'Version':
397 print 'Error determining SWIG version.'
400 min_swig_version
= '1.3.28'
401 if compare_versions(swig_version
[2], min_swig_version
) < 0:
402 print 'Error: SWIG version', min_swig_version
, 'or newer required.'
403 print ' Installed version:', swig_version
[2]
406 # Set up SWIG flags & scanner
407 swig_flags
=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
408 env
.Append(SWIGFLAGS
=swig_flags
)
410 # filter out all existing swig scanners, they mess up the dependency
411 # stuff for some reason
413 for scanner
in env
['SCANNERS']:
414 skeys
= scanner
.skeys
418 if isinstance(skeys
, (list, tuple)) and '.i' in skeys
:
421 scanners
.append(scanner
)
423 # add the new swig scanner that we like better
424 from SCons
.Scanner
import ClassicCPP
as CPPScanner
425 swig_inc_re
= '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
426 scanners
.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re
))
428 # replace the scanners list that has what we want
429 env
['SCANNERS'] = scanners
431 # Add a custom Check function to the Configure context so that we can
432 # figure out if the compiler adds leading underscores to global
433 # variables. This is needed for the autogenerated asm files that we
434 # use for embedding the python code.
435 def CheckLeading(context
):
436 context
.Message("Checking for leading underscore in global variables...")
437 # 1) Define a global variable called x from asm so the C compiler
438 # won't change the symbol at all.
439 # 2) Declare that variable.
440 # 3) Use the variable
442 # If the compiler prepends an underscore, this will successfully
443 # link because the external symbol 'x' will be called '_x' which
444 # was defined by the asm statement. If the compiler does not
445 # prepend an underscore, this will not successfully link because
446 # '_x' will have been defined by assembly, while the C portion of
447 # the code will be trying to use 'x'
448 ret
= context
.TryLink('''
449 asm(".globl _x; _x: .byte 0");
451 int main() { return x; }
453 context
.env
.Append(LEADING_UNDERSCORE
=ret
)
457 # Platform-specific configuration. Note again that we assume that all
458 # builds under a given build root run on the same host platform.
459 conf
= Configure(env
,
460 conf_dir
= joinpath(build_root
, '.scons_config'),
461 log_file
= joinpath(build_root
, 'scons_config.log'),
462 custom_tests
= { 'CheckLeading' : CheckLeading
})
464 # Check for leading underscores. Don't really need to worry either
465 # way so don't need to check the return code.
468 # Check if we should compile a 64 bit binary on Mac OS X/Darwin
471 uname
= platform
.uname()
472 if uname
[0] == 'Darwin' and compare_versions(uname
[2], '9.0.0') >= 0:
473 if int(subprocess
.Popen('sysctl -n hw.cpu64bit_capable', shell
=True,
474 stdout
=subprocess
.PIPE
, stderr
=subprocess
.STDOUT
,
475 close_fds
=True).communicate()[0][0]):
476 env
.Append(CCFLAGS
='-arch x86_64')
477 env
.Append(CFLAGS
='-arch x86_64')
478 env
.Append(LINKFLAGS
='-arch x86_64')
479 env
.Append(ASFLAGS
='-arch x86_64')
483 # Recent versions of scons substitute a "Null" object for Configure()
484 # when configuration isn't necessary, e.g., if the "--help" option is
485 # present. Unfortuantely this Null object always returns false,
486 # breaking all our configuration checks. We replace it with our own
487 # more optimistic null object that returns True instead.
489 def NullCheck(*args
, **kwargs
):
493 def __init__(self
, env
):
497 def __getattr__(self
, mname
):
502 # Find Python include and library directories for embedding the
503 # interpreter. For consistency, we will use the same Python
504 # installation used to run scons (and thus this script). If you want
505 # to link in an alternate version, see above for instructions on how
506 # to invoke scons with a different copy of the Python interpreter.
508 # Get brief Python version name (e.g., "python2.4") for locating
509 # include & library files
510 py_version_name
= 'python' + sys
.version
[:3]
512 # include path, e.g. /usr/local/include/python2.4
513 py_header_path
= joinpath(sys
.exec_prefix
, 'include', py_version_name
)
514 env
.Append(CPPPATH
= py_header_path
)
515 # verify that it works
516 if not conf
.CheckHeader('Python.h', '<>'):
517 print "Error: can't find Python.h header in", py_header_path
520 # add library path too if it's not in the default place
522 if sys
.exec_prefix
!= '/usr':
523 py_lib_path
= joinpath(sys
.exec_prefix
, 'lib')
524 elif sys
.platform
== 'cygwin':
525 # cygwin puts the .dll in /bin for some reason
528 env
.Append(LIBPATH
= py_lib_path
)
529 print 'Adding', py_lib_path
, 'to LIBPATH for', py_version_name
530 if not conf
.CheckLib(py_version_name
):
531 print "Error: can't find Python library", py_version_name
534 # On Solaris you need to use libsocket for socket ops
535 if not conf
.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
536 if not conf
.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
537 print "Can't find library with socket calls (e.g. accept())"
540 # Check for zlib. If the check passes, libz will be automatically
541 # added to the LIBS environment variable.
542 if not conf
.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
543 print 'Error: did not find needed zlib compression library '\
544 'and/or zlib.h header file.'
545 print ' Please install zlib and try again.'
548 # Check for <fenv.h> (C99 FP environment control)
549 have_fenv
= conf
.CheckHeader('fenv.h', '<>')
551 print "Warning: Header file <fenv.h> not found."
552 print " This host has no IEEE FP rounding mode control."
555 mysql_config
= WhereIs('mysql_config')
556 have_mysql
= mysql_config
!= None
558 # Check MySQL version.
560 mysql_version
= os
.popen(mysql_config
+ ' --version').read()
561 min_mysql_version
= '4.1'
562 if compare_versions(mysql_version
, min_mysql_version
) < 0:
563 print 'Warning: MySQL', min_mysql_version
, 'or newer required.'
564 print ' Version', mysql_version
, 'detected.'
567 # Set up mysql_config commands.
569 mysql_config_include
= mysql_config
+ ' --include'
570 if os
.system(mysql_config_include
+ ' > /dev/null') != 0:
571 # older mysql_config versions don't support --include, use
573 mysql_config_include
= mysql_config
+ ' --cflags | sed s/\\\'//g'
574 # This seems to work in all versions
575 mysql_config_libs
= mysql_config
+ ' --libs'
579 # Define the universe of supported ISAs
581 Export('all_isa_list')
583 # Define the universe of supported CPU models
586 Export('all_cpu_list', 'default_cpus')
588 # Sticky options get saved in the options file so they persist from
589 # one invocation to the next (unless overridden, in which case the new
590 # value becomes sticky).
591 sticky_opts
= Options(args
=ARGUMENTS
)
592 Export('sticky_opts')
594 # Non-sticky options only apply to the current build.
595 nonsticky_opts
= Options(args
=ARGUMENTS
)
596 Export('nonsticky_opts')
598 # Walk the tree and execute all SConsopts scripts that wil add to the
600 for bdir
in [ base_dir
] + extras_dir_list
:
601 for root
, dirs
, files
in os
.walk(bdir
):
602 if 'SConsopts' in files
:
603 print "Reading", joinpath(root
, 'SConsopts')
604 SConscript(joinpath(root
, 'SConsopts'))
610 sticky_opts
.AddOptions(
611 EnumOption('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list
),
612 BoolOption('FULL_SYSTEM', 'Full-system support', False),
613 # There's a bug in scons 0.96.1 that causes ListOptions with list
614 # values (more than one value) not to be able to be restored from
615 # a saved option file. If this causes trouble then upgrade to
616 # scons 0.96.90 or later.
617 ListOption('CPU_MODELS', 'CPU models', default_cpus
, all_cpu_list
),
618 BoolOption('NO_FAST_ALLOC', 'Disable fast object allocator', False),
619 BoolOption('FAST_ALLOC_DEBUG', 'Enable fast object allocator debugging',
621 BoolOption('FAST_ALLOC_STATS', 'Enable fast object allocator statistics',
623 BoolOption('EFENCE', 'Link with Electric Fence malloc debugger',
625 BoolOption('SS_COMPATIBLE_FP',
626 'Make floating-point results compatible with SimpleScalar',
628 BoolOption('USE_SSE2',
629 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
631 BoolOption('USE_MYSQL', 'Use MySQL for stats output', have_mysql
),
632 BoolOption('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv
),
633 BoolOption('USE_CHECKER', 'Use checker for detailed CPU models', False),
636 nonsticky_opts
.AddOptions(
637 BoolOption('update_ref', 'Update test reference outputs', False)
640 # These options get exported to #defines in config/*.hh (see src/SConscript).
641 env
.ExportOptions
= ['FULL_SYSTEM', 'ALPHA_TLASER', 'USE_FENV', \
642 'USE_MYSQL', 'NO_FAST_ALLOC', 'FAST_ALLOC_DEBUG', \
643 'FAST_ALLOC_STATS', 'SS_COMPATIBLE_FP', \
644 'USE_CHECKER', 'TARGET_ISA']
646 # Define a handy 'no-op' action
647 def no_action(target
, source
, env
):
650 env
.NoAction
= Action(no_action
, None)
652 ###################################################
654 # Define a SCons builder for configuration flag headers.
656 ###################################################
658 # This function generates a config header file that #defines the
659 # option symbol to the current option setting (0 or 1). The source
660 # operands are the name of the option and a Value node containing the
661 # value of the option.
662 def build_config_file(target
, source
, env
):
663 (option
, value
) = [s
.get_contents() for s
in source
]
664 f
= file(str(target
[0]), 'w')
665 print >> f
, '#define', option
, value
669 # Generate the message to be printed when building the config file.
670 def build_config_file_string(target
, source
, env
):
671 (option
, value
) = [s
.get_contents() for s
in source
]
672 return "Defining %s as %s in %s." % (option
, value
, target
[0])
674 # Combine the two functions into a scons Action object.
675 config_action
= Action(build_config_file
, build_config_file_string
)
677 # The emitter munges the source & target node lists to reflect what
678 # we're really doing.
679 def config_emitter(target
, source
, env
):
680 # extract option name from Builder arg
681 option
= str(target
[0])
682 # True target is config header file
683 target
= joinpath('config', option
.lower() + '.hh')
685 if isinstance(val
, bool):
688 elif isinstance(val
, str):
689 val
= '"' + val
+ '"'
691 # Sources are option name & value (packaged in SCons Value nodes)
692 return ([target
], [Value(option
), Value(val
)])
694 config_builder
= Builder(emitter
= config_emitter
, action
= config_action
)
696 env
.Append(BUILDERS
= { 'ConfigFile' : config_builder
})
698 ###################################################
700 # Define a SCons builder for copying files. This is used by the
701 # Python zipfile code in src/python/SConscript, but is placed up here
702 # since it's potentially more generally applicable.
704 ###################################################
706 copy_builder
= Builder(action
= Copy("$TARGET", "$SOURCE"))
708 env
.Append(BUILDERS
= { 'CopyFile' : copy_builder
})
710 ###################################################
712 # Define a simple SCons builder to concatenate files.
714 # Used to append the Python zip archive to the executable.
716 ###################################################
718 concat_builder
= Builder(action
= Action(['cat $SOURCES > $TARGET',
719 'chmod +x $TARGET']))
721 env
.Append(BUILDERS
= { 'Concat' : concat_builder
})
724 # libelf build is shared across all configs in the build root.
725 env
.SConscript('ext/libelf/SConscript',
726 build_dir
= joinpath(build_root
, 'libelf'),
729 # gzstream build is shared across all configs in the build root.
730 env
.SConscript('ext/gzstream/SConscript',
731 build_dir
= joinpath(build_root
, 'gzstream'),
734 ###################################################
736 # This function is used to set up a directory with switching headers
738 ###################################################
740 env
['ALL_ISA_LIST'] = all_isa_list
741 def make_switching_dir(dirname
, switch_headers
, env
):
742 # Generate the header. target[0] is the full path of the output
743 # header to generate. 'source' is a dummy variable, since we get the
744 # list of ISAs from env['ALL_ISA_LIST'].
745 def gen_switch_hdr(target
, source
, env
):
746 fname
= str(target
[0])
747 basename
= os
.path
.basename(fname
)
749 f
.write('#include "arch/isa_specific.hh"\n')
751 for isa
in all_isa_list
:
752 f
.write('%s THE_ISA == %s_ISA\n#include "%s/%s/%s"\n'
753 % (cond
, isa
.upper(), dirname
, isa
, basename
))
755 f
.write('#else\n#error "THE_ISA not set"\n#endif\n')
759 # String to print when generating header
760 def gen_switch_hdr_string(target
, source
, env
):
761 return "Generating switch header " + str(target
[0])
763 # Build SCons Action object. 'varlist' specifies env vars that this
764 # action depends on; when env['ALL_ISA_LIST'] changes these actions
765 # should get re-executed.
766 switch_hdr_action
= Action(gen_switch_hdr
, gen_switch_hdr_string
,
767 varlist
=['ALL_ISA_LIST'])
769 # Instantiate actions for each header
770 for hdr
in switch_headers
:
771 env
.Command(hdr
, [], switch_hdr_action
)
772 Export('make_switching_dir')
774 ###################################################
776 # Define build environments for selected configurations.
778 ###################################################
783 for build_path
in build_paths
:
784 print "Building in", build_path
786 # Make a copy of the build-root environment to use for this config.
787 env
= base_env
.Copy()
788 env
['BUILDDIR'] = build_path
790 # build_dir is the tail component of build path, and is used to
791 # determine the build parameters (e.g., 'ALPHA_SE')
792 (build_root
, build_dir
) = os
.path
.split(build_path
)
794 # Set env options according to the build directory config.
795 sticky_opts
.files
= []
796 # Options for $BUILD_ROOT/$BUILD_DIR are stored in
797 # $BUILD_ROOT/options/$BUILD_DIR so you can nuke
798 # $BUILD_ROOT/$BUILD_DIR without losing your options settings.
799 current_opts_file
= joinpath(build_root
, 'options', build_dir
)
800 if isfile(current_opts_file
):
801 sticky_opts
.files
.append(current_opts_file
)
802 print "Using saved options file %s" % current_opts_file
804 # Build dir-specific options file doesn't exist.
806 # Make sure the directory is there so we can create it later
807 opt_dir
= os
.path
.dirname(current_opts_file
)
808 if not isdir(opt_dir
):
811 # Get default build options from source tree. Options are
812 # normally determined by name of $BUILD_DIR, but can be
813 # overriden by 'default=' arg on command line.
814 default_opts_file
= joinpath('build_opts',
815 ARGUMENTS
.get('default', build_dir
))
816 if isfile(default_opts_file
):
817 sticky_opts
.files
.append(default_opts_file
)
818 print "Options file %s not found,\n using defaults in %s" \
819 % (current_opts_file
, default_opts_file
)
821 print "Error: cannot find options file %s or %s" \
822 % (current_opts_file
, default_opts_file
)
825 # Apply current option settings to env
826 sticky_opts
.Update(env
)
827 nonsticky_opts
.Update(env
)
829 help_text
+= "\nSticky options for %s:\n" % build_dir \
830 + sticky_opts
.GenerateHelpText(env
) \
831 + "\nNon-sticky options for %s:\n" % build_dir \
832 + nonsticky_opts
.GenerateHelpText(env
)
834 # Process option settings.
836 if not have_fenv
and env
['USE_FENV']:
837 print "Warning: <fenv.h> not available; " \
838 "forcing USE_FENV to False in", build_dir
+ "."
839 env
['USE_FENV'] = False
841 if not env
['USE_FENV']:
842 print "Warning: No IEEE FP rounding mode control in", build_dir
+ "."
843 print " FP results may deviate slightly from other platforms."
846 env
.Append(LIBS
=['efence'])
850 print "Warning: MySQL not available; " \
851 "forcing USE_MYSQL to False in", build_dir
+ "."
852 env
['USE_MYSQL'] = False
854 print "Compiling in", build_dir
, "with MySQL support."
855 env
.ParseConfig(mysql_config_libs
)
856 env
.ParseConfig(mysql_config_include
)
858 # Save sticky option settings back to current options file
859 sticky_opts
.Save(current_opts_file
, env
)
862 env
.Append(CCFLAGS
='-msse2')
864 # The src/SConscript file sets up the build rules in 'env' according
865 # to the configured options. It returns a list of environments,
866 # one for each variant build (debug, opt, etc.)
867 envList
= SConscript('src/SConscript', build_dir
= build_path
,
870 # Set up the regression tests for each build.
872 SConscript('tests/SConscript',
873 build_dir
= joinpath(build_path
, 'tests', e
.Label
),
874 exports
= { 'env' : e
}, duplicate
= False)
879 ###################################################
881 # Let SCons do its thing. At this point SCons will use the defined
882 # build environments to build the requested targets.
884 ###################################################