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('--force-lto', dest
='force_lto', action
='store_true',
187 help='Use Link-Time Optimization instead of partial linking' +
188 ' when the compiler doesn\'t support using them together.')
189 AddLocalOption('--update-ref', dest
='update_ref', action
='store_true',
190 help='Update test reference outputs')
191 AddLocalOption('--verbose', dest
='verbose', action
='store_true',
192 help='Print full tool command lines')
193 AddLocalOption('--without-python', dest
='without_python',
195 help='Build without Python configuration support')
196 AddLocalOption('--without-tcmalloc', dest
='without_tcmalloc',
198 help='Disable linking against tcmalloc')
199 AddLocalOption('--with-ubsan', dest
='with_ubsan', action
='store_true',
200 help='Build with Undefined Behavior Sanitizer if available')
201 AddLocalOption('--with-asan', dest
='with_asan', action
='store_true',
202 help='Build with Address Sanitizer if available')
204 if GetOption('no_lto') and GetOption('force_lto'):
205 print '--no-lto and --force-lto are mutually exclusive'
208 termcap
= get_termcap(GetOption('use_colors'))
210 ########################################################################
212 # Set up the main build environment.
214 ########################################################################
216 # export TERM so that clang reports errors in color
217 use_vars
= set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH',
218 'LIBRARY_PATH', 'PATH', 'PKG_CONFIG_PATH', 'PROTOC',
219 'PYTHONPATH', 'RANLIB', 'TERM' ])
222 "ASAN_", # address sanitizer symbolizer path and settings
223 "CCACHE_", # ccache (caching compiler wrapper) configuration
224 "CCC_", # clang static analyzer configuration
225 "DISTCC_", # distcc (distributed compiler wrapper) configuration
226 "INCLUDE_SERVER_", # distcc pump server settings
227 "M5", # M5 configuration (e.g., path to kernels)
231 for key
,val
in sorted(os
.environ
.iteritems()):
232 if key
in use_vars
or \
233 any([key
.startswith(prefix
) for prefix
in use_prefixes
]):
236 # Tell scons to avoid implicit command dependencies to avoid issues
237 # with the param wrappes being compiled twice (see
238 # http://scons.tigris.org/issues/show_bug.cgi?id=2811)
239 main
= Environment(ENV
=use_env
, IMPLICIT_COMMAND_DEPENDENCIES
=0)
240 main
.Decider('MD5-timestamp')
241 main
.root
= Dir(".") # The current directory (where this file lives).
242 main
.srcdir
= Dir("src") # The source directory
244 main_dict_keys
= main
.Dictionary().keys()
246 # Check that we have a C/C++ compiler
247 if not ('CC' in main_dict_keys
and 'CXX' in main_dict_keys
):
248 print "No C++ compiler installed (package g++ on Ubuntu and RedHat)"
251 # add useful python code PYTHONPATH so it can be used by subprocesses
253 main
.AppendENVPath('PYTHONPATH', extra_python_paths
)
255 ########################################################################
259 # If the gem5 directory is a mercurial repository, we should do some
262 ########################################################################
264 hgdir
= main
.root
.Dir(".hg")
268 You're missing the gem5 style hook, which automatically checks your code
269 against the gem5 style rules on %s.
270 This script will now install the hook in your %s.
271 Press enter to continue, or ctrl-c to abort: """
273 mercurial_style_message
= """
274 You're missing the gem5 style hook, which automatically checks your code
275 against the gem5 style rules on hg commit and qrefresh commands.
276 This script will now install the hook in your .hg/hgrc file.
277 Press enter to continue, or ctrl-c to abort: """
279 git_style_message
= """
280 You're missing the gem5 style or commit message hook. These hooks help
281 to ensure that your code follows gem5's style rules on git commit.
282 This script will now install the hook in your .git/hooks/ directory.
283 Press enter to continue, or ctrl-c to abort: """
285 mercurial_style_upgrade_message
= """
286 Your Mercurial style hooks are not up-to-date. This script will now
287 try to automatically update them. A backup of your hgrc will be saved
289 Press enter to continue, or ctrl-c to abort: """
291 mercurial_style_hook
= """
292 # The following lines were automatically added by gem5/SConstruct
293 # to provide the gem5 style-checking hooks
295 hgstyle = %s/util/hgstyle.py
298 pretxncommit.style = python:hgstyle.check_style
299 pre-qrefresh.style = python:hgstyle.check_style
300 # End of SConstruct additions
302 """ % (main
.root
.abspath
)
304 mercurial_lib_not_found
= """
305 Mercurial libraries cannot be found, ignoring style hook. If
306 you are a gem5 developer, please fix this and run the style
307 hook. It is important.
310 # Check for style hook and prompt for installation if it's not there.
311 # Skip this if --ignore-style was specified, there's no interactive
312 # terminal to prompt, or no recognized revision control system can be
314 ignore_style
= GetOption('ignore_style') or not sys
.stdin
.isatty()
316 # Try wire up Mercurial to the style hooks
317 if not ignore_style
and hgdir
.exists():
319 style_hooks
= tuple()
320 hgrc
= hgdir
.File('hgrc')
321 hgrc_old
= hgdir
.File('hgrc.old')
323 from mercurial
import ui
325 ui
.readconfig(hgrc
.abspath
)
326 style_hooks
= (ui
.config('hooks', 'pretxncommit.style', None),
327 ui
.config('hooks', 'pre-qrefresh.style', None))
328 style_hook
= all(style_hooks
)
329 style_extension
= ui
.config('extensions', 'style', None)
331 print mercurial_lib_not_found
333 if "python:style.check_style" in style_hooks
:
334 # Try to upgrade the style hooks
335 print mercurial_style_upgrade_message
336 # continue unless user does ctrl-c/ctrl-d etc.
340 print "Input exception, exiting scons.\n"
342 shutil
.copyfile(hgrc
.abspath
, hgrc_old
.abspath
)
343 re_style_hook
= re
.compile(r
"^([^=#]+)\.style\s*=\s*([^#\s]+).*")
344 re_style_extension
= re
.compile("style\s*=\s*([^#\s]+).*")
345 old
, new
= open(hgrc_old
.abspath
, 'r'), open(hgrc
.abspath
, 'w')
347 m_hook
= re_style_hook
.match(l
)
348 m_ext
= re_style_extension
.match(l
)
350 hook
, check
= m_hook
.groups()
351 if check
!= "python:style.check_style":
352 print "Warning: %s.style is using a non-default " \
353 "checker: %s" % (hook
, check
)
354 if hook
not in ("pretxncommit", "pre-qrefresh"):
355 print "Warning: Updating unknown style hook: %s" % hook
357 l
= "%s.style = python:hgstyle.check_style\n" % hook
358 elif m_ext
and m_ext
.group(1) == style_extension
:
359 l
= "hgstyle = %s/util/hgstyle.py\n" % main
.root
.abspath
363 print mercurial_style_message
,
364 # continue unless user does ctrl-c/ctrl-d etc.
368 print "Input exception, exiting scons.\n"
370 hgrc_path
= '%s/.hg/hgrc' % main
.root
.abspath
371 print "Adding style hook to", hgrc_path
, "\n"
373 with
open(hgrc_path
, 'a') as f
:
374 f
.write(mercurial_style_hook
)
376 print "Error updating", hgrc_path
379 def install_git_style_hooks():
381 gitdir
= Dir(readCommand(
382 ["git", "rev-parse", "--git-dir"]).strip("\n"))
384 print "Warning: Failed to find git repo directory: %s" % e
387 git_hooks
= gitdir
.Dir("hooks")
388 def hook_exists(hook_name
):
389 hook
= git_hooks
.File(hook_name
)
392 def hook_install(hook_name
, script
):
393 hook
= git_hooks
.File(hook_name
)
395 print "Warning: Can't install %s, hook already exists." % hook_name
399 print "Warning: Removing broken symlink for hook %s." % hook_name
400 os
.unlink(hook
.get_abspath())
402 if not git_hooks
.exists():
403 mkdir(git_hooks
.get_abspath())
406 abs_symlink_hooks
= git_hooks
.islink() and \
407 os
.path
.isabs(os
.readlink(git_hooks
.get_abspath()))
409 # Use a relative symlink if the hooks live in the source directory,
410 # and the hooks directory is not a symlink to an absolute path.
411 if hook
.is_under(main
.root
) and not abs_symlink_hooks
:
412 script_path
= os
.path
.relpath(
413 os
.path
.realpath(script
.get_abspath()),
414 os
.path
.realpath(hook
.Dir(".").get_abspath()))
416 script_path
= script
.get_abspath()
419 os
.symlink(script_path
, hook
.get_abspath())
421 print "Error updating git %s hook" % hook_name
424 if hook_exists("pre-commit") and hook_exists("commit-msg"):
427 print git_style_message
,
431 print "Input exception, exiting scons.\n"
434 git_style_script
= File("util/git-pre-commit.py")
435 git_msg_script
= File("ext/git-commit-msg")
437 hook_install("pre-commit", git_style_script
)
438 hook_install("commit-msg", git_msg_script
)
440 # Try to wire up git to the style hooks
441 if not ignore_style
and main
.root
.Entry(".git").exists():
442 install_git_style_hooks()
444 ###################################################
446 # Figure out which configurations to set up based on the path(s) of
449 ###################################################
451 # Find default configuration & binary.
452 Default(environ
.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug'))
454 # helper function: find last occurrence of element in list
455 def rfind(l
, elt
, offs
= -1):
456 for i
in range(len(l
)+offs
, 0, -1):
459 raise ValueError, "element not found"
461 # Take a list of paths (or SCons Nodes) and return a list with all
462 # paths made absolute and ~-expanded. Paths will be interpreted
463 # relative to the launch directory unless a different root is provided
464 def makePathListAbsolute(path_list
, root
=GetLaunchDir()):
465 return [abspath(joinpath(root
, expanduser(str(p
))))
468 # Each target must have 'build' in the interior of the path; the
469 # directory below this will determine the build parameters. For
470 # example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
471 # recognize that ALPHA_SE specifies the configuration because it
472 # follow 'build' in the build path.
474 # The funky assignment to "[:]" is needed to replace the list contents
475 # in place rather than reassign the symbol to a new list, which
476 # doesn't work (obviously!).
477 BUILD_TARGETS
[:] = makePathListAbsolute(BUILD_TARGETS
)
479 # Generate a list of the unique build roots and configs that the
480 # collected targets reference.
483 for t
in BUILD_TARGETS
:
484 path_dirs
= t
.split('/')
486 build_top
= rfind(path_dirs
, 'build', -2)
488 print "Error: no non-leaf 'build' dir found on target path", t
490 this_build_root
= joinpath('/',*path_dirs
[:build_top
+1])
492 build_root
= this_build_root
494 if this_build_root
!= build_root
:
495 print "Error: build targets not under same build root\n"\
496 " %s\n %s" % (build_root
, this_build_root
)
498 variant_path
= joinpath('/',*path_dirs
[:build_top
+2])
499 if variant_path
not in variant_paths
:
500 variant_paths
.append(variant_path
)
502 # Make sure build_root exists (might not if this is the first build there)
503 if not isdir(build_root
):
505 main
['BUILDROOT'] = build_root
509 main
.SConsignFile(joinpath(build_root
, "sconsign"))
511 # Default duplicate option is to use hard links, but this messes up
512 # when you use emacs to edit a file in the target dir, as emacs moves
513 # file to file~ then copies to file, breaking the link. Symbolic
514 # (soft) links work better.
515 main
.SetOption('duplicate', 'soft-copy')
518 # Set up global sticky variables... these are common to an entire build
519 # tree (not specific to a particular build like ALPHA_SE)
522 global_vars_file
= joinpath(build_root
, 'variables.global')
524 global_vars
= Variables(global_vars_file
, args
=ARGUMENTS
)
526 global_vars
.AddVariables(
527 ('CC', 'C compiler', environ
.get('CC', main
['CC'])),
528 ('CXX', 'C++ compiler', environ
.get('CXX', main
['CXX'])),
529 ('PROTOC', 'protoc tool', environ
.get('PROTOC', 'protoc')),
530 ('BATCH', 'Use batch pool for build and tests', False),
531 ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
532 ('M5_BUILD_CACHE', 'Cache built objects in this directory', False),
533 ('EXTRAS', 'Add extra directories to the compilation', '')
536 # Update main environment with values from ARGUMENTS & global_vars_file
537 global_vars
.Update(main
)
538 help_texts
["global_vars"] += global_vars
.GenerateHelpText(main
)
540 # Save sticky variable settings back to current variables file
541 global_vars
.Save(global_vars_file
, main
)
543 # Parse EXTRAS variable to build list of all directories where we're
544 # look for sources etc. This list is exported as extras_dir_list.
545 base_dir
= main
.srcdir
.abspath
547 extras_dir_list
= makePathListAbsolute(main
['EXTRAS'].split(':'))
552 Export('extras_dir_list')
554 # the ext directory should be on the #includes path
555 main
.Append(CPPPATH
=[Dir('ext')])
557 def strip_build_path(path
, env
):
559 variant_base
= env
['BUILDROOT'] + os
.path
.sep
560 if path
.startswith(variant_base
):
561 path
= path
[len(variant_base
):]
562 elif path
.startswith('build/'):
566 # Generate a string of the form:
567 # common/path/prefix/src1, src2 -> tgt1, tgt2
568 # to print while building.
569 class Transform(object):
570 # all specific color settings should be here and nowhere else
571 tool_color
= termcap
.Normal
572 pfx_color
= termcap
.Yellow
573 srcs_color
= termcap
.Yellow
+ termcap
.Bold
574 arrow_color
= termcap
.Blue
+ termcap
.Bold
575 tgts_color
= termcap
.Yellow
+ termcap
.Bold
577 def __init__(self
, tool
, max_sources
=99):
578 self
.format
= self
.tool_color
+ (" [%8s] " % tool
) \
579 + self
.pfx_color
+ "%s" \
580 + self
.srcs_color
+ "%s" \
581 + self
.arrow_color
+ " -> " \
582 + self
.tgts_color
+ "%s" \
584 self
.max_sources
= max_sources
586 def __call__(self
, target
, source
, env
, for_signature
=None):
587 # truncate source list according to max_sources param
588 source
= source
[0:self
.max_sources
]
590 return strip_build_path(str(f
), env
)
592 srcs
= map(strip
, source
)
595 tgts
= map(strip
, target
)
596 # surprisingly, os.path.commonprefix is a dumb char-by-char string
597 # operation that has nothing to do with paths.
598 com_pfx
= os
.path
.commonprefix(srcs
+ tgts
)
599 com_pfx_len
= len(com_pfx
)
601 # do some cleanup and sanity checking on common prefix
602 if com_pfx
[-1] == ".":
603 # prefix matches all but file extension: ok
604 # back up one to change 'foo.cc -> o' to 'foo.cc -> .o'
605 com_pfx
= com_pfx
[0:-1]
606 elif com_pfx
[-1] == "/":
607 # common prefix is directory path: OK
610 src0_len
= len(srcs
[0])
611 tgt0_len
= len(tgts
[0])
612 if src0_len
== com_pfx_len
:
613 # source is a substring of target, OK
615 elif tgt0_len
== com_pfx_len
:
616 # target is a substring of source, need to back up to
617 # avoid empty string on RHS of arrow
618 sep_idx
= com_pfx
.rfind(".")
620 com_pfx
= com_pfx
[0:sep_idx
]
623 elif src0_len
> com_pfx_len
and srcs
[0][com_pfx_len
] == ".":
624 # still splitting at file extension: ok
627 # probably a fluke; ignore it
629 # recalculate length in case com_pfx was modified
630 com_pfx_len
= len(com_pfx
)
632 f
= map(lambda s
: s
[com_pfx_len
:], files
)
634 return self
.format
% (com_pfx
, fmt(srcs
), fmt(tgts
))
638 # enable the regression script to use the termcap
639 main
['TERMCAP'] = termcap
641 if GetOption('verbose'):
642 def MakeAction(action
, string
, *args
, **kwargs
):
643 return Action(action
, *args
, **kwargs
)
646 main
['CCCOMSTR'] = Transform("CC")
647 main
['CXXCOMSTR'] = Transform("CXX")
648 main
['ASCOMSTR'] = Transform("AS")
649 main
['ARCOMSTR'] = Transform("AR", 0)
650 main
['LINKCOMSTR'] = Transform("LINK", 0)
651 main
['SHLINKCOMSTR'] = Transform("SHLINK", 0)
652 main
['RANLIBCOMSTR'] = Transform("RANLIB", 0)
653 main
['M4COMSTR'] = Transform("M4")
654 main
['SHCCCOMSTR'] = Transform("SHCC")
655 main
['SHCXXCOMSTR'] = Transform("SHCXX")
658 # Initialize the Link-Time Optimization (LTO) flags
659 main
['LTO_CCFLAGS'] = []
660 main
['LTO_LDFLAGS'] = []
662 # According to the readme, tcmalloc works best if the compiler doesn't
663 # assume that we're using the builtin malloc and friends. These flags
664 # are compiler-specific, so we need to set them after we detect which
665 # compiler we're using.
666 main
['TCMALLOC_CCFLAGS'] = []
668 CXX_version
= readCommand([main
['CXX'],'--version'], exception
=False)
669 CXX_V
= readCommand([main
['CXX'],'-V'], exception
=False)
671 main
['GCC'] = CXX_version
and CXX_version
.find('g++') >= 0
672 main
['CLANG'] = CXX_version
and CXX_version
.find('clang') >= 0
673 if main
['GCC'] + main
['CLANG'] > 1:
674 print 'Error: How can we have two at the same time?'
677 # Set up default C++ compiler flags
678 if main
['GCC'] or main
['CLANG']:
679 # As gcc and clang share many flags, do the common parts here
680 main
.Append(CCFLAGS
=['-pipe'])
681 main
.Append(CCFLAGS
=['-fno-strict-aliasing'])
682 # Enable -Wall and -Wextra and then disable the few warnings that
683 # we consistently violate
684 main
.Append(CCFLAGS
=['-Wall', '-Wundef', '-Wextra',
685 '-Wno-sign-compare', '-Wno-unused-parameter'])
686 # We always compile using C++11
687 main
.Append(CXXFLAGS
=['-std=c++11'])
688 if sys
.platform
.startswith('freebsd'):
689 main
.Append(CCFLAGS
=['-I/usr/local/include'])
690 main
.Append(CXXFLAGS
=['-I/usr/local/include'])
692 main
['FILTER_PSHLINKFLAGS'] = lambda x
: str(x
).replace(' -shared', '')
693 main
['PSHLINKFLAGS'] = main
.subst('${FILTER_PSHLINKFLAGS(SHLINKFLAGS)}')
694 main
['PLINKFLAGS'] = main
.subst('${LINKFLAGS}')
695 shared_partial_flags
= ['-r', '-nostdlib']
696 main
.Append(PSHLINKFLAGS
=shared_partial_flags
)
697 main
.Append(PLINKFLAGS
=shared_partial_flags
)
699 print termcap
.Yellow
+ termcap
.Bold
+ 'Error' + termcap
.Normal
,
700 print "Don't know what compiler options to use for your compiler."
701 print termcap
.Yellow
+ ' compiler:' + termcap
.Normal
, main
['CXX']
702 print termcap
.Yellow
+ ' version:' + termcap
.Normal
,
704 print termcap
.Yellow
+ termcap
.Bold
+ "COMMAND NOT FOUND!" +\
707 print CXX_version
.replace('\n', '<nl>')
708 print " If you're trying to use a compiler other than GCC"
709 print " or clang, there appears to be something wrong with your"
710 print " environment."
712 print " If you are trying to use a compiler other than those listed"
713 print " above you will need to ease fix SConstruct and "
714 print " src/SConscript to support that compiler."
718 # Check for a supported version of gcc. >= 4.8 is chosen for its
719 # level of c++11 support. See
720 # http://gcc.gnu.org/projects/cxx0x.html for details.
721 gcc_version
= readCommand([main
['CXX'], '-dumpversion'], exception
=False)
722 if compareVersions(gcc_version
, "4.8") < 0:
723 print 'Error: gcc version 4.8 or newer required.'
724 print ' Installed version:', gcc_version
727 main
['GCC_VERSION'] = gcc_version
729 if compareVersions(gcc_version
, '4.9') >= 0:
730 # Incremental linking with LTO is currently broken in gcc versions
731 # 4.9 and above. A version where everything works completely hasn't
732 # yet been identified.
734 # https://gcc.gnu.org/bugzilla/show_bug.cgi?id=67548
735 main
['BROKEN_INCREMENTAL_LTO'] = True
736 if compareVersions(gcc_version
, '6.0') >= 0:
737 # gcc versions 6.0 and greater accept an -flinker-output flag which
738 # selects what type of output the linker should generate. This is
739 # necessary for incremental lto to work, but is also broken in
740 # current versions of gcc. It may not be necessary in future
741 # versions. We add it here since it might be, and as a reminder that
742 # it exists. It's excluded if lto is being forced.
744 # https://gcc.gnu.org/gcc-6/changes.html
745 # https://gcc.gnu.org/ml/gcc-patches/2015-11/msg03161.html
746 # https://gcc.gnu.org/bugzilla/show_bug.cgi?id=69866
747 if not GetOption('force_lto'):
748 main
.Append(PSHLINKFLAGS
='-flinker-output=rel')
749 main
.Append(PLINKFLAGS
='-flinker-output=rel')
751 # gcc from version 4.8 and above generates "rep; ret" instructions
752 # to avoid performance penalties on certain AMD chips. Older
753 # assemblers detect this as an error, "Error: expecting string
754 # instruction after `rep'"
755 as_version_raw
= readCommand([main
['AS'], '-v', '/dev/null',
757 exception
=False).split()
759 # version strings may contain extra distro-specific
760 # qualifiers, so play it safe and keep only what comes before
762 as_version
= as_version_raw
[-1].split('-')[0] if as_version_raw
else None
764 if not as_version
or compareVersions(as_version
, "2.23") < 0:
765 print termcap
.Yellow
+ termcap
.Bold
+ \
766 'Warning: This combination of gcc and binutils have' + \
767 ' known incompatibilities.\n' + \
768 ' If you encounter build problems, please update ' + \
769 'binutils to 2.23.' + \
772 # Make sure we warn if the user has requested to compile with the
773 # Undefined Benahvior Sanitizer and this version of gcc does not
775 if GetOption('with_ubsan') and \
776 compareVersions(gcc_version
, '4.9') < 0:
777 print termcap
.Yellow
+ termcap
.Bold
+ \
778 'Warning: UBSan is only supported using gcc 4.9 and later.' + \
781 disable_lto
= GetOption('no_lto')
782 if not disable_lto
and main
.get('BROKEN_INCREMENTAL_LTO', False) and \
783 not GetOption('force_lto'):
784 print termcap
.Yellow
+ termcap
.Bold
+ \
785 'Warning: Your compiler doesn\'t support incremental linking' + \
786 ' and lto at the same time, so lto is being disabled. To force' + \
787 ' lto on anyway, use the --force-lto option. That will disable' + \
788 ' partial linking.' + \
792 # Add the appropriate Link-Time Optimization (LTO) flags
793 # unless LTO is explicitly turned off. Note that these flags
794 # are only used by the fast target.
796 # Pass the LTO flag when compiling to produce GIMPLE
797 # output, we merely create the flags here and only append
799 main
['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
801 # Use the same amount of jobs for LTO as we are running
803 main
['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
805 main
.Append(TCMALLOC_CCFLAGS
=['-fno-builtin-malloc', '-fno-builtin-calloc',
806 '-fno-builtin-realloc', '-fno-builtin-free'])
808 # add option to check for undeclared overrides
809 if compareVersions(gcc_version
, "5.0") > 0:
810 main
.Append(CCFLAGS
=['-Wno-error=suggest-override'])
813 # Check for a supported version of clang, >= 3.1 is needed to
814 # support similar features as gcc 4.8. See
815 # http://clang.llvm.org/cxx_status.html for details
816 clang_version_re
= re
.compile(".* version (\d+\.\d+)")
817 clang_version_match
= clang_version_re
.search(CXX_version
)
818 if (clang_version_match
):
819 clang_version
= clang_version_match
.groups()[0]
820 if compareVersions(clang_version
, "3.1") < 0:
821 print 'Error: clang version 3.1 or newer required.'
822 print ' Installed version:', clang_version
825 print 'Error: Unable to determine clang version.'
828 # clang has a few additional warnings that we disable, extraneous
829 # parantheses are allowed due to Ruby's printing of the AST,
830 # finally self assignments are allowed as the generated CPU code
832 main
.Append(CCFLAGS
=['-Wno-parentheses',
834 # Some versions of libstdc++ (4.8?) seem to
835 # use struct hash and class hash
837 '-Wno-mismatched-tags',
840 main
.Append(TCMALLOC_CCFLAGS
=['-fno-builtin'])
842 # On Mac OS X/Darwin we need to also use libc++ (part of XCode) as
843 # opposed to libstdc++, as the later is dated.
844 if sys
.platform
== "darwin":
845 main
.Append(CXXFLAGS
=['-stdlib=libc++'])
846 main
.Append(LIBS
=['c++'])
848 # On FreeBSD we need libthr.
849 if sys
.platform
.startswith('freebsd'):
850 main
.Append(LIBS
=['thr'])
853 print termcap
.Yellow
+ termcap
.Bold
+ 'Error' + termcap
.Normal
,
854 print "Don't know what compiler options to use for your compiler."
855 print termcap
.Yellow
+ ' compiler:' + termcap
.Normal
, main
['CXX']
856 print termcap
.Yellow
+ ' version:' + termcap
.Normal
,
858 print termcap
.Yellow
+ termcap
.Bold
+ "COMMAND NOT FOUND!" +\
861 print CXX_version
.replace('\n', '<nl>')
862 print " If you're trying to use a compiler other than GCC"
863 print " or clang, there appears to be something wrong with your"
864 print " environment."
866 print " If you are trying to use a compiler other than those listed"
867 print " above you will need to ease fix SConstruct and "
868 print " src/SConscript to support that compiler."
871 # Set up common yacc/bison flags (needed for Ruby)
872 main
['YACCFLAGS'] = '-d'
873 main
['YACCHXXFILESUFFIX'] = '.hh'
875 # Do this after we save setting back, or else we'll tack on an
876 # extra 'qdo' every time we run scons.
878 main
['CC'] = main
['BATCH_CMD'] + ' ' + main
['CC']
879 main
['CXX'] = main
['BATCH_CMD'] + ' ' + main
['CXX']
880 main
['AS'] = main
['BATCH_CMD'] + ' ' + main
['AS']
881 main
['AR'] = main
['BATCH_CMD'] + ' ' + main
['AR']
882 main
['RANLIB'] = main
['BATCH_CMD'] + ' ' + main
['RANLIB']
884 if sys
.platform
== 'cygwin':
885 # cygwin has some header file issues...
886 main
.Append(CCFLAGS
=["-Wno-uninitialized"])
888 # Check for the protobuf compiler
889 protoc_version
= readCommand([main
['PROTOC'], '--version'],
890 exception
='').split()
892 # First two words should be "libprotoc x.y.z"
893 if len(protoc_version
) < 2 or protoc_version
[0] != 'libprotoc':
894 print termcap
.Yellow
+ termcap
.Bold
+ \
895 'Warning: Protocol buffer compiler (protoc) not found.\n' + \
896 ' Please install protobuf-compiler for tracing support.' + \
898 main
['PROTOC'] = False
900 # Based on the availability of the compress stream wrappers,
902 min_protoc_version
= '2.1.0'
903 if compareVersions(protoc_version
[1], min_protoc_version
) < 0:
904 print termcap
.Yellow
+ termcap
.Bold
+ \
905 'Warning: protoc version', min_protoc_version
, \
906 'or newer required.\n' + \
907 ' Installed version:', protoc_version
[1], \
909 main
['PROTOC'] = False
911 # Attempt to determine the appropriate include path and
912 # library path using pkg-config, that means we also need to
913 # check for pkg-config. Note that it is possible to use
914 # protobuf without the involvement of pkg-config. Later on we
915 # check go a library config check and at that point the test
916 # will fail if libprotobuf cannot be found.
917 if readCommand(['pkg-config', '--version'], exception
=''):
919 # Attempt to establish what linking flags to add for protobuf
921 main
.ParseConfig('pkg-config --cflags --libs-only-L protobuf')
923 print termcap
.Yellow
+ termcap
.Bold
+ \
924 'Warning: pkg-config could not get protobuf flags.' + \
928 # Check for 'timeout' from GNU coreutils. If present, regressions will
929 # be run with a time limit. We require version 8.13 since we rely on
930 # support for the '--foreground' option.
931 if sys
.platform
.startswith('freebsd'):
932 timeout_lines
= readCommand(['gtimeout', '--version'],
933 exception
='').splitlines()
935 timeout_lines
= readCommand(['timeout', '--version'],
936 exception
='').splitlines()
937 # Get the first line and tokenize it
938 timeout_version
= timeout_lines
[0].split() if timeout_lines
else []
939 main
['TIMEOUT'] = timeout_version
and \
940 compareVersions(timeout_version
[-1], '8.13') >= 0
942 # Add a custom Check function to test for structure members.
943 def CheckMember(context
, include
, decl
, member
, include_quotes
="<>"):
944 context
.Message("Checking for member %s in %s..." %
950 (void)test.%(member)s;
953 """ % { "header" : include_quotes
[0] + include
+ include_quotes
[1],
958 ret
= context
.TryCompile(text
, extension
=".cc")
962 # Platform-specific configuration. Note again that we assume that all
963 # builds under a given build root run on the same host platform.
964 conf
= Configure(main
,
965 conf_dir
= joinpath(build_root
, '.scons_config'),
966 log_file
= joinpath(build_root
, 'scons_config.log'),
968 'CheckMember' : CheckMember
,
971 # Check if we should compile a 64 bit binary on Mac OS X/Darwin
974 uname
= platform
.uname()
975 if uname
[0] == 'Darwin' and compareVersions(uname
[2], '9.0.0') >= 0:
976 if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
977 main
.Append(CCFLAGS
=['-arch', 'x86_64'])
978 main
.Append(CFLAGS
=['-arch', 'x86_64'])
979 main
.Append(LINKFLAGS
=['-arch', 'x86_64'])
980 main
.Append(ASFLAGS
=['-arch', 'x86_64'])
984 # Recent versions of scons substitute a "Null" object for Configure()
985 # when configuration isn't necessary, e.g., if the "--help" option is
986 # present. Unfortuantely this Null object always returns false,
987 # breaking all our configuration checks. We replace it with our own
988 # more optimistic null object that returns True instead.
990 def NullCheck(*args
, **kwargs
):
994 def __init__(self
, env
):
998 def __getattr__(self
, mname
):
1001 conf
= NullConf(main
)
1003 # Cache build files in the supplied directory.
1004 if main
['M5_BUILD_CACHE']:
1005 print 'Using build cache located at', main
['M5_BUILD_CACHE']
1006 CacheDir(main
['M5_BUILD_CACHE'])
1008 main
['USE_PYTHON'] = not GetOption('without_python')
1009 if main
['USE_PYTHON']:
1010 # Find Python include and library directories for embedding the
1011 # interpreter. We rely on python-config to resolve the appropriate
1012 # includes and linker flags. ParseConfig does not seem to understand
1013 # the more exotic linker flags such as -Xlinker and -export-dynamic so
1014 # we add them explicitly below. If you want to link in an alternate
1015 # version of python, see above for instructions on how to invoke
1016 # scons with the appropriate PATH set.
1018 # First we check if python2-config exists, else we use python-config
1019 python_config
= readCommand(['which', 'python2-config'],
1020 exception
='').strip()
1021 if not os
.path
.exists(python_config
):
1022 python_config
= readCommand(['which', 'python-config'],
1023 exception
='').strip()
1024 py_includes
= readCommand([python_config
, '--includes'],
1025 exception
='').split()
1026 # Strip the -I from the include folders before adding them to the
1028 main
.Append(CPPPATH
=map(lambda inc
: inc
[2:], py_includes
))
1030 # Read the linker flags and split them into libraries and other link
1031 # flags. The libraries are added later through the call the CheckLib.
1032 py_ld_flags
= readCommand([python_config
, '--ldflags'],
1033 exception
='').split()
1035 for lib
in py_ld_flags
:
1036 if not lib
.startswith('-l'):
1037 main
.Append(LINKFLAGS
=[lib
])
1040 if lib
not in py_libs
:
1043 # verify that this stuff works
1044 if not conf
.CheckHeader('Python.h', '<>'):
1045 print "Error: can't find Python.h header in", py_includes
1046 print "Install Python headers (package python-dev on Ubuntu and RedHat)"
1050 if not conf
.CheckLib(lib
):
1051 print "Error: can't find library %s required by python" % lib
1054 # On Solaris you need to use libsocket for socket ops
1055 if not conf
.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
1056 if not conf
.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
1057 print "Can't find library with socket calls (e.g. accept())"
1060 # Check for zlib. If the check passes, libz will be automatically
1061 # added to the LIBS environment variable.
1062 if not conf
.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
1063 print 'Error: did not find needed zlib compression library '\
1064 'and/or zlib.h header file.'
1065 print ' Please install zlib and try again.'
1068 # If we have the protobuf compiler, also make sure we have the
1069 # development libraries. If the check passes, libprotobuf will be
1070 # automatically added to the LIBS environment variable. After
1071 # this, we can use the HAVE_PROTOBUF flag to determine if we have
1072 # got both protoc and libprotobuf available.
1073 main
['HAVE_PROTOBUF'] = main
['PROTOC'] and \
1074 conf
.CheckLibWithHeader('protobuf', 'google/protobuf/message.h',
1075 'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;')
1077 # If we have the compiler but not the library, print another warning.
1078 if main
['PROTOC'] and not main
['HAVE_PROTOBUF']:
1079 print termcap
.Yellow
+ termcap
.Bold
+ \
1080 'Warning: did not find protocol buffer library and/or headers.\n' + \
1081 ' Please install libprotobuf-dev for tracing support.' + \
1085 have_posix_clock
= \
1086 conf
.CheckLibWithHeader(None, 'time.h', 'C',
1087 'clock_nanosleep(0,0,NULL,NULL);') or \
1088 conf
.CheckLibWithHeader('rt', 'time.h', 'C',
1089 'clock_nanosleep(0,0,NULL,NULL);')
1091 have_posix_timers
= \
1092 conf
.CheckLibWithHeader([None, 'rt'], [ 'time.h', 'signal.h' ], 'C',
1093 'timer_create(CLOCK_MONOTONIC, NULL, NULL);')
1095 if not GetOption('without_tcmalloc'):
1096 if conf
.CheckLib('tcmalloc'):
1097 main
.Append(CCFLAGS
=main
['TCMALLOC_CCFLAGS'])
1098 elif conf
.CheckLib('tcmalloc_minimal'):
1099 main
.Append(CCFLAGS
=main
['TCMALLOC_CCFLAGS'])
1101 print termcap
.Yellow
+ termcap
.Bold
+ \
1102 "You can get a 12% performance improvement by "\
1103 "installing tcmalloc (libgoogle-perftools-dev package "\
1104 "on Ubuntu or RedHat)." + termcap
.Normal
1107 # Detect back trace implementations. The last implementation in the
1108 # list will be used by default.
1109 backtrace_impls
= [ "none" ]
1111 if conf
.CheckLibWithHeader(None, 'execinfo.h', 'C',
1112 'backtrace_symbols_fd((void*)0, 0, 0);'):
1113 backtrace_impls
.append("glibc")
1114 elif conf
.CheckLibWithHeader('execinfo', 'execinfo.h', 'C',
1115 'backtrace_symbols_fd((void*)0, 0, 0);'):
1116 # NetBSD and FreeBSD need libexecinfo.
1117 backtrace_impls
.append("glibc")
1118 main
.Append(LIBS
=['execinfo'])
1120 if backtrace_impls
[-1] == "none":
1121 default_backtrace_impl
= "none"
1122 print termcap
.Yellow
+ termcap
.Bold
+ \
1123 "No suitable back trace implementation found." + \
1126 if not have_posix_clock
:
1127 print "Can't find library for POSIX clocks."
1129 # Check for <fenv.h> (C99 FP environment control)
1130 have_fenv
= conf
.CheckHeader('fenv.h', '<>')
1132 print "Warning: Header file <fenv.h> not found."
1133 print " This host has no IEEE FP rounding mode control."
1135 # Check if we should enable KVM-based hardware virtualization. The API
1136 # we rely on exists since version 2.6.36 of the kernel, but somehow
1137 # the KVM_API_VERSION does not reflect the change. We test for one of
1138 # the types as a fall back.
1139 have_kvm
= conf
.CheckHeader('linux/kvm.h', '<>')
1141 print "Info: Compatible header file <linux/kvm.h> not found, " \
1142 "disabling KVM support."
1144 # Check if the TUN/TAP driver is available.
1145 have_tuntap
= conf
.CheckHeader('linux/if_tun.h', '<>')
1147 print "Info: Compatible header file <linux/if_tun.h> not found."
1149 # x86 needs support for xsave. We test for the structure here since we
1150 # won't be able to run new tests by the time we know which ISA we're
1152 have_kvm_xsave
= conf
.CheckTypeSize('struct kvm_xsave',
1153 '#include <linux/kvm.h>') != 0
1155 # Check if the requested target ISA is compatible with the host
1156 def is_isa_kvm_compatible(isa
):
1159 host_isa
= platform
.machine()
1161 print "Warning: Failed to determine host ISA."
1164 if not have_posix_timers
:
1165 print "Warning: Can not enable KVM, host seems to lack support " \
1170 return host_isa
in ( "armv7l", "aarch64" )
1172 if host_isa
!= "x86_64":
1175 if not have_kvm_xsave
:
1176 print "KVM on x86 requires xsave support in kernel headers."
1184 # Check if the exclude_host attribute is available. We want this to
1185 # get accurate instruction counts in KVM.
1186 main
['HAVE_PERF_ATTR_EXCLUDE_HOST'] = conf
.CheckMember(
1187 'linux/perf_event.h', 'struct perf_event_attr', 'exclude_host')
1190 ######################################################################
1192 # Finish the configuration
1194 main
= conf
.Finish()
1196 ######################################################################
1198 # Collect all non-global variables
1201 # Define the universe of supported ISAs
1203 all_gpu_isa_list
= [ ]
1204 Export('all_isa_list')
1205 Export('all_gpu_isa_list')
1207 class CpuModel(object):
1208 '''The CpuModel class encapsulates everything the ISA parser needs to
1209 know about a particular CPU model.'''
1211 # Dict of available CPU model objects. Accessible as CpuModel.dict.
1214 # Constructor. Automatically adds models to CpuModel.dict.
1215 def __init__(self
, name
, default
=False):
1216 self
.name
= name
# name of model
1218 # This cpu is enabled by default
1219 self
.default
= default
1222 if name
in CpuModel
.dict:
1223 raise AttributeError, "CpuModel '%s' already registered" % name
1224 CpuModel
.dict[name
] = self
1228 # Sticky variables get saved in the variables file so they persist from
1229 # one invocation to the next (unless overridden, in which case the new
1230 # value becomes sticky).
1231 sticky_vars
= Variables(args
=ARGUMENTS
)
1232 Export('sticky_vars')
1234 # Sticky variables that should be exported
1236 Export('export_vars')
1240 Export('all_protocols')
1242 Export('protocol_dirs')
1244 Export('slicc_includes')
1246 # Walk the tree and execute all SConsopts scripts that wil add to the
1248 if GetOption('verbose'):
1249 print "Reading SConsopts"
1250 for bdir
in [ base_dir
] + extras_dir_list
:
1252 print "Error: directory '%s' does not exist" % bdir
1254 for root
, dirs
, files
in os
.walk(bdir
):
1255 if 'SConsopts' in files
:
1256 if GetOption('verbose'):
1257 print "Reading", joinpath(root
, 'SConsopts')
1258 SConscript(joinpath(root
, 'SConsopts'))
1261 all_gpu_isa_list
.sort()
1263 sticky_vars
.AddVariables(
1264 EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list
),
1265 EnumVariable('TARGET_GPU_ISA', 'Target GPU ISA', 'hsail', all_gpu_isa_list
),
1266 ListVariable('CPU_MODELS', 'CPU models',
1267 sorted(n
for n
,m
in CpuModel
.dict.iteritems() if m
.default
),
1268 sorted(CpuModel
.dict.keys())),
1269 BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
1271 BoolVariable('SS_COMPATIBLE_FP',
1272 'Make floating-point results compatible with SimpleScalar',
1274 BoolVariable('USE_SSE2',
1275 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
1277 BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock
),
1278 BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv
),
1279 BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False),
1280 BoolVariable('USE_KVM', 'Enable hardware virtualized (KVM) CPU models', have_kvm
),
1281 BoolVariable('USE_TUNTAP',
1282 'Enable using a tap device to bridge to the host network',
1284 BoolVariable('BUILD_GPU', 'Build the compute-GPU model', False),
1285 EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None',
1287 EnumVariable('BACKTRACE_IMPL', 'Post-mortem dump implementation',
1288 backtrace_impls
[-1], backtrace_impls
)
1291 # These variables get exported to #defines in config/*.hh (see src/SConscript).
1292 export_vars
+= ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'TARGET_GPU_ISA',
1293 'CP_ANNOTATE', 'USE_POSIX_CLOCK', 'USE_KVM', 'USE_TUNTAP',
1294 'PROTOCOL', 'HAVE_PROTOBUF', 'HAVE_PERF_ATTR_EXCLUDE_HOST']
1296 ###################################################
1298 # Define a SCons builder for configuration flag headers.
1300 ###################################################
1302 # This function generates a config header file that #defines the
1303 # variable symbol to the current variable setting (0 or 1). The source
1304 # operands are the name of the variable and a Value node containing the
1305 # value of the variable.
1306 def build_config_file(target
, source
, env
):
1307 (variable
, value
) = [s
.get_contents() for s
in source
]
1308 f
= file(str(target
[0]), 'w')
1309 print >> f
, '#define', variable
, value
1313 # Combine the two functions into a scons Action object.
1314 config_action
= MakeAction(build_config_file
, Transform("CONFIG H", 2))
1316 # The emitter munges the source & target node lists to reflect what
1317 # we're really doing.
1318 def config_emitter(target
, source
, env
):
1319 # extract variable name from Builder arg
1320 variable
= str(target
[0])
1321 # True target is config header file
1322 target
= joinpath('config', variable
.lower() + '.hh')
1324 if isinstance(val
, bool):
1325 # Force value to 0/1
1327 elif isinstance(val
, str):
1328 val
= '"' + val
+ '"'
1330 # Sources are variable name & value (packaged in SCons Value nodes)
1331 return ([target
], [Value(variable
), Value(val
)])
1333 config_builder
= Builder(emitter
= config_emitter
, action
= config_action
)
1335 main
.Append(BUILDERS
= { 'ConfigFile' : config_builder
})
1337 ###################################################
1339 # Builders for static and shared partially linked object files.
1341 ###################################################
1343 partial_static_builder
= Builder(action
=SCons
.Defaults
.LinkAction
,
1344 src_suffix
='$OBJSUFFIX',
1345 src_builder
=['StaticObject', 'Object'],
1346 LINKFLAGS
='$PLINKFLAGS',
1349 def partial_shared_emitter(target
, source
, env
):
1351 tgt
.attributes
.shared
= 1
1352 return (target
, source
)
1353 partial_shared_builder
= Builder(action
=SCons
.Defaults
.ShLinkAction
,
1354 emitter
=partial_shared_emitter
,
1355 src_suffix
='$SHOBJSUFFIX',
1356 src_builder
='SharedObject',
1357 SHLINKFLAGS
='$PSHLINKFLAGS',
1360 main
.Append(BUILDERS
= { 'PartialShared' : partial_shared_builder
,
1361 'PartialStatic' : partial_static_builder
})
1363 # builds in ext are shared across all configs in the build root.
1364 ext_dir
= abspath(joinpath(str(main
.root
), 'ext'))
1366 for root
, dirs
, files
in os
.walk(ext_dir
):
1367 if 'SConscript' in files
:
1368 build_dir
= os
.path
.relpath(root
, ext_dir
)
1369 ext_build_dirs
.append(build_dir
)
1370 main
.SConscript(joinpath(root
, 'SConscript'),
1371 variant_dir
=joinpath(build_root
, build_dir
))
1373 main
.Prepend(CPPPATH
=Dir('ext/pybind11/include/'))
1375 ###################################################
1377 # This builder and wrapper method are used to set up a directory with
1378 # switching headers. Those are headers which are in a generic location and
1379 # that include more specific headers from a directory chosen at build time
1380 # based on the current build settings.
1382 ###################################################
1384 def build_switching_header(target
, source
, env
):
1385 path
= str(target
[0])
1386 subdir
= str(source
[0])
1387 dp
, fp
= os
.path
.split(path
)
1388 dp
= os
.path
.relpath(os
.path
.realpath(dp
),
1389 os
.path
.realpath(env
['BUILDDIR']))
1390 with
open(path
, 'w') as hdr
:
1391 print >>hdr
, '#include "%s/%s/%s"' % (dp
, subdir
, fp
)
1393 switching_header_action
= MakeAction(build_switching_header
,
1394 Transform('GENERATE'))
1396 switching_header_builder
= Builder(action
=switching_header_action
,
1397 source_factory
=Value
,
1400 main
.Append(BUILDERS
= { 'SwitchingHeader': switching_header_builder
})
1402 def switching_headers(self
, headers
, source
):
1403 for header
in headers
:
1404 self
.SwitchingHeader(header
, source
)
1406 main
.AddMethod(switching_headers
, 'SwitchingHeaders')
1408 # all-isas -> all-deps -> all-environs -> all_targets
1409 main
.Alias('#all-isas', [])
1410 main
.Alias('#all-deps', '#all-isas')
1412 # Dummy target to ensure all environments are created before telling
1413 # SCons what to actually make (the command line arguments). We attach
1414 # them to the dependence graph after the environments are complete.
1415 ORIG_BUILD_TARGETS
= list(BUILD_TARGETS
) # force a copy; gets closure to work.
1416 def environsComplete(target
, source
, env
):
1417 for t
in ORIG_BUILD_TARGETS
:
1418 main
.Depends('#all-targets', t
)
1420 # Each build/* switching_dir attaches its *-environs target to #all-environs.
1421 main
.Append(BUILDERS
= {'CompleteEnvirons' :
1422 Builder(action
=MakeAction(environsComplete
, None))})
1423 main
.CompleteEnvirons('#all-environs', [])
1425 def doNothing(**ignored
): pass
1426 main
.Append(BUILDERS
= {'Dummy': Builder(action
=MakeAction(doNothing
, None))})
1428 # The final target to which all the original targets ultimately get attached.
1429 main
.Dummy('#all-targets', '#all-environs')
1430 BUILD_TARGETS
[:] = ['#all-targets']
1432 ###################################################
1434 # Define build environments for selected configurations.
1436 ###################################################
1438 def variant_name(path
):
1439 return os
.path
.basename(path
).lower().replace('_', '-')
1440 main
['variant_name'] = variant_name
1441 main
['VARIANT_NAME'] = '${variant_name(BUILDDIR)}'
1443 for variant_path
in variant_paths
:
1444 if not GetOption('silent'):
1445 print "Building in", variant_path
1447 # Make a copy of the build-root environment to use for this config.
1449 env
['BUILDDIR'] = variant_path
1451 # variant_dir is the tail component of build path, and is used to
1452 # determine the build parameters (e.g., 'ALPHA_SE')
1453 (build_root
, variant_dir
) = splitpath(variant_path
)
1455 # Set env variables according to the build directory config.
1456 sticky_vars
.files
= []
1457 # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
1458 # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
1459 # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
1460 current_vars_file
= joinpath(build_root
, 'variables', variant_dir
)
1461 if isfile(current_vars_file
):
1462 sticky_vars
.files
.append(current_vars_file
)
1463 if not GetOption('silent'):
1464 print "Using saved variables file %s" % current_vars_file
1465 elif variant_dir
in ext_build_dirs
:
1466 # Things in ext are built without a variant directory.
1469 # Build dir-specific variables file doesn't exist.
1471 # Make sure the directory is there so we can create it later
1472 opt_dir
= dirname(current_vars_file
)
1473 if not isdir(opt_dir
):
1476 # Get default build variables from source tree. Variables are
1477 # normally determined by name of $VARIANT_DIR, but can be
1478 # overridden by '--default=' arg on command line.
1479 default
= GetOption('default')
1480 opts_dir
= joinpath(main
.root
.abspath
, 'build_opts')
1482 default_vars_files
= [joinpath(build_root
, 'variables', default
),
1483 joinpath(opts_dir
, default
)]
1485 default_vars_files
= [joinpath(opts_dir
, variant_dir
)]
1486 existing_files
= filter(isfile
, default_vars_files
)
1488 default_vars_file
= existing_files
[0]
1489 sticky_vars
.files
.append(default_vars_file
)
1490 print "Variables file %s not found,\n using defaults in %s" \
1491 % (current_vars_file
, default_vars_file
)
1493 print "Error: cannot find variables file %s or " \
1494 "default file(s) %s" \
1495 % (current_vars_file
, ' or '.join(default_vars_files
))
1498 # Apply current variable settings to env
1499 sticky_vars
.Update(env
)
1501 help_texts
["local_vars"] += \
1502 "Build variables for %s:\n" % variant_dir \
1503 + sticky_vars
.GenerateHelpText(env
)
1505 # Process variable settings.
1507 if not have_fenv
and env
['USE_FENV']:
1508 print "Warning: <fenv.h> not available; " \
1509 "forcing USE_FENV to False in", variant_dir
+ "."
1510 env
['USE_FENV'] = False
1512 if not env
['USE_FENV']:
1513 print "Warning: No IEEE FP rounding mode control in", variant_dir
+ "."
1514 print " FP results may deviate slightly from other platforms."
1517 env
.Append(LIBS
=['efence'])
1521 print "Warning: Can not enable KVM, host seems to lack KVM support"
1522 env
['USE_KVM'] = False
1523 elif not is_isa_kvm_compatible(env
['TARGET_ISA']):
1524 print "Info: KVM support disabled due to unsupported host and " \
1525 "target ISA combination"
1526 env
['USE_KVM'] = False
1528 if env
['USE_TUNTAP']:
1530 print "Warning: Can't connect EtherTap with a tap device."
1531 env
['USE_TUNTAP'] = False
1533 if env
['BUILD_GPU']:
1534 env
.Append(CPPDEFINES
=['BUILD_GPU'])
1536 # Warn about missing optional functionality
1538 if not main
['HAVE_PERF_ATTR_EXCLUDE_HOST']:
1539 print "Warning: perf_event headers lack support for the " \
1540 "exclude_host attribute. KVM instruction counts will " \
1543 # Save sticky variable settings back to current variables file
1544 sticky_vars
.Save(current_vars_file
, env
)
1547 env
.Append(CCFLAGS
=['-msse2'])
1549 # The src/SConscript file sets up the build rules in 'env' according
1550 # to the configured variables. It returns a list of environments,
1551 # one for each variant build (debug, opt, etc.)
1552 SConscript('src/SConscript', variant_dir
= variant_path
, exports
= 'env')
1554 def pairwise(iterable
):
1555 "s -> (s0,s1), (s1,s2), (s2, s3), ..."
1556 a
, b
= itertools
.tee(iterable
)
1558 return itertools
.izip(a
, b
)
1560 variant_names
= [variant_name(path
) for path
in variant_paths
]
1562 # Create false dependencies so SCons will parse ISAs, establish
1563 # dependencies, and setup the build Environments serially. Either
1564 # SCons (likely) and/or our SConscripts (possibly) cannot cope with -j
1565 # greater than 1. It appears to be standard race condition stuff; it
1566 # doesn't always fail, but usually, and the behaviors are different.
1567 # Every time I tried to remove this, builds would fail in some
1568 # creative new way. So, don't do that. You'll want to, though, because
1569 # tests/SConscript takes a long time to make its Environments.
1570 for t1
, t2
in pairwise(sorted(variant_names
)):
1571 main
.Depends('#%s-deps' % t2
, '#%s-deps' % t1
)
1572 main
.Depends('#%s-environs' % t2
, '#%s-environs' % t1
)
1576 Usage: scons [scons options] [build variables] [target(s)]
1578 Extra scons options:
1581 Global build variables: