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', '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 # add useful python code PYTHONPATH so it can be used by subprocesses
246 main
.AppendENVPath('PYTHONPATH', extra_python_paths
)
248 ########################################################################
252 # If the gem5 directory is a mercurial repository, we should do some
255 ########################################################################
257 hgdir
= main
.root
.Dir(".hg")
261 You're missing the gem5 style hook, which automatically checks your code
262 against the gem5 style rules on %s.
263 This script will now install the hook in your %s.
264 Press enter to continue, or ctrl-c to abort: """
266 mercurial_style_message
= """
267 You're missing the gem5 style hook, which automatically checks your code
268 against the gem5 style rules on hg commit and qrefresh commands.
269 This script will now install the hook in your .hg/hgrc file.
270 Press enter to continue, or ctrl-c to abort: """
272 git_style_message
= """
273 You're missing the gem5 style or commit message hook. These hooks help
274 to ensure that your code follows gem5's style rules on git commit.
275 This script will now install the hook in your .git/hooks/ directory.
276 Press enter to continue, or ctrl-c to abort: """
278 mercurial_style_upgrade_message
= """
279 Your Mercurial style hooks are not up-to-date. This script will now
280 try to automatically update them. A backup of your hgrc will be saved
282 Press enter to continue, or ctrl-c to abort: """
284 mercurial_style_hook
= """
285 # The following lines were automatically added by gem5/SConstruct
286 # to provide the gem5 style-checking hooks
288 hgstyle = %s/util/hgstyle.py
291 pretxncommit.style = python:hgstyle.check_style
292 pre-qrefresh.style = python:hgstyle.check_style
293 # End of SConstruct additions
295 """ % (main
.root
.abspath
)
297 mercurial_lib_not_found
= """
298 Mercurial libraries cannot be found, ignoring style hook. If
299 you are a gem5 developer, please fix this and run the style
300 hook. It is important.
303 # Check for style hook and prompt for installation if it's not there.
304 # Skip this if --ignore-style was specified, there's no interactive
305 # terminal to prompt, or no recognized revision control system can be
307 ignore_style
= GetOption('ignore_style') or not sys
.stdin
.isatty()
309 # Try wire up Mercurial to the style hooks
310 if not ignore_style
and hgdir
.exists():
312 style_hooks
= tuple()
313 hgrc
= hgdir
.File('hgrc')
314 hgrc_old
= hgdir
.File('hgrc.old')
316 from mercurial
import ui
318 ui
.readconfig(hgrc
.abspath
)
319 style_hooks
= (ui
.config('hooks', 'pretxncommit.style', None),
320 ui
.config('hooks', 'pre-qrefresh.style', None))
321 style_hook
= all(style_hooks
)
322 style_extension
= ui
.config('extensions', 'style', None)
324 print mercurial_lib_not_found
326 if "python:style.check_style" in style_hooks
:
327 # Try to upgrade the style hooks
328 print mercurial_style_upgrade_message
329 # continue unless user does ctrl-c/ctrl-d etc.
333 print "Input exception, exiting scons.\n"
335 shutil
.copyfile(hgrc
.abspath
, hgrc_old
.abspath
)
336 re_style_hook
= re
.compile(r
"^([^=#]+)\.style\s*=\s*([^#\s]+).*")
337 re_style_extension
= re
.compile("style\s*=\s*([^#\s]+).*")
338 old
, new
= open(hgrc_old
.abspath
, 'r'), open(hgrc
.abspath
, 'w')
340 m_hook
= re_style_hook
.match(l
)
341 m_ext
= re_style_extension
.match(l
)
343 hook
, check
= m_hook
.groups()
344 if check
!= "python:style.check_style":
345 print "Warning: %s.style is using a non-default " \
346 "checker: %s" % (hook
, check
)
347 if hook
not in ("pretxncommit", "pre-qrefresh"):
348 print "Warning: Updating unknown style hook: %s" % hook
350 l
= "%s.style = python:hgstyle.check_style\n" % hook
351 elif m_ext
and m_ext
.group(1) == style_extension
:
352 l
= "hgstyle = %s/util/hgstyle.py\n" % main
.root
.abspath
356 print mercurial_style_message
,
357 # continue unless user does ctrl-c/ctrl-d etc.
361 print "Input exception, exiting scons.\n"
363 hgrc_path
= '%s/.hg/hgrc' % main
.root
.abspath
364 print "Adding style hook to", hgrc_path
, "\n"
366 with
open(hgrc_path
, 'a') as f
:
367 f
.write(mercurial_style_hook
)
369 print "Error updating", hgrc_path
372 def install_git_style_hooks():
374 gitdir
= Dir(readCommand(
375 ["git", "rev-parse", "--git-dir"]).strip("\n"))
377 print "Warning: Failed to find git repo directory: %s" % e
380 git_hooks
= gitdir
.Dir("hooks")
381 def hook_exists(hook_name
):
382 hook
= git_hooks
.File(hook_name
)
385 def hook_install(hook_name
, script
):
386 hook
= git_hooks
.File(hook_name
)
388 print "Warning: Can't install %s, hook already exists." % hook_name
392 print "Warning: Removing broken symlink for hook %s." % hook_name
393 os
.unlink(hook
.get_abspath())
395 if not git_hooks
.exists():
396 mkdir(git_hooks
.get_abspath())
399 abs_symlink_hooks
= git_hooks
.islink() and \
400 os
.path
.isabs(os
.readlink(git_hooks
.get_abspath()))
402 # Use a relative symlink if the hooks live in the source directory,
403 # and the hooks directory is not a symlink to an absolute path.
404 if hook
.is_under(main
.root
) and not abs_symlink_hooks
:
405 script_path
= os
.path
.relpath(
406 os
.path
.realpath(script
.get_abspath()),
407 os
.path
.realpath(hook
.Dir(".").get_abspath()))
409 script_path
= script
.get_abspath()
412 os
.symlink(script_path
, hook
.get_abspath())
414 print "Error updating git %s hook" % hook_name
417 if hook_exists("pre-commit") and hook_exists("commit-msg"):
420 print git_style_message
,
424 print "Input exception, exiting scons.\n"
427 git_style_script
= File("util/git-pre-commit.py")
428 git_msg_script
= File("ext/git-commit-msg")
430 hook_install("pre-commit", git_style_script
)
431 hook_install("commit-msg", git_msg_script
)
433 # Try to wire up git to the style hooks
434 if not ignore_style
and main
.root
.Entry(".git").exists():
435 install_git_style_hooks()
437 ###################################################
439 # Figure out which configurations to set up based on the path(s) of
442 ###################################################
444 # Find default configuration & binary.
445 Default(environ
.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug'))
447 # helper function: find last occurrence of element in list
448 def rfind(l
, elt
, offs
= -1):
449 for i
in range(len(l
)+offs
, 0, -1):
452 raise ValueError, "element not found"
454 # Take a list of paths (or SCons Nodes) and return a list with all
455 # paths made absolute and ~-expanded. Paths will be interpreted
456 # relative to the launch directory unless a different root is provided
457 def makePathListAbsolute(path_list
, root
=GetLaunchDir()):
458 return [abspath(joinpath(root
, expanduser(str(p
))))
461 # Each target must have 'build' in the interior of the path; the
462 # directory below this will determine the build parameters. For
463 # example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
464 # recognize that ALPHA_SE specifies the configuration because it
465 # follow 'build' in the build path.
467 # The funky assignment to "[:]" is needed to replace the list contents
468 # in place rather than reassign the symbol to a new list, which
469 # doesn't work (obviously!).
470 BUILD_TARGETS
[:] = makePathListAbsolute(BUILD_TARGETS
)
472 # Generate a list of the unique build roots and configs that the
473 # collected targets reference.
476 for t
in BUILD_TARGETS
:
477 path_dirs
= t
.split('/')
479 build_top
= rfind(path_dirs
, 'build', -2)
481 print "Error: no non-leaf 'build' dir found on target path", t
483 this_build_root
= joinpath('/',*path_dirs
[:build_top
+1])
485 build_root
= this_build_root
487 if this_build_root
!= build_root
:
488 print "Error: build targets not under same build root\n"\
489 " %s\n %s" % (build_root
, this_build_root
)
491 variant_path
= joinpath('/',*path_dirs
[:build_top
+2])
492 if variant_path
not in variant_paths
:
493 variant_paths
.append(variant_path
)
495 # Make sure build_root exists (might not if this is the first build there)
496 if not isdir(build_root
):
498 main
['BUILDROOT'] = build_root
502 main
.SConsignFile(joinpath(build_root
, "sconsign"))
504 # Default duplicate option is to use hard links, but this messes up
505 # when you use emacs to edit a file in the target dir, as emacs moves
506 # file to file~ then copies to file, breaking the link. Symbolic
507 # (soft) links work better.
508 main
.SetOption('duplicate', 'soft-copy')
511 # Set up global sticky variables... these are common to an entire build
512 # tree (not specific to a particular build like ALPHA_SE)
515 global_vars_file
= joinpath(build_root
, 'variables.global')
517 global_vars
= Variables(global_vars_file
, args
=ARGUMENTS
)
519 global_vars
.AddVariables(
520 ('CC', 'C compiler', environ
.get('CC', main
['CC'])),
521 ('CXX', 'C++ compiler', environ
.get('CXX', main
['CXX'])),
522 ('PROTOC', 'protoc tool', environ
.get('PROTOC', 'protoc')),
523 ('BATCH', 'Use batch pool for build and tests', False),
524 ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
525 ('M5_BUILD_CACHE', 'Cache built objects in this directory', False),
526 ('EXTRAS', 'Add extra directories to the compilation', '')
529 # Update main environment with values from ARGUMENTS & global_vars_file
530 global_vars
.Update(main
)
531 help_texts
["global_vars"] += global_vars
.GenerateHelpText(main
)
533 # Save sticky variable settings back to current variables file
534 global_vars
.Save(global_vars_file
, main
)
536 # Parse EXTRAS variable to build list of all directories where we're
537 # look for sources etc. This list is exported as extras_dir_list.
538 base_dir
= main
.srcdir
.abspath
540 extras_dir_list
= makePathListAbsolute(main
['EXTRAS'].split(':'))
545 Export('extras_dir_list')
547 # the ext directory should be on the #includes path
548 main
.Append(CPPPATH
=[Dir('ext')])
550 def strip_build_path(path
, env
):
552 variant_base
= env
['BUILDROOT'] + os
.path
.sep
553 if path
.startswith(variant_base
):
554 path
= path
[len(variant_base
):]
555 elif path
.startswith('build/'):
559 # Generate a string of the form:
560 # common/path/prefix/src1, src2 -> tgt1, tgt2
561 # to print while building.
562 class Transform(object):
563 # all specific color settings should be here and nowhere else
564 tool_color
= termcap
.Normal
565 pfx_color
= termcap
.Yellow
566 srcs_color
= termcap
.Yellow
+ termcap
.Bold
567 arrow_color
= termcap
.Blue
+ termcap
.Bold
568 tgts_color
= termcap
.Yellow
+ termcap
.Bold
570 def __init__(self
, tool
, max_sources
=99):
571 self
.format
= self
.tool_color
+ (" [%8s] " % tool
) \
572 + self
.pfx_color
+ "%s" \
573 + self
.srcs_color
+ "%s" \
574 + self
.arrow_color
+ " -> " \
575 + self
.tgts_color
+ "%s" \
577 self
.max_sources
= max_sources
579 def __call__(self
, target
, source
, env
, for_signature
=None):
580 # truncate source list according to max_sources param
581 source
= source
[0:self
.max_sources
]
583 return strip_build_path(str(f
), env
)
585 srcs
= map(strip
, source
)
588 tgts
= map(strip
, target
)
589 # surprisingly, os.path.commonprefix is a dumb char-by-char string
590 # operation that has nothing to do with paths.
591 com_pfx
= os
.path
.commonprefix(srcs
+ tgts
)
592 com_pfx_len
= len(com_pfx
)
594 # do some cleanup and sanity checking on common prefix
595 if com_pfx
[-1] == ".":
596 # prefix matches all but file extension: ok
597 # back up one to change 'foo.cc -> o' to 'foo.cc -> .o'
598 com_pfx
= com_pfx
[0:-1]
599 elif com_pfx
[-1] == "/":
600 # common prefix is directory path: OK
603 src0_len
= len(srcs
[0])
604 tgt0_len
= len(tgts
[0])
605 if src0_len
== com_pfx_len
:
606 # source is a substring of target, OK
608 elif tgt0_len
== com_pfx_len
:
609 # target is a substring of source, need to back up to
610 # avoid empty string on RHS of arrow
611 sep_idx
= com_pfx
.rfind(".")
613 com_pfx
= com_pfx
[0:sep_idx
]
616 elif src0_len
> com_pfx_len
and srcs
[0][com_pfx_len
] == ".":
617 # still splitting at file extension: ok
620 # probably a fluke; ignore it
622 # recalculate length in case com_pfx was modified
623 com_pfx_len
= len(com_pfx
)
625 f
= map(lambda s
: s
[com_pfx_len
:], files
)
627 return self
.format
% (com_pfx
, fmt(srcs
), fmt(tgts
))
631 # enable the regression script to use the termcap
632 main
['TERMCAP'] = termcap
634 if GetOption('verbose'):
635 def MakeAction(action
, string
, *args
, **kwargs
):
636 return Action(action
, *args
, **kwargs
)
639 main
['CCCOMSTR'] = Transform("CC")
640 main
['CXXCOMSTR'] = Transform("CXX")
641 main
['ASCOMSTR'] = Transform("AS")
642 main
['ARCOMSTR'] = Transform("AR", 0)
643 main
['LINKCOMSTR'] = Transform("LINK", 0)
644 main
['SHLINKCOMSTR'] = Transform("SHLINK", 0)
645 main
['RANLIBCOMSTR'] = Transform("RANLIB", 0)
646 main
['M4COMSTR'] = Transform("M4")
647 main
['SHCCCOMSTR'] = Transform("SHCC")
648 main
['SHCXXCOMSTR'] = Transform("SHCXX")
651 # Initialize the Link-Time Optimization (LTO) flags
652 main
['LTO_CCFLAGS'] = []
653 main
['LTO_LDFLAGS'] = []
655 # According to the readme, tcmalloc works best if the compiler doesn't
656 # assume that we're using the builtin malloc and friends. These flags
657 # are compiler-specific, so we need to set them after we detect which
658 # compiler we're using.
659 main
['TCMALLOC_CCFLAGS'] = []
661 CXX_version
= readCommand([main
['CXX'],'--version'], exception
=False)
662 CXX_V
= readCommand([main
['CXX'],'-V'], exception
=False)
664 main
['GCC'] = CXX_version
and CXX_version
.find('g++') >= 0
665 main
['CLANG'] = CXX_version
and CXX_version
.find('clang') >= 0
666 if main
['GCC'] + main
['CLANG'] > 1:
667 print 'Error: How can we have two at the same time?'
670 # Set up default C++ compiler flags
671 if main
['GCC'] or main
['CLANG']:
672 # As gcc and clang share many flags, do the common parts here
673 main
.Append(CCFLAGS
=['-pipe'])
674 main
.Append(CCFLAGS
=['-fno-strict-aliasing'])
675 # Enable -Wall and -Wextra and then disable the few warnings that
676 # we consistently violate
677 main
.Append(CCFLAGS
=['-Wall', '-Wundef', '-Wextra',
678 '-Wno-sign-compare', '-Wno-unused-parameter'])
679 # We always compile using C++11
680 main
.Append(CXXFLAGS
=['-std=c++11'])
681 if sys
.platform
.startswith('freebsd'):
682 main
.Append(CCFLAGS
=['-I/usr/local/include'])
683 main
.Append(CXXFLAGS
=['-I/usr/local/include'])
685 main
['FILTER_PSHLINKFLAGS'] = lambda x
: str(x
).replace(' -shared', '')
686 main
['PSHLINKFLAGS'] = main
.subst('${FILTER_PSHLINKFLAGS(SHLINKFLAGS)}')
687 main
['PLINKFLAGS'] = main
.subst('${LINKFLAGS}')
688 shared_partial_flags
= ['-r', '-nostdlib']
689 main
.Append(PSHLINKFLAGS
=shared_partial_flags
)
690 main
.Append(PLINKFLAGS
=shared_partial_flags
)
692 print termcap
.Yellow
+ termcap
.Bold
+ 'Error' + termcap
.Normal
,
693 print "Don't know what compiler options to use for your compiler."
694 print termcap
.Yellow
+ ' compiler:' + termcap
.Normal
, main
['CXX']
695 print termcap
.Yellow
+ ' version:' + termcap
.Normal
,
697 print termcap
.Yellow
+ termcap
.Bold
+ "COMMAND NOT FOUND!" +\
700 print CXX_version
.replace('\n', '<nl>')
701 print " If you're trying to use a compiler other than GCC"
702 print " or clang, there appears to be something wrong with your"
703 print " environment."
705 print " If you are trying to use a compiler other than those listed"
706 print " above you will need to ease fix SConstruct and "
707 print " src/SConscript to support that compiler."
711 # Check for a supported version of gcc. >= 4.8 is chosen for its
712 # level of c++11 support. See
713 # http://gcc.gnu.org/projects/cxx0x.html for details.
714 gcc_version
= readCommand([main
['CXX'], '-dumpversion'], exception
=False)
715 if compareVersions(gcc_version
, "4.8") < 0:
716 print 'Error: gcc version 4.8 or newer required.'
717 print ' Installed version:', gcc_version
720 main
['GCC_VERSION'] = gcc_version
722 # gcc from version 4.8 and above generates "rep; ret" instructions
723 # to avoid performance penalties on certain AMD chips. Older
724 # assemblers detect this as an error, "Error: expecting string
725 # instruction after `rep'"
726 as_version_raw
= readCommand([main
['AS'], '-v', '/dev/null',
728 exception
=False).split()
730 # version strings may contain extra distro-specific
731 # qualifiers, so play it safe and keep only what comes before
733 as_version
= as_version_raw
[-1].split('-')[0] if as_version_raw
else None
735 if not as_version
or compareVersions(as_version
, "2.23") < 0:
736 print termcap
.Yellow
+ termcap
.Bold
+ \
737 'Warning: This combination of gcc and binutils have' + \
738 ' known incompatibilities.\n' + \
739 ' If you encounter build problems, please update ' + \
740 'binutils to 2.23.' + \
743 # Make sure we warn if the user has requested to compile with the
744 # Undefined Benahvior Sanitizer and this version of gcc does not
746 if GetOption('with_ubsan') and \
747 compareVersions(gcc_version
, '4.9') < 0:
748 print termcap
.Yellow
+ termcap
.Bold
+ \
749 'Warning: UBSan is only supported using gcc 4.9 and later.' + \
752 # Add the appropriate Link-Time Optimization (LTO) flags
753 # unless LTO is explicitly turned off. Note that these flags
754 # are only used by the fast target.
755 if not GetOption('no_lto'):
756 # Pass the LTO flag when compiling to produce GIMPLE
757 # output, we merely create the flags here and only append
759 main
['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
761 # Use the same amount of jobs for LTO as we are running
763 main
['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
765 main
.Append(TCMALLOC_CCFLAGS
=['-fno-builtin-malloc', '-fno-builtin-calloc',
766 '-fno-builtin-realloc', '-fno-builtin-free'])
768 # add option to check for undeclared overrides
769 if compareVersions(gcc_version
, "5.0") > 0:
770 main
.Append(CCFLAGS
=['-Wno-error=suggest-override'])
773 # Check for a supported version of clang, >= 3.1 is needed to
774 # support similar features as gcc 4.8. See
775 # http://clang.llvm.org/cxx_status.html for details
776 clang_version_re
= re
.compile(".* version (\d+\.\d+)")
777 clang_version_match
= clang_version_re
.search(CXX_version
)
778 if (clang_version_match
):
779 clang_version
= clang_version_match
.groups()[0]
780 if compareVersions(clang_version
, "3.1") < 0:
781 print 'Error: clang version 3.1 or newer required.'
782 print ' Installed version:', clang_version
785 print 'Error: Unable to determine clang version.'
788 # clang has a few additional warnings that we disable, extraneous
789 # parantheses are allowed due to Ruby's printing of the AST,
790 # finally self assignments are allowed as the generated CPU code
792 main
.Append(CCFLAGS
=['-Wno-parentheses',
794 # Some versions of libstdc++ (4.8?) seem to
795 # use struct hash and class hash
797 '-Wno-mismatched-tags',
800 main
.Append(TCMALLOC_CCFLAGS
=['-fno-builtin'])
802 # On Mac OS X/Darwin we need to also use libc++ (part of XCode) as
803 # opposed to libstdc++, as the later is dated.
804 if sys
.platform
== "darwin":
805 main
.Append(CXXFLAGS
=['-stdlib=libc++'])
806 main
.Append(LIBS
=['c++'])
808 # On FreeBSD we need libthr.
809 if sys
.platform
.startswith('freebsd'):
810 main
.Append(LIBS
=['thr'])
813 print termcap
.Yellow
+ termcap
.Bold
+ 'Error' + termcap
.Normal
,
814 print "Don't know what compiler options to use for your compiler."
815 print termcap
.Yellow
+ ' compiler:' + termcap
.Normal
, main
['CXX']
816 print termcap
.Yellow
+ ' version:' + termcap
.Normal
,
818 print termcap
.Yellow
+ termcap
.Bold
+ "COMMAND NOT FOUND!" +\
821 print CXX_version
.replace('\n', '<nl>')
822 print " If you're trying to use a compiler other than GCC"
823 print " or clang, there appears to be something wrong with your"
824 print " environment."
826 print " If you are trying to use a compiler other than those listed"
827 print " above you will need to ease fix SConstruct and "
828 print " src/SConscript to support that compiler."
831 # Set up common yacc/bison flags (needed for Ruby)
832 main
['YACCFLAGS'] = '-d'
833 main
['YACCHXXFILESUFFIX'] = '.hh'
835 # Do this after we save setting back, or else we'll tack on an
836 # extra 'qdo' every time we run scons.
838 main
['CC'] = main
['BATCH_CMD'] + ' ' + main
['CC']
839 main
['CXX'] = main
['BATCH_CMD'] + ' ' + main
['CXX']
840 main
['AS'] = main
['BATCH_CMD'] + ' ' + main
['AS']
841 main
['AR'] = main
['BATCH_CMD'] + ' ' + main
['AR']
842 main
['RANLIB'] = main
['BATCH_CMD'] + ' ' + main
['RANLIB']
844 if sys
.platform
== 'cygwin':
845 # cygwin has some header file issues...
846 main
.Append(CCFLAGS
=["-Wno-uninitialized"])
848 # Check for the protobuf compiler
849 protoc_version
= readCommand([main
['PROTOC'], '--version'],
850 exception
='').split()
852 # First two words should be "libprotoc x.y.z"
853 if len(protoc_version
) < 2 or protoc_version
[0] != 'libprotoc':
854 print termcap
.Yellow
+ termcap
.Bold
+ \
855 'Warning: Protocol buffer compiler (protoc) not found.\n' + \
856 ' Please install protobuf-compiler for tracing support.' + \
858 main
['PROTOC'] = False
860 # Based on the availability of the compress stream wrappers,
862 min_protoc_version
= '2.1.0'
863 if compareVersions(protoc_version
[1], min_protoc_version
) < 0:
864 print termcap
.Yellow
+ termcap
.Bold
+ \
865 'Warning: protoc version', min_protoc_version
, \
866 'or newer required.\n' + \
867 ' Installed version:', protoc_version
[1], \
869 main
['PROTOC'] = False
871 # Attempt to determine the appropriate include path and
872 # library path using pkg-config, that means we also need to
873 # check for pkg-config. Note that it is possible to use
874 # protobuf without the involvement of pkg-config. Later on we
875 # check go a library config check and at that point the test
876 # will fail if libprotobuf cannot be found.
877 if readCommand(['pkg-config', '--version'], exception
=''):
879 # Attempt to establish what linking flags to add for protobuf
881 main
.ParseConfig('pkg-config --cflags --libs-only-L protobuf')
883 print termcap
.Yellow
+ termcap
.Bold
+ \
884 'Warning: pkg-config could not get protobuf flags.' + \
888 # Check for 'timeout' from GNU coreutils. If present, regressions will
889 # be run with a time limit. We require version 8.13 since we rely on
890 # support for the '--foreground' option.
891 if sys
.platform
.startswith('freebsd'):
892 timeout_lines
= readCommand(['gtimeout', '--version'],
893 exception
='').splitlines()
895 timeout_lines
= readCommand(['timeout', '--version'],
896 exception
='').splitlines()
897 # Get the first line and tokenize it
898 timeout_version
= timeout_lines
[0].split() if timeout_lines
else []
899 main
['TIMEOUT'] = timeout_version
and \
900 compareVersions(timeout_version
[-1], '8.13') >= 0
902 # Add a custom Check function to test for structure members.
903 def CheckMember(context
, include
, decl
, member
, include_quotes
="<>"):
904 context
.Message("Checking for member %s in %s..." %
910 (void)test.%(member)s;
913 """ % { "header" : include_quotes
[0] + include
+ include_quotes
[1],
918 ret
= context
.TryCompile(text
, extension
=".cc")
922 # Platform-specific configuration. Note again that we assume that all
923 # builds under a given build root run on the same host platform.
924 conf
= Configure(main
,
925 conf_dir
= joinpath(build_root
, '.scons_config'),
926 log_file
= joinpath(build_root
, 'scons_config.log'),
928 'CheckMember' : CheckMember
,
931 # Check if we should compile a 64 bit binary on Mac OS X/Darwin
934 uname
= platform
.uname()
935 if uname
[0] == 'Darwin' and compareVersions(uname
[2], '9.0.0') >= 0:
936 if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
937 main
.Append(CCFLAGS
=['-arch', 'x86_64'])
938 main
.Append(CFLAGS
=['-arch', 'x86_64'])
939 main
.Append(LINKFLAGS
=['-arch', 'x86_64'])
940 main
.Append(ASFLAGS
=['-arch', 'x86_64'])
944 # Recent versions of scons substitute a "Null" object for Configure()
945 # when configuration isn't necessary, e.g., if the "--help" option is
946 # present. Unfortuantely this Null object always returns false,
947 # breaking all our configuration checks. We replace it with our own
948 # more optimistic null object that returns True instead.
950 def NullCheck(*args
, **kwargs
):
954 def __init__(self
, env
):
958 def __getattr__(self
, mname
):
961 conf
= NullConf(main
)
963 # Cache build files in the supplied directory.
964 if main
['M5_BUILD_CACHE']:
965 print 'Using build cache located at', main
['M5_BUILD_CACHE']
966 CacheDir(main
['M5_BUILD_CACHE'])
968 main
['USE_PYTHON'] = not GetOption('without_python')
969 if main
['USE_PYTHON']:
970 # Find Python include and library directories for embedding the
971 # interpreter. We rely on python-config to resolve the appropriate
972 # includes and linker flags. ParseConfig does not seem to understand
973 # the more exotic linker flags such as -Xlinker and -export-dynamic so
974 # we add them explicitly below. If you want to link in an alternate
975 # version of python, see above for instructions on how to invoke
976 # scons with the appropriate PATH set.
978 # First we check if python2-config exists, else we use python-config
979 python_config
= readCommand(['which', 'python2-config'],
980 exception
='').strip()
981 if not os
.path
.exists(python_config
):
982 python_config
= readCommand(['which', 'python-config'],
983 exception
='').strip()
984 py_includes
= readCommand([python_config
, '--includes'],
985 exception
='').split()
986 # Strip the -I from the include folders before adding them to the
988 main
.Append(CPPPATH
=map(lambda inc
: inc
[2:], py_includes
))
990 # Read the linker flags and split them into libraries and other link
991 # flags. The libraries are added later through the call the CheckLib.
992 py_ld_flags
= readCommand([python_config
, '--ldflags'],
993 exception
='').split()
995 for lib
in py_ld_flags
:
996 if not lib
.startswith('-l'):
997 main
.Append(LINKFLAGS
=[lib
])
1000 if lib
not in py_libs
:
1003 # verify that this stuff works
1004 if not conf
.CheckHeader('Python.h', '<>'):
1005 print "Error: can't find Python.h header in", py_includes
1006 print "Install Python headers (package python-dev on Ubuntu and RedHat)"
1010 if not conf
.CheckLib(lib
):
1011 print "Error: can't find library %s required by python" % lib
1014 # On Solaris you need to use libsocket for socket ops
1015 if not conf
.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
1016 if not conf
.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
1017 print "Can't find library with socket calls (e.g. accept())"
1020 # Check for zlib. If the check passes, libz will be automatically
1021 # added to the LIBS environment variable.
1022 if not conf
.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
1023 print 'Error: did not find needed zlib compression library '\
1024 'and/or zlib.h header file.'
1025 print ' Please install zlib and try again.'
1028 # If we have the protobuf compiler, also make sure we have the
1029 # development libraries. If the check passes, libprotobuf will be
1030 # automatically added to the LIBS environment variable. After
1031 # this, we can use the HAVE_PROTOBUF flag to determine if we have
1032 # got both protoc and libprotobuf available.
1033 main
['HAVE_PROTOBUF'] = main
['PROTOC'] and \
1034 conf
.CheckLibWithHeader('protobuf', 'google/protobuf/message.h',
1035 'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;')
1037 # If we have the compiler but not the library, print another warning.
1038 if main
['PROTOC'] and not main
['HAVE_PROTOBUF']:
1039 print termcap
.Yellow
+ termcap
.Bold
+ \
1040 'Warning: did not find protocol buffer library and/or headers.\n' + \
1041 ' Please install libprotobuf-dev for tracing support.' + \
1045 have_posix_clock
= \
1046 conf
.CheckLibWithHeader(None, 'time.h', 'C',
1047 'clock_nanosleep(0,0,NULL,NULL);') or \
1048 conf
.CheckLibWithHeader('rt', 'time.h', 'C',
1049 'clock_nanosleep(0,0,NULL,NULL);')
1051 have_posix_timers
= \
1052 conf
.CheckLibWithHeader([None, 'rt'], [ 'time.h', 'signal.h' ], 'C',
1053 'timer_create(CLOCK_MONOTONIC, NULL, NULL);')
1055 if not GetOption('without_tcmalloc'):
1056 if conf
.CheckLib('tcmalloc'):
1057 main
.Append(CCFLAGS
=main
['TCMALLOC_CCFLAGS'])
1058 elif conf
.CheckLib('tcmalloc_minimal'):
1059 main
.Append(CCFLAGS
=main
['TCMALLOC_CCFLAGS'])
1061 print termcap
.Yellow
+ termcap
.Bold
+ \
1062 "You can get a 12% performance improvement by "\
1063 "installing tcmalloc (libgoogle-perftools-dev package "\
1064 "on Ubuntu or RedHat)." + termcap
.Normal
1067 # Detect back trace implementations. The last implementation in the
1068 # list will be used by default.
1069 backtrace_impls
= [ "none" ]
1071 if conf
.CheckLibWithHeader(None, 'execinfo.h', 'C',
1072 'backtrace_symbols_fd((void*)0, 0, 0);'):
1073 backtrace_impls
.append("glibc")
1074 elif conf
.CheckLibWithHeader('execinfo', 'execinfo.h', 'C',
1075 'backtrace_symbols_fd((void*)0, 0, 0);'):
1076 # NetBSD and FreeBSD need libexecinfo.
1077 backtrace_impls
.append("glibc")
1078 main
.Append(LIBS
=['execinfo'])
1080 if backtrace_impls
[-1] == "none":
1081 default_backtrace_impl
= "none"
1082 print termcap
.Yellow
+ termcap
.Bold
+ \
1083 "No suitable back trace implementation found." + \
1086 if not have_posix_clock
:
1087 print "Can't find library for POSIX clocks."
1089 # Check for <fenv.h> (C99 FP environment control)
1090 have_fenv
= conf
.CheckHeader('fenv.h', '<>')
1092 print "Warning: Header file <fenv.h> not found."
1093 print " This host has no IEEE FP rounding mode control."
1095 # Check if we should enable KVM-based hardware virtualization. The API
1096 # we rely on exists since version 2.6.36 of the kernel, but somehow
1097 # the KVM_API_VERSION does not reflect the change. We test for one of
1098 # the types as a fall back.
1099 have_kvm
= conf
.CheckHeader('linux/kvm.h', '<>')
1101 print "Info: Compatible header file <linux/kvm.h> not found, " \
1102 "disabling KVM support."
1104 # x86 needs support for xsave. We test for the structure here since we
1105 # won't be able to run new tests by the time we know which ISA we're
1107 have_kvm_xsave
= conf
.CheckTypeSize('struct kvm_xsave',
1108 '#include <linux/kvm.h>') != 0
1110 # Check if the requested target ISA is compatible with the host
1111 def is_isa_kvm_compatible(isa
):
1114 host_isa
= platform
.machine()
1116 print "Warning: Failed to determine host ISA."
1119 if not have_posix_timers
:
1120 print "Warning: Can not enable KVM, host seems to lack support " \
1125 return host_isa
in ( "armv7l", "aarch64" )
1127 if host_isa
!= "x86_64":
1130 if not have_kvm_xsave
:
1131 print "KVM on x86 requires xsave support in kernel headers."
1139 # Check if the exclude_host attribute is available. We want this to
1140 # get accurate instruction counts in KVM.
1141 main
['HAVE_PERF_ATTR_EXCLUDE_HOST'] = conf
.CheckMember(
1142 'linux/perf_event.h', 'struct perf_event_attr', 'exclude_host')
1145 ######################################################################
1147 # Finish the configuration
1149 main
= conf
.Finish()
1151 ######################################################################
1153 # Collect all non-global variables
1156 # Define the universe of supported ISAs
1158 all_gpu_isa_list
= [ ]
1159 Export('all_isa_list')
1160 Export('all_gpu_isa_list')
1162 class CpuModel(object):
1163 '''The CpuModel class encapsulates everything the ISA parser needs to
1164 know about a particular CPU model.'''
1166 # Dict of available CPU model objects. Accessible as CpuModel.dict.
1169 # Constructor. Automatically adds models to CpuModel.dict.
1170 def __init__(self
, name
, default
=False):
1171 self
.name
= name
# name of model
1173 # This cpu is enabled by default
1174 self
.default
= default
1177 if name
in CpuModel
.dict:
1178 raise AttributeError, "CpuModel '%s' already registered" % name
1179 CpuModel
.dict[name
] = self
1183 # Sticky variables get saved in the variables file so they persist from
1184 # one invocation to the next (unless overridden, in which case the new
1185 # value becomes sticky).
1186 sticky_vars
= Variables(args
=ARGUMENTS
)
1187 Export('sticky_vars')
1189 # Sticky variables that should be exported
1191 Export('export_vars')
1195 Export('all_protocols')
1197 Export('protocol_dirs')
1199 Export('slicc_includes')
1201 # Walk the tree and execute all SConsopts scripts that wil add to the
1203 if GetOption('verbose'):
1204 print "Reading SConsopts"
1205 for bdir
in [ base_dir
] + extras_dir_list
:
1207 print "Error: directory '%s' does not exist" % bdir
1209 for root
, dirs
, files
in os
.walk(bdir
):
1210 if 'SConsopts' in files
:
1211 if GetOption('verbose'):
1212 print "Reading", joinpath(root
, 'SConsopts')
1213 SConscript(joinpath(root
, 'SConsopts'))
1216 all_gpu_isa_list
.sort()
1218 sticky_vars
.AddVariables(
1219 EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list
),
1220 EnumVariable('TARGET_GPU_ISA', 'Target GPU ISA', 'hsail', all_gpu_isa_list
),
1221 ListVariable('CPU_MODELS', 'CPU models',
1222 sorted(n
for n
,m
in CpuModel
.dict.iteritems() if m
.default
),
1223 sorted(CpuModel
.dict.keys())),
1224 BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
1226 BoolVariable('SS_COMPATIBLE_FP',
1227 'Make floating-point results compatible with SimpleScalar',
1229 BoolVariable('USE_SSE2',
1230 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
1232 BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock
),
1233 BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv
),
1234 BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False),
1235 BoolVariable('USE_KVM', 'Enable hardware virtualized (KVM) CPU models', have_kvm
),
1236 BoolVariable('BUILD_GPU', 'Build the compute-GPU model', False),
1237 EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None',
1239 EnumVariable('BACKTRACE_IMPL', 'Post-mortem dump implementation',
1240 backtrace_impls
[-1], backtrace_impls
)
1243 # These variables get exported to #defines in config/*.hh (see src/SConscript).
1244 export_vars
+= ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'TARGET_GPU_ISA',
1245 'CP_ANNOTATE', 'USE_POSIX_CLOCK', 'USE_KVM', 'PROTOCOL',
1246 'HAVE_PROTOBUF', 'HAVE_PERF_ATTR_EXCLUDE_HOST']
1248 ###################################################
1250 # Define a SCons builder for configuration flag headers.
1252 ###################################################
1254 # This function generates a config header file that #defines the
1255 # variable symbol to the current variable setting (0 or 1). The source
1256 # operands are the name of the variable and a Value node containing the
1257 # value of the variable.
1258 def build_config_file(target
, source
, env
):
1259 (variable
, value
) = [s
.get_contents() for s
in source
]
1260 f
= file(str(target
[0]), 'w')
1261 print >> f
, '#define', variable
, value
1265 # Combine the two functions into a scons Action object.
1266 config_action
= MakeAction(build_config_file
, Transform("CONFIG H", 2))
1268 # The emitter munges the source & target node lists to reflect what
1269 # we're really doing.
1270 def config_emitter(target
, source
, env
):
1271 # extract variable name from Builder arg
1272 variable
= str(target
[0])
1273 # True target is config header file
1274 target
= joinpath('config', variable
.lower() + '.hh')
1276 if isinstance(val
, bool):
1277 # Force value to 0/1
1279 elif isinstance(val
, str):
1280 val
= '"' + val
+ '"'
1282 # Sources are variable name & value (packaged in SCons Value nodes)
1283 return ([target
], [Value(variable
), Value(val
)])
1285 config_builder
= Builder(emitter
= config_emitter
, action
= config_action
)
1287 main
.Append(BUILDERS
= { 'ConfigFile' : config_builder
})
1289 ###################################################
1291 # Builders for static and shared partially linked object files.
1293 ###################################################
1295 partial_static_builder
= Builder(action
=SCons
.Defaults
.LinkAction
,
1296 src_suffix
='$OBJSUFFIX',
1297 src_builder
=['StaticObject', 'Object'],
1298 LINKFLAGS
='$PLINKFLAGS',
1301 def partial_shared_emitter(target
, source
, env
):
1303 tgt
.attributes
.shared
= 1
1304 return (target
, source
)
1305 partial_shared_builder
= Builder(action
=SCons
.Defaults
.ShLinkAction
,
1306 emitter
=partial_shared_emitter
,
1307 src_suffix
='$SHOBJSUFFIX',
1308 src_builder
='SharedObject',
1309 SHLINKFLAGS
='$PSHLINKFLAGS',
1312 main
.Append(BUILDERS
= { 'PartialShared' : partial_shared_builder
,
1313 'PartialStatic' : partial_static_builder
})
1315 # builds in ext are shared across all configs in the build root.
1316 ext_dir
= abspath(joinpath(str(main
.root
), 'ext'))
1317 for root
, dirs
, files
in os
.walk(ext_dir
):
1318 if 'SConscript' in files
:
1319 build_dir
= os
.path
.relpath(root
, ext_dir
)
1320 main
.SConscript(joinpath(root
, 'SConscript'),
1321 variant_dir
=joinpath(build_root
, build_dir
))
1323 main
.Prepend(CPPPATH
=Dir('ext/pybind11/include/'))
1325 ###################################################
1327 # This function is used to set up a directory with switching headers
1329 ###################################################
1331 main
['ALL_ISA_LIST'] = all_isa_list
1332 main
['ALL_GPU_ISA_LIST'] = all_gpu_isa_list
1334 def make_switching_dir(dname
, switch_headers
, env
):
1335 # Generate the header. target[0] is the full path of the output
1336 # header to generate. 'source' is a dummy variable, since we get the
1337 # list of ISAs from env['ALL_ISA_LIST'].
1338 def gen_switch_hdr(target
, source
, env
):
1339 fname
= str(target
[0])
1340 isa
= env
['TARGET_ISA'].lower()
1342 f
= open(fname
, 'w')
1343 print >>f
, '#include "%s/%s/%s"' % (dname
, isa
, basename(fname
))
1346 print "Failed to create %s" % fname
1349 # Build SCons Action object. 'varlist' specifies env vars that this
1350 # action depends on; when env['ALL_ISA_LIST'] changes these actions
1351 # should get re-executed.
1352 switch_hdr_action
= MakeAction(gen_switch_hdr
,
1353 Transform("GENERATE"), varlist
=['ALL_ISA_LIST'])
1355 # Instantiate actions for each header
1356 for hdr
in switch_headers
:
1357 env
.Command(hdr
, [], switch_hdr_action
)
1359 isa_target
= Dir('.').up().name
.lower().replace('_', '-')
1360 all_isa_deps
[isa_target
] = None
1362 Export('make_switching_dir')
1364 def make_gpu_switching_dir(dname
, switch_headers
, env
):
1365 # Generate the header. target[0] is the full path of the output
1366 # header to generate. 'source' is a dummy variable, since we get the
1367 # list of ISAs from env['ALL_ISA_LIST'].
1368 def gen_switch_hdr(target
, source
, env
):
1369 fname
= str(target
[0])
1371 isa
= env
['TARGET_GPU_ISA'].lower()
1374 f
= open(fname
, 'w')
1375 print >>f
, '#include "%s/%s/%s"' % (dname
, isa
, basename(fname
))
1378 print "Failed to create %s" % fname
1381 # Build SCons Action object. 'varlist' specifies env vars that this
1382 # action depends on; when env['ALL_ISA_LIST'] changes these actions
1383 # should get re-executed.
1384 switch_hdr_action
= MakeAction(gen_switch_hdr
,
1385 Transform("GENERATE"), varlist
=['ALL_ISA_GPU_LIST'])
1387 # Instantiate actions for each header
1388 for hdr
in switch_headers
:
1389 env
.Command(hdr
, [], switch_hdr_action
)
1391 Export('make_gpu_switching_dir')
1393 # all-isas -> all-deps -> all-environs -> all_targets
1394 main
.Alias('#all-isas', [])
1395 main
.Alias('#all-deps', '#all-isas')
1397 # Dummy target to ensure all environments are created before telling
1398 # SCons what to actually make (the command line arguments). We attach
1399 # them to the dependence graph after the environments are complete.
1400 ORIG_BUILD_TARGETS
= list(BUILD_TARGETS
) # force a copy; gets closure to work.
1401 def environsComplete(target
, source
, env
):
1402 for t
in ORIG_BUILD_TARGETS
:
1403 main
.Depends('#all-targets', t
)
1405 # Each build/* switching_dir attaches its *-environs target to #all-environs.
1406 main
.Append(BUILDERS
= {'CompleteEnvirons' :
1407 Builder(action
=MakeAction(environsComplete
, None))})
1408 main
.CompleteEnvirons('#all-environs', [])
1410 def doNothing(**ignored
): pass
1411 main
.Append(BUILDERS
= {'Dummy': Builder(action
=MakeAction(doNothing
, None))})
1413 # The final target to which all the original targets ultimately get attached.
1414 main
.Dummy('#all-targets', '#all-environs')
1415 BUILD_TARGETS
[:] = ['#all-targets']
1417 ###################################################
1419 # Define build environments for selected configurations.
1421 ###################################################
1423 def variant_name(path
):
1424 return os
.path
.basename(path
).lower().replace('_', '-')
1425 main
['variant_name'] = variant_name
1426 main
['VARIANT_NAME'] = '${variant_name(BUILDDIR)}'
1428 for variant_path
in variant_paths
:
1429 if not GetOption('silent'):
1430 print "Building in", variant_path
1432 # Make a copy of the build-root environment to use for this config.
1434 env
['BUILDDIR'] = variant_path
1436 # variant_dir is the tail component of build path, and is used to
1437 # determine the build parameters (e.g., 'ALPHA_SE')
1438 (build_root
, variant_dir
) = splitpath(variant_path
)
1440 # Set env variables according to the build directory config.
1441 sticky_vars
.files
= []
1442 # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
1443 # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
1444 # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
1445 current_vars_file
= joinpath(build_root
, 'variables', variant_dir
)
1446 if isfile(current_vars_file
):
1447 sticky_vars
.files
.append(current_vars_file
)
1448 if not GetOption('silent'):
1449 print "Using saved variables file %s" % current_vars_file
1451 # Build dir-specific variables file doesn't exist.
1453 # Make sure the directory is there so we can create it later
1454 opt_dir
= dirname(current_vars_file
)
1455 if not isdir(opt_dir
):
1458 # Get default build variables from source tree. Variables are
1459 # normally determined by name of $VARIANT_DIR, but can be
1460 # overridden by '--default=' arg on command line.
1461 default
= GetOption('default')
1462 opts_dir
= joinpath(main
.root
.abspath
, 'build_opts')
1464 default_vars_files
= [joinpath(build_root
, 'variables', default
),
1465 joinpath(opts_dir
, default
)]
1467 default_vars_files
= [joinpath(opts_dir
, variant_dir
)]
1468 existing_files
= filter(isfile
, default_vars_files
)
1470 default_vars_file
= existing_files
[0]
1471 sticky_vars
.files
.append(default_vars_file
)
1472 print "Variables file %s not found,\n using defaults in %s" \
1473 % (current_vars_file
, default_vars_file
)
1475 print "Error: cannot find variables file %s or " \
1476 "default file(s) %s" \
1477 % (current_vars_file
, ' or '.join(default_vars_files
))
1480 # Apply current variable settings to env
1481 sticky_vars
.Update(env
)
1483 help_texts
["local_vars"] += \
1484 "Build variables for %s:\n" % variant_dir \
1485 + sticky_vars
.GenerateHelpText(env
)
1487 # Process variable settings.
1489 if not have_fenv
and env
['USE_FENV']:
1490 print "Warning: <fenv.h> not available; " \
1491 "forcing USE_FENV to False in", variant_dir
+ "."
1492 env
['USE_FENV'] = False
1494 if not env
['USE_FENV']:
1495 print "Warning: No IEEE FP rounding mode control in", variant_dir
+ "."
1496 print " FP results may deviate slightly from other platforms."
1499 env
.Append(LIBS
=['efence'])
1503 print "Warning: Can not enable KVM, host seems to lack KVM support"
1504 env
['USE_KVM'] = False
1505 elif not is_isa_kvm_compatible(env
['TARGET_ISA']):
1506 print "Info: KVM support disabled due to unsupported host and " \
1507 "target ISA combination"
1508 env
['USE_KVM'] = False
1510 if env
['BUILD_GPU']:
1511 env
.Append(CPPDEFINES
=['BUILD_GPU'])
1513 # Warn about missing optional functionality
1515 if not main
['HAVE_PERF_ATTR_EXCLUDE_HOST']:
1516 print "Warning: perf_event headers lack support for the " \
1517 "exclude_host attribute. KVM instruction counts will " \
1520 # Save sticky variable settings back to current variables file
1521 sticky_vars
.Save(current_vars_file
, env
)
1524 env
.Append(CCFLAGS
=['-msse2'])
1526 # The src/SConscript file sets up the build rules in 'env' according
1527 # to the configured variables. It returns a list of environments,
1528 # one for each variant build (debug, opt, etc.)
1529 SConscript('src/SConscript', variant_dir
= variant_path
, exports
= 'env')
1531 def pairwise(iterable
):
1532 "s -> (s0,s1), (s1,s2), (s2, s3), ..."
1533 a
, b
= itertools
.tee(iterable
)
1535 return itertools
.izip(a
, b
)
1537 # Create false dependencies so SCons will parse ISAs, establish
1538 # dependencies, and setup the build Environments serially. Either
1539 # SCons (likely) and/or our SConscripts (possibly) cannot cope with -j
1540 # greater than 1. It appears to be standard race condition stuff; it
1541 # doesn't always fail, but usually, and the behaviors are different.
1542 # Every time I tried to remove this, builds would fail in some
1543 # creative new way. So, don't do that. You'll want to, though, because
1544 # tests/SConscript takes a long time to make its Environments.
1545 for t1
, t2
in pairwise(sorted(all_isa_deps
.iterkeys())):
1546 main
.Depends('#%s-deps' % t2
, '#%s-deps' % t1
)
1547 main
.Depends('#%s-environs' % t2
, '#%s-environs' % t1
)
1551 Usage: scons [scons options] [build variables] [target(s)]
1553 Extra scons options:
1556 Global build variables: