3 # Copyright (c) 2013, 2015, 2016 ARM Limited
6 # The license below extends only to copyright in the software and shall
7 # not be construed as granting a license to any other intellectual
8 # property including but not limited to intellectual property relating
9 # to a hardware implementation of the functionality of the software
10 # licensed hereunder. You may use the software subject to the license
11 # terms below provided that you ensure that this notice is replicated
12 # unmodified and in its entirety in all distributions of the software,
13 # modified or unmodified, in source code or in binary form.
15 # Copyright (c) 2011 Advanced Micro Devices, Inc.
16 # Copyright (c) 2009 The Hewlett-Packard Development Company
17 # Copyright (c) 2004-2005 The Regents of The University of Michigan
18 # All rights reserved.
20 # Redistribution and use in source and binary forms, with or without
21 # modification, are permitted provided that the following conditions are
22 # met: redistributions of source code must retain the above copyright
23 # notice, this list of conditions and the following disclaimer;
24 # redistributions in binary form must reproduce the above copyright
25 # notice, this list of conditions and the following disclaimer in the
26 # documentation and/or other materials provided with the distribution;
27 # neither the name of the copyright holders nor the names of its
28 # contributors may be used to endorse or promote products derived from
29 # this software without specific prior written permission.
31 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
34 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
37 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
38 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
39 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
40 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
41 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
43 # Authors: Steve Reinhardt
46 ###################################################
48 # SCons top-level build description (SConstruct) file.
50 # While in this directory ('gem5'), just type 'scons' to build the default
51 # configuration (see below), or type 'scons build/<CONFIG>/<binary>'
52 # to build some other configuration (e.g., 'build/ALPHA/gem5.opt' for
53 # the optimized full-system version).
55 # You can build gem5 in a different directory as long as there is a
56 # 'build/<CONFIG>' somewhere along the target path. The build system
57 # expects that all configs under the same build directory are being
58 # built for the same host system.
62 # The following two commands are equivalent. The '-u' option tells
63 # scons to search up the directory tree for this SConstruct file.
64 # % cd <path-to-src>/gem5 ; scons build/ALPHA/gem5.debug
65 # % cd <path-to-src>/gem5/build/ALPHA; scons -u gem5.debug
67 # The following two commands are equivalent and demonstrate building
68 # in a directory outside of the source tree. The '-C' option tells
69 # scons to chdir to the specified directory to find this SConstruct
71 # % cd <path-to-src>/gem5 ; scons /local/foo/build/ALPHA/gem5.debug
72 # % cd /local/foo/build/ALPHA; scons -C <path-to-src>/gem5 gem5.debug
74 # You can use 'scons -H' to print scons options. If you're in this
75 # 'gem5' directory (or use -u or -C to tell scons where to find this
76 # file), you can use 'scons -h' to print all the gem5-specific build
79 ###################################################
81 # Check for recent-enough Python and SCons versions.
83 # Really old versions of scons only take two options for the
84 # function, so check once without the revision and once with the
85 # revision, the first instance will fail for stuff other than
86 # 0.98, and the second will fail for 0.98.0
87 EnsureSConsVersion(0, 98)
88 EnsureSConsVersion(0, 98, 1)
91 For more details, see:
92 http://gem5.org/Dependencies
96 # We ensure the python version early because because python-config
99 EnsurePythonVersion(2, 5)
100 except SystemExit, e
:
102 You can use a non-default installation of the Python interpreter by
103 rearranging your PATH so that scons finds the non-default 'python' and
104 'python-config' first.
106 For more details, see:
107 http://gem5.org/wiki/index.php/Using_a_non-default_Python_installation
111 # Global Python includes
119 from os
import mkdir
, environ
120 from os
.path
import abspath
, basename
, dirname
, expanduser
, normpath
121 from os
.path
import exists
, isdir
, isfile
122 from os
.path
import join
as joinpath
, split
as splitpath
128 extra_python_paths
= [
129 Dir('src/python').srcnode().abspath
, # gem5 includes
130 Dir('ext/ply').srcnode().abspath
, # ply is used by several files
133 sys
.path
[1:1] = extra_python_paths
135 from m5
.util
import compareVersions
, readCommand
136 from m5
.util
.terminal
import get_termcap
147 # There's a bug in scons in that (1) by default, the help texts from
148 # AddOption() are supposed to be displayed when you type 'scons -h'
149 # and (2) you can override the help displayed by 'scons -h' using the
150 # Help() function, but these two features are incompatible: once
151 # you've overridden the help text using Help(), there's no way to get
152 # at the help texts from AddOptions. See:
153 # http://scons.tigris.org/issues/show_bug.cgi?id=2356
154 # http://scons.tigris.org/issues/show_bug.cgi?id=2611
155 # This hack lets us extract the help text from AddOptions and
156 # re-inject it via Help(). Ideally someday this bug will be fixed and
157 # we can just use AddOption directly.
158 def AddLocalOption(*args
, **kwargs
):
161 help = " " + ", ".join(args
)
164 if length
>= col_width
:
165 help += "\n" + " " * col_width
167 help += " " * (col_width
- length
)
168 help += kwargs
["help"]
169 help_texts
["options"] += help + "\n"
171 AddOption(*args
, **kwargs
)
173 AddLocalOption('--colors', dest
='use_colors', action
='store_true',
174 help="Add color to abbreviated scons output")
175 AddLocalOption('--no-colors', dest
='use_colors', action
='store_false',
176 help="Don't add color to abbreviated scons output")
177 AddLocalOption('--with-cxx-config', dest
='with_cxx_config',
179 help="Build with support for C++-based configuration")
180 AddLocalOption('--default', dest
='default', type='string', action
='store',
181 help='Override which build_opts file to use for defaults')
182 AddLocalOption('--ignore-style', dest
='ignore_style', action
='store_true',
183 help='Disable style checking hooks')
184 AddLocalOption('--no-lto', dest
='no_lto', action
='store_true',
185 help='Disable Link-Time Optimization for fast')
186 AddLocalOption('--update-ref', dest
='update_ref', action
='store_true',
187 help='Update test reference outputs')
188 AddLocalOption('--verbose', dest
='verbose', action
='store_true',
189 help='Print full tool command lines')
190 AddLocalOption('--without-python', dest
='without_python',
192 help='Build without Python configuration support')
193 AddLocalOption('--without-tcmalloc', dest
='without_tcmalloc',
195 help='Disable linking against tcmalloc')
196 AddLocalOption('--with-ubsan', dest
='with_ubsan', action
='store_true',
197 help='Build with Undefined Behavior Sanitizer if available')
198 AddLocalOption('--with-asan', dest
='with_asan', action
='store_true',
199 help='Build with Address Sanitizer if available')
201 termcap
= get_termcap(GetOption('use_colors'))
203 ########################################################################
205 # Set up the main build environment.
207 ########################################################################
209 # export TERM so that clang reports errors in color
210 use_vars
= set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH',
211 'LIBRARY_PATH', 'PATH', 'PKG_CONFIG_PATH', 'PROTOC',
212 'PYTHONPATH', 'RANLIB', 'SWIG', 'TERM' ])
215 "ASAN_", # address sanitizer symbolizer path and settings
216 "CCACHE_", # ccache (caching compiler wrapper) configuration
217 "CCC_", # clang static analyzer configuration
218 "DISTCC_", # distcc (distributed compiler wrapper) configuration
219 "INCLUDE_SERVER_", # distcc pump server settings
220 "M5", # M5 configuration (e.g., path to kernels)
224 for key
,val
in sorted(os
.environ
.iteritems()):
225 if key
in use_vars
or \
226 any([key
.startswith(prefix
) for prefix
in use_prefixes
]):
229 # Tell scons to avoid implicit command dependencies to avoid issues
230 # with the param wrappes being compiled twice (see
231 # http://scons.tigris.org/issues/show_bug.cgi?id=2811)
232 main
= Environment(ENV
=use_env
, IMPLICIT_COMMAND_DEPENDENCIES
=0)
233 main
.Decider('MD5-timestamp')
234 main
.root
= Dir(".") # The current directory (where this file lives).
235 main
.srcdir
= Dir("src") # The source directory
237 main_dict_keys
= main
.Dictionary().keys()
239 # Check that we have a C/C++ compiler
240 if not ('CC' in main_dict_keys
and 'CXX' in main_dict_keys
):
241 print "No C++ compiler installed (package g++ on Ubuntu and RedHat)"
244 # Check that swig is present
245 if not 'SWIG' in main_dict_keys
:
246 print "swig is not installed (package swig on Ubuntu and RedHat)"
249 # add useful python code PYTHONPATH so it can be used by subprocesses
251 main
.AppendENVPath('PYTHONPATH', extra_python_paths
)
253 ########################################################################
257 # If the gem5 directory is a mercurial repository, we should do some
260 ########################################################################
262 hgdir
= main
.root
.Dir(".hg")
266 You're missing the gem5 style hook, which automatically checks your code
267 against the gem5 style rules on %s.
268 This script will now install the hook in your %s.
269 Press enter to continue, or ctrl-c to abort: """
271 mercurial_style_message
= """
272 You're missing the gem5 style hook, which automatically checks your code
273 against the gem5 style rules on hg commit and qrefresh commands.
274 This script will now install the hook in your .hg/hgrc file.
275 Press enter to continue, or ctrl-c to abort: """
277 git_style_message
= """
278 You're missing the gem5 style or commit message hook. These hooks help
279 to ensure that your code follows gem5's style rules on git commit.
280 This script will now install the hook in your .git/hooks/ directory.
281 Press enter to continue, or ctrl-c to abort: """
283 mercurial_style_upgrade_message
= """
284 Your Mercurial style hooks are not up-to-date. This script will now
285 try to automatically update them. A backup of your hgrc will be saved
287 Press enter to continue, or ctrl-c to abort: """
289 mercurial_style_hook
= """
290 # The following lines were automatically added by gem5/SConstruct
291 # to provide the gem5 style-checking hooks
293 hgstyle = %s/util/hgstyle.py
296 pretxncommit.style = python:hgstyle.check_style
297 pre-qrefresh.style = python:hgstyle.check_style
298 # End of SConstruct additions
300 """ % (main
.root
.abspath
)
302 mercurial_lib_not_found
= """
303 Mercurial libraries cannot be found, ignoring style hook. If
304 you are a gem5 developer, please fix this and run the style
305 hook. It is important.
308 # Check for style hook and prompt for installation if it's not there.
309 # Skip this if --ignore-style was specified, there's no interactive
310 # terminal to prompt, or no recognized revision control system can be
312 ignore_style
= GetOption('ignore_style') or not sys
.stdin
.isatty()
314 # Try wire up Mercurial to the style hooks
315 if not ignore_style
and hgdir
.exists():
317 style_hooks
= tuple()
318 hgrc
= hgdir
.File('hgrc')
319 hgrc_old
= hgdir
.File('hgrc.old')
321 from mercurial
import ui
323 ui
.readconfig(hgrc
.abspath
)
324 style_hooks
= (ui
.config('hooks', 'pretxncommit.style', None),
325 ui
.config('hooks', 'pre-qrefresh.style', None))
326 style_hook
= all(style_hooks
)
327 style_extension
= ui
.config('extensions', 'style', None)
329 print mercurial_lib_not_found
331 if "python:style.check_style" in style_hooks
:
332 # Try to upgrade the style hooks
333 print mercurial_style_upgrade_message
334 # continue unless user does ctrl-c/ctrl-d etc.
338 print "Input exception, exiting scons.\n"
340 shutil
.copyfile(hgrc
.abspath
, hgrc_old
.abspath
)
341 re_style_hook
= re
.compile(r
"^([^=#]+)\.style\s*=\s*([^#\s]+).*")
342 re_style_extension
= re
.compile("style\s*=\s*([^#\s]+).*")
343 old
, new
= open(hgrc_old
.abspath
, 'r'), open(hgrc
.abspath
, 'w')
345 m_hook
= re_style_hook
.match(l
)
346 m_ext
= re_style_extension
.match(l
)
348 hook
, check
= m_hook
.groups()
349 if check
!= "python:style.check_style":
350 print "Warning: %s.style is using a non-default " \
351 "checker: %s" % (hook
, check
)
352 if hook
not in ("pretxncommit", "pre-qrefresh"):
353 print "Warning: Updating unknown style hook: %s" % hook
355 l
= "%s.style = python:hgstyle.check_style\n" % hook
356 elif m_ext
and m_ext
.group(1) == style_extension
:
357 l
= "hgstyle = %s/util/hgstyle.py\n" % main
.root
.abspath
361 print mercurial_style_message
,
362 # continue unless user does ctrl-c/ctrl-d etc.
366 print "Input exception, exiting scons.\n"
368 hgrc_path
= '%s/.hg/hgrc' % main
.root
.abspath
369 print "Adding style hook to", hgrc_path
, "\n"
371 with
open(hgrc_path
, 'a') as f
:
372 f
.write(mercurial_style_hook
)
374 print "Error updating", hgrc_path
377 def install_git_style_hooks():
379 gitdir
= Dir(readCommand(
380 ["git", "rev-parse", "--git-dir"]).strip("\n"))
382 print "Warning: Failed to find git repo directory: %s" % e
385 git_hooks
= gitdir
.Dir("hooks")
386 def hook_exists(hook_name
):
387 hook
= git_hooks
.File(hook_name
)
390 def hook_install(hook_name
, script
):
391 hook
= git_hooks
.File(hook_name
)
393 print "Warning: Can't install %s, hook already exists." % hook_name
396 if not git_hooks
.exists():
397 mkdir(git_hooks
.get_abspath())
399 # Use a relative symlink if the hooks live in the source directory
400 if hook
.is_under(main
.root
):
401 script_path
= os
.path
.relpath(
402 script
.get_abspath(),
403 hook
.Dir(".").get_abspath())
405 script_path
= script
.get_abspath()
408 os
.symlink(script_path
, hook
.get_abspath())
410 print "Error updating git %s hook" % hook_name
413 if hook_exists("pre-commit") and hook_exists("commit-msg"):
416 print git_style_message
,
420 print "Input exception, exiting scons.\n"
423 git_style_script
= File("util/git-pre-commit.py")
424 git_msg_script
= File("ext/git-commit-msg")
426 hook_install("pre-commit", git_style_script
)
427 hook_install("commit-msg", git_msg_script
)
429 # Try to wire up git to the style hooks
430 if not ignore_style
and main
.root
.Entry(".git").exists():
431 install_git_style_hooks()
433 ###################################################
435 # Figure out which configurations to set up based on the path(s) of
438 ###################################################
440 # Find default configuration & binary.
441 Default(environ
.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug'))
443 # helper function: find last occurrence of element in list
444 def rfind(l
, elt
, offs
= -1):
445 for i
in range(len(l
)+offs
, 0, -1):
448 raise ValueError, "element not found"
450 # Take a list of paths (or SCons Nodes) and return a list with all
451 # paths made absolute and ~-expanded. Paths will be interpreted
452 # relative to the launch directory unless a different root is provided
453 def makePathListAbsolute(path_list
, root
=GetLaunchDir()):
454 return [abspath(joinpath(root
, expanduser(str(p
))))
457 # Each target must have 'build' in the interior of the path; the
458 # directory below this will determine the build parameters. For
459 # example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
460 # recognize that ALPHA_SE specifies the configuration because it
461 # follow 'build' in the build path.
463 # The funky assignment to "[:]" is needed to replace the list contents
464 # in place rather than reassign the symbol to a new list, which
465 # doesn't work (obviously!).
466 BUILD_TARGETS
[:] = makePathListAbsolute(BUILD_TARGETS
)
468 # Generate a list of the unique build roots and configs that the
469 # collected targets reference.
472 for t
in BUILD_TARGETS
:
473 path_dirs
= t
.split('/')
475 build_top
= rfind(path_dirs
, 'build', -2)
477 print "Error: no non-leaf 'build' dir found on target path", t
479 this_build_root
= joinpath('/',*path_dirs
[:build_top
+1])
481 build_root
= this_build_root
483 if this_build_root
!= build_root
:
484 print "Error: build targets not under same build root\n"\
485 " %s\n %s" % (build_root
, this_build_root
)
487 variant_path
= joinpath('/',*path_dirs
[:build_top
+2])
488 if variant_path
not in variant_paths
:
489 variant_paths
.append(variant_path
)
491 # Make sure build_root exists (might not if this is the first build there)
492 if not isdir(build_root
):
494 main
['BUILDROOT'] = build_root
498 main
.SConsignFile(joinpath(build_root
, "sconsign"))
500 # Default duplicate option is to use hard links, but this messes up
501 # when you use emacs to edit a file in the target dir, as emacs moves
502 # file to file~ then copies to file, breaking the link. Symbolic
503 # (soft) links work better.
504 main
.SetOption('duplicate', 'soft-copy')
507 # Set up global sticky variables... these are common to an entire build
508 # tree (not specific to a particular build like ALPHA_SE)
511 global_vars_file
= joinpath(build_root
, 'variables.global')
513 global_vars
= Variables(global_vars_file
, args
=ARGUMENTS
)
515 global_vars
.AddVariables(
516 ('CC', 'C compiler', environ
.get('CC', main
['CC'])),
517 ('CXX', 'C++ compiler', environ
.get('CXX', main
['CXX'])),
518 ('SWIG', 'SWIG tool', environ
.get('SWIG', main
['SWIG'])),
519 ('PROTOC', 'protoc tool', environ
.get('PROTOC', 'protoc')),
520 ('BATCH', 'Use batch pool for build and tests', False),
521 ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
522 ('M5_BUILD_CACHE', 'Cache built objects in this directory', False),
523 ('EXTRAS', 'Add extra directories to the compilation', '')
526 # Update main environment with values from ARGUMENTS & global_vars_file
527 global_vars
.Update(main
)
528 help_texts
["global_vars"] += global_vars
.GenerateHelpText(main
)
530 # Save sticky variable settings back to current variables file
531 global_vars
.Save(global_vars_file
, main
)
533 # Parse EXTRAS variable to build list of all directories where we're
534 # look for sources etc. This list is exported as extras_dir_list.
535 base_dir
= main
.srcdir
.abspath
537 extras_dir_list
= makePathListAbsolute(main
['EXTRAS'].split(':'))
542 Export('extras_dir_list')
544 # the ext directory should be on the #includes path
545 main
.Append(CPPPATH
=[Dir('ext')])
547 def strip_build_path(path
, env
):
549 variant_base
= env
['BUILDROOT'] + os
.path
.sep
550 if path
.startswith(variant_base
):
551 path
= path
[len(variant_base
):]
552 elif path
.startswith('build/'):
556 # Generate a string of the form:
557 # common/path/prefix/src1, src2 -> tgt1, tgt2
558 # to print while building.
559 class Transform(object):
560 # all specific color settings should be here and nowhere else
561 tool_color
= termcap
.Normal
562 pfx_color
= termcap
.Yellow
563 srcs_color
= termcap
.Yellow
+ termcap
.Bold
564 arrow_color
= termcap
.Blue
+ termcap
.Bold
565 tgts_color
= termcap
.Yellow
+ termcap
.Bold
567 def __init__(self
, tool
, max_sources
=99):
568 self
.format
= self
.tool_color
+ (" [%8s] " % tool
) \
569 + self
.pfx_color
+ "%s" \
570 + self
.srcs_color
+ "%s" \
571 + self
.arrow_color
+ " -> " \
572 + self
.tgts_color
+ "%s" \
574 self
.max_sources
= max_sources
576 def __call__(self
, target
, source
, env
, for_signature
=None):
577 # truncate source list according to max_sources param
578 source
= source
[0:self
.max_sources
]
580 return strip_build_path(str(f
), env
)
582 srcs
= map(strip
, source
)
585 tgts
= map(strip
, target
)
586 # surprisingly, os.path.commonprefix is a dumb char-by-char string
587 # operation that has nothing to do with paths.
588 com_pfx
= os
.path
.commonprefix(srcs
+ tgts
)
589 com_pfx_len
= len(com_pfx
)
591 # do some cleanup and sanity checking on common prefix
592 if com_pfx
[-1] == ".":
593 # prefix matches all but file extension: ok
594 # back up one to change 'foo.cc -> o' to 'foo.cc -> .o'
595 com_pfx
= com_pfx
[0:-1]
596 elif com_pfx
[-1] == "/":
597 # common prefix is directory path: OK
600 src0_len
= len(srcs
[0])
601 tgt0_len
= len(tgts
[0])
602 if src0_len
== com_pfx_len
:
603 # source is a substring of target, OK
605 elif tgt0_len
== com_pfx_len
:
606 # target is a substring of source, need to back up to
607 # avoid empty string on RHS of arrow
608 sep_idx
= com_pfx
.rfind(".")
610 com_pfx
= com_pfx
[0:sep_idx
]
613 elif src0_len
> com_pfx_len
and srcs
[0][com_pfx_len
] == ".":
614 # still splitting at file extension: ok
617 # probably a fluke; ignore it
619 # recalculate length in case com_pfx was modified
620 com_pfx_len
= len(com_pfx
)
622 f
= map(lambda s
: s
[com_pfx_len
:], files
)
624 return self
.format
% (com_pfx
, fmt(srcs
), fmt(tgts
))
628 # enable the regression script to use the termcap
629 main
['TERMCAP'] = termcap
631 if GetOption('verbose'):
632 def MakeAction(action
, string
, *args
, **kwargs
):
633 return Action(action
, *args
, **kwargs
)
636 main
['CCCOMSTR'] = Transform("CC")
637 main
['CXXCOMSTR'] = Transform("CXX")
638 main
['ASCOMSTR'] = Transform("AS")
639 main
['SWIGCOMSTR'] = Transform("SWIG")
640 main
['ARCOMSTR'] = Transform("AR", 0)
641 main
['LINKCOMSTR'] = Transform("LINK", 0)
642 main
['RANLIBCOMSTR'] = Transform("RANLIB", 0)
643 main
['M4COMSTR'] = Transform("M4")
644 main
['SHCCCOMSTR'] = Transform("SHCC")
645 main
['SHCXXCOMSTR'] = Transform("SHCXX")
648 # Initialize the Link-Time Optimization (LTO) flags
649 main
['LTO_CCFLAGS'] = []
650 main
['LTO_LDFLAGS'] = []
652 # According to the readme, tcmalloc works best if the compiler doesn't
653 # assume that we're using the builtin malloc and friends. These flags
654 # are compiler-specific, so we need to set them after we detect which
655 # compiler we're using.
656 main
['TCMALLOC_CCFLAGS'] = []
658 CXX_version
= readCommand([main
['CXX'],'--version'], exception
=False)
659 CXX_V
= readCommand([main
['CXX'],'-V'], exception
=False)
661 main
['GCC'] = CXX_version
and CXX_version
.find('g++') >= 0
662 main
['CLANG'] = CXX_version
and CXX_version
.find('clang') >= 0
663 if main
['GCC'] + main
['CLANG'] > 1:
664 print 'Error: How can we have two at the same time?'
667 # Set up default C++ compiler flags
668 if main
['GCC'] or main
['CLANG']:
669 # As gcc and clang share many flags, do the common parts here
670 main
.Append(CCFLAGS
=['-pipe'])
671 main
.Append(CCFLAGS
=['-fno-strict-aliasing'])
672 # Enable -Wall and -Wextra and then disable the few warnings that
673 # we consistently violate
674 main
.Append(CCFLAGS
=['-Wall', '-Wundef', '-Wextra',
675 '-Wno-sign-compare', '-Wno-unused-parameter'])
676 # We always compile using C++11
677 main
.Append(CXXFLAGS
=['-std=c++11'])
678 if sys
.platform
.startswith('freebsd'):
679 main
.Append(CCFLAGS
=['-I/usr/local/include'])
680 main
.Append(CXXFLAGS
=['-I/usr/local/include'])
682 print termcap
.Yellow
+ termcap
.Bold
+ 'Error' + termcap
.Normal
,
683 print "Don't know what compiler options to use for your compiler."
684 print termcap
.Yellow
+ ' compiler:' + termcap
.Normal
, main
['CXX']
685 print termcap
.Yellow
+ ' version:' + termcap
.Normal
,
687 print termcap
.Yellow
+ termcap
.Bold
+ "COMMAND NOT FOUND!" +\
690 print CXX_version
.replace('\n', '<nl>')
691 print " If you're trying to use a compiler other than GCC"
692 print " or clang, there appears to be something wrong with your"
693 print " environment."
695 print " If you are trying to use a compiler other than those listed"
696 print " above you will need to ease fix SConstruct and "
697 print " src/SConscript to support that compiler."
701 # Check for a supported version of gcc. >= 4.8 is chosen for its
702 # level of c++11 support. See
703 # http://gcc.gnu.org/projects/cxx0x.html for details.
704 gcc_version
= readCommand([main
['CXX'], '-dumpversion'], exception
=False)
705 if compareVersions(gcc_version
, "4.8") < 0:
706 print 'Error: gcc version 4.8 or newer required.'
707 print ' Installed version:', gcc_version
710 main
['GCC_VERSION'] = gcc_version
712 # gcc from version 4.8 and above generates "rep; ret" instructions
713 # to avoid performance penalties on certain AMD chips. Older
714 # assemblers detect this as an error, "Error: expecting string
715 # instruction after `rep'"
716 as_version_raw
= readCommand([main
['AS'], '-v', '/dev/null'],
717 exception
=False).split()
719 # version strings may contain extra distro-specific
720 # qualifiers, so play it safe and keep only what comes before
722 as_version
= as_version_raw
[-1].split('-')[0] if as_version_raw
else None
724 if not as_version
or compareVersions(as_version
, "2.23") < 0:
725 print termcap
.Yellow
+ termcap
.Bold
+ \
726 'Warning: This combination of gcc and binutils have' + \
727 ' known incompatibilities.\n' + \
728 ' If you encounter build problems, please update ' + \
729 'binutils to 2.23.' + \
732 # Make sure we warn if the user has requested to compile with the
733 # Undefined Benahvior Sanitizer and this version of gcc does not
735 if GetOption('with_ubsan') and \
736 compareVersions(gcc_version
, '4.9') < 0:
737 print termcap
.Yellow
+ termcap
.Bold
+ \
738 'Warning: UBSan is only supported using gcc 4.9 and later.' + \
741 # Add the appropriate Link-Time Optimization (LTO) flags
742 # unless LTO is explicitly turned off. Note that these flags
743 # are only used by the fast target.
744 if not GetOption('no_lto'):
745 # Pass the LTO flag when compiling to produce GIMPLE
746 # output, we merely create the flags here and only append
748 main
['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
750 # Use the same amount of jobs for LTO as we are running
752 main
['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
754 main
.Append(TCMALLOC_CCFLAGS
=['-fno-builtin-malloc', '-fno-builtin-calloc',
755 '-fno-builtin-realloc', '-fno-builtin-free'])
757 # add option to check for undeclared overrides
758 if compareVersions(gcc_version
, "5.0") > 0:
759 main
.Append(CCFLAGS
=['-Wno-error=suggest-override'])
762 # Check for a supported version of clang, >= 3.1 is needed to
763 # support similar features as gcc 4.8. See
764 # http://clang.llvm.org/cxx_status.html for details
765 clang_version_re
= re
.compile(".* version (\d+\.\d+)")
766 clang_version_match
= clang_version_re
.search(CXX_version
)
767 if (clang_version_match
):
768 clang_version
= clang_version_match
.groups()[0]
769 if compareVersions(clang_version
, "3.1") < 0:
770 print 'Error: clang version 3.1 or newer required.'
771 print ' Installed version:', clang_version
774 print 'Error: Unable to determine clang version.'
777 # clang has a few additional warnings that we disable, extraneous
778 # parantheses are allowed due to Ruby's printing of the AST,
779 # finally self assignments are allowed as the generated CPU code
781 main
.Append(CCFLAGS
=['-Wno-parentheses',
783 # Some versions of libstdc++ (4.8?) seem to
784 # use struct hash and class hash
786 '-Wno-mismatched-tags',
789 main
.Append(TCMALLOC_CCFLAGS
=['-fno-builtin'])
791 # On Mac OS X/Darwin we need to also use libc++ (part of XCode) as
792 # opposed to libstdc++, as the later is dated.
793 if sys
.platform
== "darwin":
794 main
.Append(CXXFLAGS
=['-stdlib=libc++'])
795 main
.Append(LIBS
=['c++'])
797 # On FreeBSD we need libthr.
798 if sys
.platform
.startswith('freebsd'):
799 main
.Append(LIBS
=['thr'])
802 print termcap
.Yellow
+ termcap
.Bold
+ 'Error' + termcap
.Normal
,
803 print "Don't know what compiler options to use for your compiler."
804 print termcap
.Yellow
+ ' compiler:' + termcap
.Normal
, main
['CXX']
805 print termcap
.Yellow
+ ' version:' + termcap
.Normal
,
807 print termcap
.Yellow
+ termcap
.Bold
+ "COMMAND NOT FOUND!" +\
810 print CXX_version
.replace('\n', '<nl>')
811 print " If you're trying to use a compiler other than GCC"
812 print " or clang, there appears to be something wrong with your"
813 print " environment."
815 print " If you are trying to use a compiler other than those listed"
816 print " above you will need to ease fix SConstruct and "
817 print " src/SConscript to support that compiler."
820 # Set up common yacc/bison flags (needed for Ruby)
821 main
['YACCFLAGS'] = '-d'
822 main
['YACCHXXFILESUFFIX'] = '.hh'
824 # Do this after we save setting back, or else we'll tack on an
825 # extra 'qdo' every time we run scons.
827 main
['CC'] = main
['BATCH_CMD'] + ' ' + main
['CC']
828 main
['CXX'] = main
['BATCH_CMD'] + ' ' + main
['CXX']
829 main
['AS'] = main
['BATCH_CMD'] + ' ' + main
['AS']
830 main
['AR'] = main
['BATCH_CMD'] + ' ' + main
['AR']
831 main
['RANLIB'] = main
['BATCH_CMD'] + ' ' + main
['RANLIB']
833 if sys
.platform
== 'cygwin':
834 # cygwin has some header file issues...
835 main
.Append(CCFLAGS
=["-Wno-uninitialized"])
837 # Check for the protobuf compiler
838 protoc_version
= readCommand([main
['PROTOC'], '--version'],
839 exception
='').split()
841 # First two words should be "libprotoc x.y.z"
842 if len(protoc_version
) < 2 or protoc_version
[0] != 'libprotoc':
843 print termcap
.Yellow
+ termcap
.Bold
+ \
844 'Warning: Protocol buffer compiler (protoc) not found.\n' + \
845 ' Please install protobuf-compiler for tracing support.' + \
847 main
['PROTOC'] = False
849 # Based on the availability of the compress stream wrappers,
851 min_protoc_version
= '2.1.0'
852 if compareVersions(protoc_version
[1], min_protoc_version
) < 0:
853 print termcap
.Yellow
+ termcap
.Bold
+ \
854 'Warning: protoc version', min_protoc_version
, \
855 'or newer required.\n' + \
856 ' Installed version:', protoc_version
[1], \
858 main
['PROTOC'] = False
860 # Attempt to determine the appropriate include path and
861 # library path using pkg-config, that means we also need to
862 # check for pkg-config. Note that it is possible to use
863 # protobuf without the involvement of pkg-config. Later on we
864 # check go a library config check and at that point the test
865 # will fail if libprotobuf cannot be found.
866 if readCommand(['pkg-config', '--version'], exception
=''):
868 # Attempt to establish what linking flags to add for protobuf
870 main
.ParseConfig('pkg-config --cflags --libs-only-L protobuf')
872 print termcap
.Yellow
+ termcap
.Bold
+ \
873 'Warning: pkg-config could not get protobuf flags.' + \
877 if not main
.has_key('SWIG'):
878 print 'Error: SWIG utility not found.'
879 print ' Please install (see http://www.swig.org) and retry.'
882 # Check for appropriate SWIG version
883 swig_version
= readCommand([main
['SWIG'], '-version'], exception
='').split()
884 # First 3 words should be "SWIG Version x.y.z"
885 if len(swig_version
) < 3 or \
886 swig_version
[0] != 'SWIG' or swig_version
[1] != 'Version':
887 print 'Error determining SWIG version.'
890 min_swig_version
= '2.0.4'
891 if compareVersions(swig_version
[2], min_swig_version
) < 0:
892 print 'Error: SWIG version', min_swig_version
, 'or newer required.'
893 print ' Installed version:', swig_version
[2]
896 # Check for known incompatibilities. The standard library shipped with
897 # gcc >= 4.9 does not play well with swig versions prior to 3.0
898 if main
['GCC'] and compareVersions(gcc_version
, '4.9') >= 0 and \
899 compareVersions(swig_version
[2], '3.0') < 0:
900 print termcap
.Yellow
+ termcap
.Bold
+ \
901 'Warning: This combination of gcc and swig have' + \
902 ' known incompatibilities.\n' + \
903 ' If you encounter build problems, please update ' + \
904 'swig to 3.0 or later.' + \
907 # Set up SWIG flags & scanner
908 swig_flags
=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
909 main
.Append(SWIGFLAGS
=swig_flags
)
911 # Check for 'timeout' from GNU coreutils. If present, regressions will
912 # be run with a time limit. We require version 8.13 since we rely on
913 # support for the '--foreground' option.
914 if sys
.platform
.startswith('freebsd'):
915 timeout_lines
= readCommand(['gtimeout', '--version'],
916 exception
='').splitlines()
918 timeout_lines
= readCommand(['timeout', '--version'],
919 exception
='').splitlines()
920 # Get the first line and tokenize it
921 timeout_version
= timeout_lines
[0].split() if timeout_lines
else []
922 main
['TIMEOUT'] = timeout_version
and \
923 compareVersions(timeout_version
[-1], '8.13') >= 0
925 # filter out all existing swig scanners, they mess up the dependency
926 # stuff for some reason
928 for scanner
in main
['SCANNERS']:
929 skeys
= scanner
.skeys
933 if isinstance(skeys
, (list, tuple)) and '.i' in skeys
:
936 scanners
.append(scanner
)
938 # add the new swig scanner that we like better
939 from SCons
.Scanner
import ClassicCPP
as CPPScanner
940 swig_inc_re
= '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
941 scanners
.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re
))
943 # replace the scanners list that has what we want
944 main
['SCANNERS'] = scanners
946 # Add a custom Check function to test for structure members.
947 def CheckMember(context
, include
, decl
, member
, include_quotes
="<>"):
948 context
.Message("Checking for member %s in %s..." %
954 (void)test.%(member)s;
957 """ % { "header" : include_quotes
[0] + include
+ include_quotes
[1],
962 ret
= context
.TryCompile(text
, extension
=".cc")
966 # Platform-specific configuration. Note again that we assume that all
967 # builds under a given build root run on the same host platform.
968 conf
= Configure(main
,
969 conf_dir
= joinpath(build_root
, '.scons_config'),
970 log_file
= joinpath(build_root
, 'scons_config.log'),
972 'CheckMember' : CheckMember
,
975 # Check if we should compile a 64 bit binary on Mac OS X/Darwin
978 uname
= platform
.uname()
979 if uname
[0] == 'Darwin' and compareVersions(uname
[2], '9.0.0') >= 0:
980 if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
981 main
.Append(CCFLAGS
=['-arch', 'x86_64'])
982 main
.Append(CFLAGS
=['-arch', 'x86_64'])
983 main
.Append(LINKFLAGS
=['-arch', 'x86_64'])
984 main
.Append(ASFLAGS
=['-arch', 'x86_64'])
988 # Recent versions of scons substitute a "Null" object for Configure()
989 # when configuration isn't necessary, e.g., if the "--help" option is
990 # present. Unfortuantely this Null object always returns false,
991 # breaking all our configuration checks. We replace it with our own
992 # more optimistic null object that returns True instead.
994 def NullCheck(*args
, **kwargs
):
998 def __init__(self
, env
):
1002 def __getattr__(self
, mname
):
1005 conf
= NullConf(main
)
1007 # Cache build files in the supplied directory.
1008 if main
['M5_BUILD_CACHE']:
1009 print 'Using build cache located at', main
['M5_BUILD_CACHE']
1010 CacheDir(main
['M5_BUILD_CACHE'])
1012 if not GetOption('without_python'):
1013 # Find Python include and library directories for embedding the
1014 # interpreter. We rely on python-config to resolve the appropriate
1015 # includes and linker flags. ParseConfig does not seem to understand
1016 # the more exotic linker flags such as -Xlinker and -export-dynamic so
1017 # we add them explicitly below. If you want to link in an alternate
1018 # version of python, see above for instructions on how to invoke
1019 # scons with the appropriate PATH set.
1021 # First we check if python2-config exists, else we use python-config
1022 python_config
= readCommand(['which', 'python2-config'],
1023 exception
='').strip()
1024 if not os
.path
.exists(python_config
):
1025 python_config
= readCommand(['which', 'python-config'],
1026 exception
='').strip()
1027 py_includes
= readCommand([python_config
, '--includes'],
1028 exception
='').split()
1029 # Strip the -I from the include folders before adding them to the
1031 main
.Append(CPPPATH
=map(lambda inc
: inc
[2:], py_includes
))
1033 # Read the linker flags and split them into libraries and other link
1034 # flags. The libraries are added later through the call the CheckLib.
1035 py_ld_flags
= readCommand([python_config
, '--ldflags'],
1036 exception
='').split()
1038 for lib
in py_ld_flags
:
1039 if not lib
.startswith('-l'):
1040 main
.Append(LINKFLAGS
=[lib
])
1043 if lib
not in py_libs
:
1046 # verify that this stuff works
1047 if not conf
.CheckHeader('Python.h', '<>'):
1048 print "Error: can't find Python.h header in", py_includes
1049 print "Install Python headers (package python-dev on Ubuntu and RedHat)"
1053 if not conf
.CheckLib(lib
):
1054 print "Error: can't find library %s required by python" % lib
1057 # On Solaris you need to use libsocket for socket ops
1058 if not conf
.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
1059 if not conf
.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
1060 print "Can't find library with socket calls (e.g. accept())"
1063 # Check for zlib. If the check passes, libz will be automatically
1064 # added to the LIBS environment variable.
1065 if not conf
.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
1066 print 'Error: did not find needed zlib compression library '\
1067 'and/or zlib.h header file.'
1068 print ' Please install zlib and try again.'
1071 # If we have the protobuf compiler, also make sure we have the
1072 # development libraries. If the check passes, libprotobuf will be
1073 # automatically added to the LIBS environment variable. After
1074 # this, we can use the HAVE_PROTOBUF flag to determine if we have
1075 # got both protoc and libprotobuf available.
1076 main
['HAVE_PROTOBUF'] = main
['PROTOC'] and \
1077 conf
.CheckLibWithHeader('protobuf', 'google/protobuf/message.h',
1078 'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;')
1080 # If we have the compiler but not the library, print another warning.
1081 if main
['PROTOC'] and not main
['HAVE_PROTOBUF']:
1082 print termcap
.Yellow
+ termcap
.Bold
+ \
1083 'Warning: did not find protocol buffer library and/or headers.\n' + \
1084 ' Please install libprotobuf-dev for tracing support.' + \
1088 have_posix_clock
= \
1089 conf
.CheckLibWithHeader(None, 'time.h', 'C',
1090 'clock_nanosleep(0,0,NULL,NULL);') or \
1091 conf
.CheckLibWithHeader('rt', 'time.h', 'C',
1092 'clock_nanosleep(0,0,NULL,NULL);')
1094 have_posix_timers
= \
1095 conf
.CheckLibWithHeader([None, 'rt'], [ 'time.h', 'signal.h' ], 'C',
1096 'timer_create(CLOCK_MONOTONIC, NULL, NULL);')
1098 if not GetOption('without_tcmalloc'):
1099 if conf
.CheckLib('tcmalloc'):
1100 main
.Append(CCFLAGS
=main
['TCMALLOC_CCFLAGS'])
1101 elif conf
.CheckLib('tcmalloc_minimal'):
1102 main
.Append(CCFLAGS
=main
['TCMALLOC_CCFLAGS'])
1104 print termcap
.Yellow
+ termcap
.Bold
+ \
1105 "You can get a 12% performance improvement by "\
1106 "installing tcmalloc (libgoogle-perftools-dev package "\
1107 "on Ubuntu or RedHat)." + termcap
.Normal
1110 # Detect back trace implementations. The last implementation in the
1111 # list will be used by default.
1112 backtrace_impls
= [ "none" ]
1114 if conf
.CheckLibWithHeader(None, 'execinfo.h', 'C',
1115 'backtrace_symbols_fd((void*)0, 0, 0);'):
1116 backtrace_impls
.append("glibc")
1117 elif conf
.CheckLibWithHeader('execinfo', 'execinfo.h', 'C',
1118 'backtrace_symbols_fd((void*)0, 0, 0);'):
1119 # NetBSD and FreeBSD need libexecinfo.
1120 backtrace_impls
.append("glibc")
1121 main
.Append(LIBS
=['execinfo'])
1123 if backtrace_impls
[-1] == "none":
1124 default_backtrace_impl
= "none"
1125 print termcap
.Yellow
+ termcap
.Bold
+ \
1126 "No suitable back trace implementation found." + \
1129 if not have_posix_clock
:
1130 print "Can't find library for POSIX clocks."
1132 # Check for <fenv.h> (C99 FP environment control)
1133 have_fenv
= conf
.CheckHeader('fenv.h', '<>')
1135 print "Warning: Header file <fenv.h> not found."
1136 print " This host has no IEEE FP rounding mode control."
1138 # Check if we should enable KVM-based hardware virtualization. The API
1139 # we rely on exists since version 2.6.36 of the kernel, but somehow
1140 # the KVM_API_VERSION does not reflect the change. We test for one of
1141 # the types as a fall back.
1142 have_kvm
= conf
.CheckHeader('linux/kvm.h', '<>')
1144 print "Info: Compatible header file <linux/kvm.h> not found, " \
1145 "disabling KVM support."
1147 # x86 needs support for xsave. We test for the structure here since we
1148 # won't be able to run new tests by the time we know which ISA we're
1150 have_kvm_xsave
= conf
.CheckTypeSize('struct kvm_xsave',
1151 '#include <linux/kvm.h>') != 0
1153 # Check if the requested target ISA is compatible with the host
1154 def is_isa_kvm_compatible(isa
):
1157 host_isa
= platform
.machine()
1159 print "Warning: Failed to determine host ISA."
1162 if not have_posix_timers
:
1163 print "Warning: Can not enable KVM, host seems to lack support " \
1168 return host_isa
in ( "armv7l", "aarch64" )
1170 if host_isa
!= "x86_64":
1173 if not have_kvm_xsave
:
1174 print "KVM on x86 requires xsave support in kernel headers."
1182 # Check if the exclude_host attribute is available. We want this to
1183 # get accurate instruction counts in KVM.
1184 main
['HAVE_PERF_ATTR_EXCLUDE_HOST'] = conf
.CheckMember(
1185 'linux/perf_event.h', 'struct perf_event_attr', 'exclude_host')
1188 ######################################################################
1190 # Finish the configuration
1192 main
= conf
.Finish()
1194 ######################################################################
1196 # Collect all non-global variables
1199 # Define the universe of supported ISAs
1201 all_gpu_isa_list
= [ ]
1202 Export('all_isa_list')
1203 Export('all_gpu_isa_list')
1205 class CpuModel(object):
1206 '''The CpuModel class encapsulates everything the ISA parser needs to
1207 know about a particular CPU model.'''
1209 # Dict of available CPU model objects. Accessible as CpuModel.dict.
1212 # Constructor. Automatically adds models to CpuModel.dict.
1213 def __init__(self
, name
, default
=False):
1214 self
.name
= name
# name of model
1216 # This cpu is enabled by default
1217 self
.default
= default
1220 if name
in CpuModel
.dict:
1221 raise AttributeError, "CpuModel '%s' already registered" % name
1222 CpuModel
.dict[name
] = self
1226 # Sticky variables get saved in the variables file so they persist from
1227 # one invocation to the next (unless overridden, in which case the new
1228 # value becomes sticky).
1229 sticky_vars
= Variables(args
=ARGUMENTS
)
1230 Export('sticky_vars')
1232 # Sticky variables that should be exported
1234 Export('export_vars')
1238 Export('all_protocols')
1240 Export('protocol_dirs')
1242 Export('slicc_includes')
1244 # Walk the tree and execute all SConsopts scripts that wil add to the
1246 if GetOption('verbose'):
1247 print "Reading SConsopts"
1248 for bdir
in [ base_dir
] + extras_dir_list
:
1250 print "Error: directory '%s' does not exist" % bdir
1252 for root
, dirs
, files
in os
.walk(bdir
):
1253 if 'SConsopts' in files
:
1254 if GetOption('verbose'):
1255 print "Reading", joinpath(root
, 'SConsopts')
1256 SConscript(joinpath(root
, 'SConsopts'))
1259 all_gpu_isa_list
.sort()
1261 sticky_vars
.AddVariables(
1262 EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list
),
1263 EnumVariable('TARGET_GPU_ISA', 'Target GPU ISA', 'hsail', all_gpu_isa_list
),
1264 ListVariable('CPU_MODELS', 'CPU models',
1265 sorted(n
for n
,m
in CpuModel
.dict.iteritems() if m
.default
),
1266 sorted(CpuModel
.dict.keys())),
1267 BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
1269 BoolVariable('SS_COMPATIBLE_FP',
1270 'Make floating-point results compatible with SimpleScalar',
1272 BoolVariable('USE_SSE2',
1273 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
1275 BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock
),
1276 BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv
),
1277 BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False),
1278 BoolVariable('USE_KVM', 'Enable hardware virtualized (KVM) CPU models', have_kvm
),
1279 BoolVariable('BUILD_GPU', 'Build the compute-GPU model', False),
1280 EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None',
1282 EnumVariable('BACKTRACE_IMPL', 'Post-mortem dump implementation',
1283 backtrace_impls
[-1], backtrace_impls
)
1286 # These variables get exported to #defines in config/*.hh (see src/SConscript).
1287 export_vars
+= ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'TARGET_GPU_ISA',
1288 'CP_ANNOTATE', 'USE_POSIX_CLOCK', 'USE_KVM', 'PROTOCOL',
1289 'HAVE_PROTOBUF', 'HAVE_PERF_ATTR_EXCLUDE_HOST']
1291 ###################################################
1293 # Define a SCons builder for configuration flag headers.
1295 ###################################################
1297 # This function generates a config header file that #defines the
1298 # variable symbol to the current variable setting (0 or 1). The source
1299 # operands are the name of the variable and a Value node containing the
1300 # value of the variable.
1301 def build_config_file(target
, source
, env
):
1302 (variable
, value
) = [s
.get_contents() for s
in source
]
1303 f
= file(str(target
[0]), 'w')
1304 print >> f
, '#define', variable
, value
1308 # Combine the two functions into a scons Action object.
1309 config_action
= MakeAction(build_config_file
, Transform("CONFIG H", 2))
1311 # The emitter munges the source & target node lists to reflect what
1312 # we're really doing.
1313 def config_emitter(target
, source
, env
):
1314 # extract variable name from Builder arg
1315 variable
= str(target
[0])
1316 # True target is config header file
1317 target
= joinpath('config', variable
.lower() + '.hh')
1319 if isinstance(val
, bool):
1320 # Force value to 0/1
1322 elif isinstance(val
, str):
1323 val
= '"' + val
+ '"'
1325 # Sources are variable name & value (packaged in SCons Value nodes)
1326 return ([target
], [Value(variable
), Value(val
)])
1328 config_builder
= Builder(emitter
= config_emitter
, action
= config_action
)
1330 main
.Append(BUILDERS
= { 'ConfigFile' : config_builder
})
1332 # libelf build is shared across all configs in the build root.
1333 main
.SConscript('ext/libelf/SConscript',
1334 variant_dir
= joinpath(build_root
, 'libelf'))
1336 # iostream3 build is shared across all configs in the build root.
1337 main
.SConscript('ext/iostream3/SConscript',
1338 variant_dir
= joinpath(build_root
, 'iostream3'))
1340 # libfdt build is shared across all configs in the build root.
1341 main
.SConscript('ext/libfdt/SConscript',
1342 variant_dir
= joinpath(build_root
, 'libfdt'))
1344 # fputils build is shared across all configs in the build root.
1345 main
.SConscript('ext/fputils/SConscript',
1346 variant_dir
= joinpath(build_root
, 'fputils'))
1348 # DRAMSim2 build is shared across all configs in the build root.
1349 main
.SConscript('ext/dramsim2/SConscript',
1350 variant_dir
= joinpath(build_root
, 'dramsim2'))
1352 # DRAMPower build is shared across all configs in the build root.
1353 main
.SConscript('ext/drampower/SConscript',
1354 variant_dir
= joinpath(build_root
, 'drampower'))
1356 # nomali build is shared across all configs in the build root.
1357 main
.SConscript('ext/nomali/SConscript',
1358 variant_dir
= joinpath(build_root
, 'nomali'))
1360 ###################################################
1362 # This function is used to set up a directory with switching headers
1364 ###################################################
1366 main
['ALL_ISA_LIST'] = all_isa_list
1367 main
['ALL_GPU_ISA_LIST'] = all_gpu_isa_list
1369 def make_switching_dir(dname
, switch_headers
, env
):
1370 # Generate the header. target[0] is the full path of the output
1371 # header to generate. 'source' is a dummy variable, since we get the
1372 # list of ISAs from env['ALL_ISA_LIST'].
1373 def gen_switch_hdr(target
, source
, env
):
1374 fname
= str(target
[0])
1375 isa
= env
['TARGET_ISA'].lower()
1377 f
= open(fname
, 'w')
1378 print >>f
, '#include "%s/%s/%s"' % (dname
, isa
, basename(fname
))
1381 print "Failed to create %s" % fname
1384 # Build SCons Action object. 'varlist' specifies env vars that this
1385 # action depends on; when env['ALL_ISA_LIST'] changes these actions
1386 # should get re-executed.
1387 switch_hdr_action
= MakeAction(gen_switch_hdr
,
1388 Transform("GENERATE"), varlist
=['ALL_ISA_LIST'])
1390 # Instantiate actions for each header
1391 for hdr
in switch_headers
:
1392 env
.Command(hdr
, [], switch_hdr_action
)
1394 isa_target
= Dir('.').up().name
.lower().replace('_', '-')
1395 env
['PHONY_BASE'] = '#'+isa_target
1396 all_isa_deps
[isa_target
] = None
1398 Export('make_switching_dir')
1400 def make_gpu_switching_dir(dname
, switch_headers
, env
):
1401 # Generate the header. target[0] is the full path of the output
1402 # header to generate. 'source' is a dummy variable, since we get the
1403 # list of ISAs from env['ALL_ISA_LIST'].
1404 def gen_switch_hdr(target
, source
, env
):
1405 fname
= str(target
[0])
1407 isa
= env
['TARGET_GPU_ISA'].lower()
1410 f
= open(fname
, 'w')
1411 print >>f
, '#include "%s/%s/%s"' % (dname
, isa
, basename(fname
))
1414 print "Failed to create %s" % fname
1417 # Build SCons Action object. 'varlist' specifies env vars that this
1418 # action depends on; when env['ALL_ISA_LIST'] changes these actions
1419 # should get re-executed.
1420 switch_hdr_action
= MakeAction(gen_switch_hdr
,
1421 Transform("GENERATE"), varlist
=['ALL_ISA_GPU_LIST'])
1423 # Instantiate actions for each header
1424 for hdr
in switch_headers
:
1425 env
.Command(hdr
, [], switch_hdr_action
)
1427 Export('make_gpu_switching_dir')
1429 # all-isas -> all-deps -> all-environs -> all_targets
1430 main
.Alias('#all-isas', [])
1431 main
.Alias('#all-deps', '#all-isas')
1433 # Dummy target to ensure all environments are created before telling
1434 # SCons what to actually make (the command line arguments). We attach
1435 # them to the dependence graph after the environments are complete.
1436 ORIG_BUILD_TARGETS
= list(BUILD_TARGETS
) # force a copy; gets closure to work.
1437 def environsComplete(target
, source
, env
):
1438 for t
in ORIG_BUILD_TARGETS
:
1439 main
.Depends('#all-targets', t
)
1441 # Each build/* switching_dir attaches its *-environs target to #all-environs.
1442 main
.Append(BUILDERS
= {'CompleteEnvirons' :
1443 Builder(action
=MakeAction(environsComplete
, None))})
1444 main
.CompleteEnvirons('#all-environs', [])
1446 def doNothing(**ignored
): pass
1447 main
.Append(BUILDERS
= {'Dummy': Builder(action
=MakeAction(doNothing
, None))})
1449 # The final target to which all the original targets ultimately get attached.
1450 main
.Dummy('#all-targets', '#all-environs')
1451 BUILD_TARGETS
[:] = ['#all-targets']
1453 ###################################################
1455 # Define build environments for selected configurations.
1457 ###################################################
1459 for variant_path
in variant_paths
:
1460 if not GetOption('silent'):
1461 print "Building in", variant_path
1463 # Make a copy of the build-root environment to use for this config.
1465 env
['BUILDDIR'] = variant_path
1467 # variant_dir is the tail component of build path, and is used to
1468 # determine the build parameters (e.g., 'ALPHA_SE')
1469 (build_root
, variant_dir
) = splitpath(variant_path
)
1471 # Set env variables according to the build directory config.
1472 sticky_vars
.files
= []
1473 # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
1474 # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
1475 # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
1476 current_vars_file
= joinpath(build_root
, 'variables', variant_dir
)
1477 if isfile(current_vars_file
):
1478 sticky_vars
.files
.append(current_vars_file
)
1479 if not GetOption('silent'):
1480 print "Using saved variables file %s" % current_vars_file
1482 # Build dir-specific variables file doesn't exist.
1484 # Make sure the directory is there so we can create it later
1485 opt_dir
= dirname(current_vars_file
)
1486 if not isdir(opt_dir
):
1489 # Get default build variables from source tree. Variables are
1490 # normally determined by name of $VARIANT_DIR, but can be
1491 # overridden by '--default=' arg on command line.
1492 default
= GetOption('default')
1493 opts_dir
= joinpath(main
.root
.abspath
, 'build_opts')
1495 default_vars_files
= [joinpath(build_root
, 'variables', default
),
1496 joinpath(opts_dir
, default
)]
1498 default_vars_files
= [joinpath(opts_dir
, variant_dir
)]
1499 existing_files
= filter(isfile
, default_vars_files
)
1501 default_vars_file
= existing_files
[0]
1502 sticky_vars
.files
.append(default_vars_file
)
1503 print "Variables file %s not found,\n using defaults in %s" \
1504 % (current_vars_file
, default_vars_file
)
1506 print "Error: cannot find variables file %s or " \
1507 "default file(s) %s" \
1508 % (current_vars_file
, ' or '.join(default_vars_files
))
1511 # Apply current variable settings to env
1512 sticky_vars
.Update(env
)
1514 help_texts
["local_vars"] += \
1515 "Build variables for %s:\n" % variant_dir \
1516 + sticky_vars
.GenerateHelpText(env
)
1518 # Process variable settings.
1520 if not have_fenv
and env
['USE_FENV']:
1521 print "Warning: <fenv.h> not available; " \
1522 "forcing USE_FENV to False in", variant_dir
+ "."
1523 env
['USE_FENV'] = False
1525 if not env
['USE_FENV']:
1526 print "Warning: No IEEE FP rounding mode control in", variant_dir
+ "."
1527 print " FP results may deviate slightly from other platforms."
1530 env
.Append(LIBS
=['efence'])
1534 print "Warning: Can not enable KVM, host seems to lack KVM support"
1535 env
['USE_KVM'] = False
1536 elif not is_isa_kvm_compatible(env
['TARGET_ISA']):
1537 print "Info: KVM support disabled due to unsupported host and " \
1538 "target ISA combination"
1539 env
['USE_KVM'] = False
1541 if env
['BUILD_GPU']:
1542 env
.Append(CPPDEFINES
=['BUILD_GPU'])
1544 # Warn about missing optional functionality
1546 if not main
['HAVE_PERF_ATTR_EXCLUDE_HOST']:
1547 print "Warning: perf_event headers lack support for the " \
1548 "exclude_host attribute. KVM instruction counts will " \
1551 # Save sticky variable settings back to current variables file
1552 sticky_vars
.Save(current_vars_file
, env
)
1555 env
.Append(CCFLAGS
=['-msse2'])
1557 # The src/SConscript file sets up the build rules in 'env' according
1558 # to the configured variables. It returns a list of environments,
1559 # one for each variant build (debug, opt, etc.)
1560 SConscript('src/SConscript', variant_dir
= variant_path
, exports
= 'env')
1562 def pairwise(iterable
):
1563 "s -> (s0,s1), (s1,s2), (s2, s3), ..."
1564 a
, b
= itertools
.tee(iterable
)
1566 return itertools
.izip(a
, b
)
1568 # Create false dependencies so SCons will parse ISAs, establish
1569 # dependencies, and setup the build Environments serially. Either
1570 # SCons (likely) and/or our SConscripts (possibly) cannot cope with -j
1571 # greater than 1. It appears to be standard race condition stuff; it
1572 # doesn't always fail, but usually, and the behaviors are different.
1573 # Every time I tried to remove this, builds would fail in some
1574 # creative new way. So, don't do that. You'll want to, though, because
1575 # tests/SConscript takes a long time to make its Environments.
1576 for t1
, t2
in pairwise(sorted(all_isa_deps
.iterkeys())):
1577 main
.Depends('#%s-deps' % t2
, '#%s-deps' % t1
)
1578 main
.Depends('#%s-environs' % t2
, '#%s-environs' % t1
)
1582 Usage: scons [scons options] [build variables] [target(s)]
1584 Extra scons options:
1587 Global build variables: