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