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")
263 gitdir
= main
.root
.Dir(".git")
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. This
269 script will now install the hook in your %s.
270 Press enter to continue, or ctrl-c to abort: """
272 mercurial_style_message
= style_message
% ".hg/hgrc file"
273 git_style_message
= style_message
% ".git/hooks/ directory"
275 mercurial_style_upgrade_message
= """
276 Your Mercurial style hooks are not up-to-date. This script will now
277 try to automatically update them. A backup of your hgrc will be saved
279 Press enter to continue, or ctrl-c to abort: """
281 mercurial_style_hook
= """
282 # The following lines were automatically added by gem5/SConstruct
283 # to provide the gem5 style-checking hooks
285 hgstyle = %s/util/hgstyle.py
288 pretxncommit.style = python:hgstyle.check_style
289 pre-qrefresh.style = python:hgstyle.check_style
290 # End of SConstruct additions
292 """ % (main
.root
.abspath
)
294 mercurial_lib_not_found
= """
295 Mercurial libraries cannot be found, ignoring style hook. If
296 you are a gem5 developer, please fix this and run the style
297 hook. It is important.
300 # Check for style hook and prompt for installation if it's not there.
301 # Skip this if --ignore-style was specified, there's no interactive
302 # terminal to prompt, or no recognized revision control system can be
304 ignore_style
= GetOption('ignore_style') or not sys
.stdin
.isatty()
306 # Try wire up Mercurial to the style hooks
307 if not ignore_style
and hgdir
.exists():
309 style_hooks
= tuple()
310 hgrc
= hgdir
.File('hgrc')
311 hgrc_old
= hgdir
.File('hgrc.old')
313 from mercurial
import ui
315 ui
.readconfig(hgrc
.abspath
)
316 style_hooks
= (ui
.config('hooks', 'pretxncommit.style', None),
317 ui
.config('hooks', 'pre-qrefresh.style', None))
318 style_hook
= all(style_hooks
)
319 style_extension
= ui
.config('extensions', 'style', None)
321 print mercurial_lib_not_found
323 if "python:style.check_style" in style_hooks
:
324 # Try to upgrade the style hooks
325 print mercurial_style_upgrade_message
326 # continue unless user does ctrl-c/ctrl-d etc.
330 print "Input exception, exiting scons.\n"
332 shutil
.copyfile(hgrc
.abspath
, hgrc_old
.abspath
)
333 re_style_hook
= re
.compile(r
"^([^=#]+)\.style\s*=\s*([^#\s]+).*")
334 re_style_extension
= re
.compile("style\s*=\s*([^#\s]+).*")
335 with
open(hgrc_old
.abspath
, 'r') as old
, \
336 open(hgrc
.abspath
, 'w') as new
:
339 m_hook
= re_style_hook
.match(l
)
340 m_ext
= re_style_extension
.match(l
)
342 hook
, check
= m_hook
.groups()
343 if check
!= "python:style.check_style":
344 print "Warning: %s.style is using a non-default " \
345 "checker: %s" % (hook
, check
)
346 if hook
not in ("pretxncommit", "pre-qrefresh"):
347 print "Warning: Updating unknown style hook: %s" % hook
349 l
= "%s.style = python:hgstyle.check_style\n" % hook
350 elif m_ext
and m_ext
.group(1) == style_extension
:
351 l
= "hgstyle = %s/util/hgstyle.py\n" % main
.root
.abspath
355 print mercurial_style_message
,
356 # continue unless user does ctrl-c/ctrl-d etc.
360 print "Input exception, exiting scons.\n"
362 hgrc_path
= '%s/.hg/hgrc' % main
.root
.abspath
363 print "Adding style hook to", hgrc_path
, "\n"
365 with
open(hgrc_path
, 'a') as f
:
366 f
.write(mercurial_style_hook
)
368 print "Error updating", hgrc_path
371 # Try to wire up git to the style hooks
372 git_pre_commit_hook
= gitdir
.File("hooks/pre-commit")
373 if not ignore_style
and gitdir
.exists() and not git_pre_commit_hook
.exists():
374 git_style_script
= File("util/git-pre-commit.py")
376 print git_style_message
,
380 print "Input exception, exiting scons.\n"
384 rel_style_script
= os
.path
.relpath(
385 git_style_script
.get_abspath(),
386 git_pre_commit_hook
.Dir(".").get_abspath())
387 os
.symlink(rel_style_script
, git_pre_commit_hook
.get_abspath())
389 print "Error updating git pre-commit hook"
393 ###################################################
395 # Figure out which configurations to set up based on the path(s) of
398 ###################################################
400 # Find default configuration & binary.
401 Default(environ
.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug'))
403 # helper function: find last occurrence of element in list
404 def rfind(l
, elt
, offs
= -1):
405 for i
in range(len(l
)+offs
, 0, -1):
408 raise ValueError, "element not found"
410 # Take a list of paths (or SCons Nodes) and return a list with all
411 # paths made absolute and ~-expanded. Paths will be interpreted
412 # relative to the launch directory unless a different root is provided
413 def makePathListAbsolute(path_list
, root
=GetLaunchDir()):
414 return [abspath(joinpath(root
, expanduser(str(p
))))
417 # Each target must have 'build' in the interior of the path; the
418 # directory below this will determine the build parameters. For
419 # example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
420 # recognize that ALPHA_SE specifies the configuration because it
421 # follow 'build' in the build path.
423 # The funky assignment to "[:]" is needed to replace the list contents
424 # in place rather than reassign the symbol to a new list, which
425 # doesn't work (obviously!).
426 BUILD_TARGETS
[:] = makePathListAbsolute(BUILD_TARGETS
)
428 # Generate a list of the unique build roots and configs that the
429 # collected targets reference.
432 for t
in BUILD_TARGETS
:
433 path_dirs
= t
.split('/')
435 build_top
= rfind(path_dirs
, 'build', -2)
437 print "Error: no non-leaf 'build' dir found on target path", t
439 this_build_root
= joinpath('/',*path_dirs
[:build_top
+1])
441 build_root
= this_build_root
443 if this_build_root
!= build_root
:
444 print "Error: build targets not under same build root\n"\
445 " %s\n %s" % (build_root
, this_build_root
)
447 variant_path
= joinpath('/',*path_dirs
[:build_top
+2])
448 if variant_path
not in variant_paths
:
449 variant_paths
.append(variant_path
)
451 # Make sure build_root exists (might not if this is the first build there)
452 if not isdir(build_root
):
454 main
['BUILDROOT'] = build_root
458 main
.SConsignFile(joinpath(build_root
, "sconsign"))
460 # Default duplicate option is to use hard links, but this messes up
461 # when you use emacs to edit a file in the target dir, as emacs moves
462 # file to file~ then copies to file, breaking the link. Symbolic
463 # (soft) links work better.
464 main
.SetOption('duplicate', 'soft-copy')
467 # Set up global sticky variables... these are common to an entire build
468 # tree (not specific to a particular build like ALPHA_SE)
471 global_vars_file
= joinpath(build_root
, 'variables.global')
473 global_vars
= Variables(global_vars_file
, args
=ARGUMENTS
)
475 global_vars
.AddVariables(
476 ('CC', 'C compiler', environ
.get('CC', main
['CC'])),
477 ('CXX', 'C++ compiler', environ
.get('CXX', main
['CXX'])),
478 ('SWIG', 'SWIG tool', environ
.get('SWIG', main
['SWIG'])),
479 ('PROTOC', 'protoc tool', environ
.get('PROTOC', 'protoc')),
480 ('BATCH', 'Use batch pool for build and tests', False),
481 ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
482 ('M5_BUILD_CACHE', 'Cache built objects in this directory', False),
483 ('EXTRAS', 'Add extra directories to the compilation', '')
486 # Update main environment with values from ARGUMENTS & global_vars_file
487 global_vars
.Update(main
)
488 help_texts
["global_vars"] += global_vars
.GenerateHelpText(main
)
490 # Save sticky variable settings back to current variables file
491 global_vars
.Save(global_vars_file
, main
)
493 # Parse EXTRAS variable to build list of all directories where we're
494 # look for sources etc. This list is exported as extras_dir_list.
495 base_dir
= main
.srcdir
.abspath
497 extras_dir_list
= makePathListAbsolute(main
['EXTRAS'].split(':'))
502 Export('extras_dir_list')
504 # the ext directory should be on the #includes path
505 main
.Append(CPPPATH
=[Dir('ext')])
507 def strip_build_path(path
, env
):
509 variant_base
= env
['BUILDROOT'] + os
.path
.sep
510 if path
.startswith(variant_base
):
511 path
= path
[len(variant_base
):]
512 elif path
.startswith('build/'):
516 # Generate a string of the form:
517 # common/path/prefix/src1, src2 -> tgt1, tgt2
518 # to print while building.
519 class Transform(object):
520 # all specific color settings should be here and nowhere else
521 tool_color
= termcap
.Normal
522 pfx_color
= termcap
.Yellow
523 srcs_color
= termcap
.Yellow
+ termcap
.Bold
524 arrow_color
= termcap
.Blue
+ termcap
.Bold
525 tgts_color
= termcap
.Yellow
+ termcap
.Bold
527 def __init__(self
, tool
, max_sources
=99):
528 self
.format
= self
.tool_color
+ (" [%8s] " % tool
) \
529 + self
.pfx_color
+ "%s" \
530 + self
.srcs_color
+ "%s" \
531 + self
.arrow_color
+ " -> " \
532 + self
.tgts_color
+ "%s" \
534 self
.max_sources
= max_sources
536 def __call__(self
, target
, source
, env
, for_signature
=None):
537 # truncate source list according to max_sources param
538 source
= source
[0:self
.max_sources
]
540 return strip_build_path(str(f
), env
)
542 srcs
= map(strip
, source
)
545 tgts
= map(strip
, target
)
546 # surprisingly, os.path.commonprefix is a dumb char-by-char string
547 # operation that has nothing to do with paths.
548 com_pfx
= os
.path
.commonprefix(srcs
+ tgts
)
549 com_pfx_len
= len(com_pfx
)
551 # do some cleanup and sanity checking on common prefix
552 if com_pfx
[-1] == ".":
553 # prefix matches all but file extension: ok
554 # back up one to change 'foo.cc -> o' to 'foo.cc -> .o'
555 com_pfx
= com_pfx
[0:-1]
556 elif com_pfx
[-1] == "/":
557 # common prefix is directory path: OK
560 src0_len
= len(srcs
[0])
561 tgt0_len
= len(tgts
[0])
562 if src0_len
== com_pfx_len
:
563 # source is a substring of target, OK
565 elif tgt0_len
== com_pfx_len
:
566 # target is a substring of source, need to back up to
567 # avoid empty string on RHS of arrow
568 sep_idx
= com_pfx
.rfind(".")
570 com_pfx
= com_pfx
[0:sep_idx
]
573 elif src0_len
> com_pfx_len
and srcs
[0][com_pfx_len
] == ".":
574 # still splitting at file extension: ok
577 # probably a fluke; ignore it
579 # recalculate length in case com_pfx was modified
580 com_pfx_len
= len(com_pfx
)
582 f
= map(lambda s
: s
[com_pfx_len
:], files
)
584 return self
.format
% (com_pfx
, fmt(srcs
), fmt(tgts
))
588 # enable the regression script to use the termcap
589 main
['TERMCAP'] = termcap
591 if GetOption('verbose'):
592 def MakeAction(action
, string
, *args
, **kwargs
):
593 return Action(action
, *args
, **kwargs
)
596 main
['CCCOMSTR'] = Transform("CC")
597 main
['CXXCOMSTR'] = Transform("CXX")
598 main
['ASCOMSTR'] = Transform("AS")
599 main
['SWIGCOMSTR'] = Transform("SWIG")
600 main
['ARCOMSTR'] = Transform("AR", 0)
601 main
['LINKCOMSTR'] = Transform("LINK", 0)
602 main
['RANLIBCOMSTR'] = Transform("RANLIB", 0)
603 main
['M4COMSTR'] = Transform("M4")
604 main
['SHCCCOMSTR'] = Transform("SHCC")
605 main
['SHCXXCOMSTR'] = Transform("SHCXX")
608 # Initialize the Link-Time Optimization (LTO) flags
609 main
['LTO_CCFLAGS'] = []
610 main
['LTO_LDFLAGS'] = []
612 # According to the readme, tcmalloc works best if the compiler doesn't
613 # assume that we're using the builtin malloc and friends. These flags
614 # are compiler-specific, so we need to set them after we detect which
615 # compiler we're using.
616 main
['TCMALLOC_CCFLAGS'] = []
618 CXX_version
= readCommand([main
['CXX'],'--version'], exception
=False)
619 CXX_V
= readCommand([main
['CXX'],'-V'], exception
=False)
621 main
['GCC'] = CXX_version
and CXX_version
.find('g++') >= 0
622 main
['CLANG'] = CXX_version
and CXX_version
.find('clang') >= 0
623 if main
['GCC'] + main
['CLANG'] > 1:
624 print 'Error: How can we have two at the same time?'
627 # Set up default C++ compiler flags
628 if main
['GCC'] or main
['CLANG']:
629 # As gcc and clang share many flags, do the common parts here
630 main
.Append(CCFLAGS
=['-pipe'])
631 main
.Append(CCFLAGS
=['-fno-strict-aliasing'])
632 # Enable -Wall and -Wextra and then disable the few warnings that
633 # we consistently violate
634 main
.Append(CCFLAGS
=['-Wall', '-Wundef', '-Wextra',
635 '-Wno-sign-compare', '-Wno-unused-parameter'])
636 # We always compile using C++11
637 main
.Append(CXXFLAGS
=['-std=c++11'])
639 print termcap
.Yellow
+ termcap
.Bold
+ 'Error' + termcap
.Normal
,
640 print "Don't know what compiler options to use for your compiler."
641 print termcap
.Yellow
+ ' compiler:' + termcap
.Normal
, main
['CXX']
642 print termcap
.Yellow
+ ' version:' + termcap
.Normal
,
644 print termcap
.Yellow
+ termcap
.Bold
+ "COMMAND NOT FOUND!" +\
647 print CXX_version
.replace('\n', '<nl>')
648 print " If you're trying to use a compiler other than GCC"
649 print " or clang, there appears to be something wrong with your"
650 print " environment."
652 print " If you are trying to use a compiler other than those listed"
653 print " above you will need to ease fix SConstruct and "
654 print " src/SConscript to support that compiler."
658 # Check for a supported version of gcc. >= 4.7 is chosen for its
659 # level of c++11 support. See
660 # http://gcc.gnu.org/projects/cxx0x.html for details.
661 gcc_version
= readCommand([main
['CXX'], '-dumpversion'], exception
=False)
662 if compareVersions(gcc_version
, "4.7") < 0:
663 print 'Error: gcc version 4.7 or newer required.'
664 print ' Installed version:', gcc_version
667 main
['GCC_VERSION'] = gcc_version
669 # gcc from version 4.8 and above generates "rep; ret" instructions
670 # to avoid performance penalties on certain AMD chips. Older
671 # assemblers detect this as an error, "Error: expecting string
672 # instruction after `rep'"
673 if compareVersions(gcc_version
, "4.8") > 0:
674 as_version_raw
= readCommand([main
['AS'], '-v', '/dev/null'],
675 exception
=False).split()
677 # version strings may contain extra distro-specific
678 # qualifiers, so play it safe and keep only what comes before
680 as_version
= as_version_raw
[-1].split('-')[0] if as_version_raw \
683 if not as_version
or compareVersions(as_version
, "2.23") < 0:
684 print termcap
.Yellow
+ termcap
.Bold
+ \
685 'Warning: This combination of gcc and binutils have' + \
686 ' known incompatibilities.\n' + \
687 ' If you encounter build problems, please update ' + \
688 'binutils to 2.23.' + \
691 # Make sure we warn if the user has requested to compile with the
692 # Undefined Benahvior Sanitizer and this version of gcc does not
694 if GetOption('with_ubsan') and \
695 compareVersions(gcc_version
, '4.9') < 0:
696 print termcap
.Yellow
+ termcap
.Bold
+ \
697 'Warning: UBSan is only supported using gcc 4.9 and later.' + \
700 # Add the appropriate Link-Time Optimization (LTO) flags
701 # unless LTO is explicitly turned off. Note that these flags
702 # are only used by the fast target.
703 if not GetOption('no_lto'):
704 # Pass the LTO flag when compiling to produce GIMPLE
705 # output, we merely create the flags here and only append
707 main
['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
709 # Use the same amount of jobs for LTO as we are running
711 main
['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
713 main
.Append(TCMALLOC_CCFLAGS
=['-fno-builtin-malloc', '-fno-builtin-calloc',
714 '-fno-builtin-realloc', '-fno-builtin-free'])
717 # Check for a supported version of clang, >= 3.1 is needed to
718 # support similar features as gcc 4.7. See
719 # http://clang.llvm.org/cxx_status.html for details
720 clang_version_re
= re
.compile(".* version (\d+\.\d+)")
721 clang_version_match
= clang_version_re
.search(CXX_version
)
722 if (clang_version_match
):
723 clang_version
= clang_version_match
.groups()[0]
724 if compareVersions(clang_version
, "3.1") < 0:
725 print 'Error: clang version 3.1 or newer required.'
726 print ' Installed version:', clang_version
729 print 'Error: Unable to determine clang version.'
732 # clang has a few additional warnings that we disable, extraneous
733 # parantheses are allowed due to Ruby's printing of the AST,
734 # finally self assignments are allowed as the generated CPU code
736 main
.Append(CCFLAGS
=['-Wno-parentheses',
738 # Some versions of libstdc++ (4.8?) seem to
739 # use struct hash and class hash
741 '-Wno-mismatched-tags',
744 main
.Append(TCMALLOC_CCFLAGS
=['-fno-builtin'])
746 # On Mac OS X/Darwin we need to also use libc++ (part of XCode) as
747 # opposed to libstdc++, as the later is dated.
748 if sys
.platform
== "darwin":
749 main
.Append(CXXFLAGS
=['-stdlib=libc++'])
750 main
.Append(LIBS
=['c++'])
753 print termcap
.Yellow
+ termcap
.Bold
+ 'Error' + termcap
.Normal
,
754 print "Don't know what compiler options to use for your compiler."
755 print termcap
.Yellow
+ ' compiler:' + termcap
.Normal
, main
['CXX']
756 print termcap
.Yellow
+ ' version:' + termcap
.Normal
,
758 print termcap
.Yellow
+ termcap
.Bold
+ "COMMAND NOT FOUND!" +\
761 print CXX_version
.replace('\n', '<nl>')
762 print " If you're trying to use a compiler other than GCC"
763 print " or clang, there appears to be something wrong with your"
764 print " environment."
766 print " If you are trying to use a compiler other than those listed"
767 print " above you will need to ease fix SConstruct and "
768 print " src/SConscript to support that compiler."
771 # Set up common yacc/bison flags (needed for Ruby)
772 main
['YACCFLAGS'] = '-d'
773 main
['YACCHXXFILESUFFIX'] = '.hh'
775 # Do this after we save setting back, or else we'll tack on an
776 # extra 'qdo' every time we run scons.
778 main
['CC'] = main
['BATCH_CMD'] + ' ' + main
['CC']
779 main
['CXX'] = main
['BATCH_CMD'] + ' ' + main
['CXX']
780 main
['AS'] = main
['BATCH_CMD'] + ' ' + main
['AS']
781 main
['AR'] = main
['BATCH_CMD'] + ' ' + main
['AR']
782 main
['RANLIB'] = main
['BATCH_CMD'] + ' ' + main
['RANLIB']
784 if sys
.platform
== 'cygwin':
785 # cygwin has some header file issues...
786 main
.Append(CCFLAGS
=["-Wno-uninitialized"])
788 # Check for the protobuf compiler
789 protoc_version
= readCommand([main
['PROTOC'], '--version'],
790 exception
='').split()
792 # First two words should be "libprotoc x.y.z"
793 if len(protoc_version
) < 2 or protoc_version
[0] != 'libprotoc':
794 print termcap
.Yellow
+ termcap
.Bold
+ \
795 'Warning: Protocol buffer compiler (protoc) not found.\n' + \
796 ' Please install protobuf-compiler for tracing support.' + \
798 main
['PROTOC'] = False
800 # Based on the availability of the compress stream wrappers,
802 min_protoc_version
= '2.1.0'
803 if compareVersions(protoc_version
[1], min_protoc_version
) < 0:
804 print termcap
.Yellow
+ termcap
.Bold
+ \
805 'Warning: protoc version', min_protoc_version
, \
806 'or newer required.\n' + \
807 ' Installed version:', protoc_version
[1], \
809 main
['PROTOC'] = False
811 # Attempt to determine the appropriate include path and
812 # library path using pkg-config, that means we also need to
813 # check for pkg-config. Note that it is possible to use
814 # protobuf without the involvement of pkg-config. Later on we
815 # check go a library config check and at that point the test
816 # will fail if libprotobuf cannot be found.
817 if readCommand(['pkg-config', '--version'], exception
=''):
819 # Attempt to establish what linking flags to add for protobuf
821 main
.ParseConfig('pkg-config --cflags --libs-only-L protobuf')
823 print termcap
.Yellow
+ termcap
.Bold
+ \
824 'Warning: pkg-config could not get protobuf flags.' + \
828 if not main
.has_key('SWIG'):
829 print 'Error: SWIG utility not found.'
830 print ' Please install (see http://www.swig.org) and retry.'
833 # Check for appropriate SWIG version
834 swig_version
= readCommand([main
['SWIG'], '-version'], exception
='').split()
835 # First 3 words should be "SWIG Version x.y.z"
836 if len(swig_version
) < 3 or \
837 swig_version
[0] != 'SWIG' or swig_version
[1] != 'Version':
838 print 'Error determining SWIG version.'
841 min_swig_version
= '2.0.4'
842 if compareVersions(swig_version
[2], min_swig_version
) < 0:
843 print 'Error: SWIG version', min_swig_version
, 'or newer required.'
844 print ' Installed version:', swig_version
[2]
847 # Check for known incompatibilities. The standard library shipped with
848 # gcc >= 4.9 does not play well with swig versions prior to 3.0
849 if main
['GCC'] and compareVersions(gcc_version
, '4.9') >= 0 and \
850 compareVersions(swig_version
[2], '3.0') < 0:
851 print termcap
.Yellow
+ termcap
.Bold
+ \
852 'Warning: This combination of gcc and swig have' + \
853 ' known incompatibilities.\n' + \
854 ' If you encounter build problems, please update ' + \
855 'swig to 3.0 or later.' + \
858 # Set up SWIG flags & scanner
859 swig_flags
=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
860 main
.Append(SWIGFLAGS
=swig_flags
)
862 # Check for 'timeout' from GNU coreutils. If present, regressions will
863 # be run with a time limit. We require version 8.13 since we rely on
864 # support for the '--foreground' option.
865 timeout_lines
= readCommand(['timeout', '--version'],
866 exception
='').splitlines()
867 # Get the first line and tokenize it
868 timeout_version
= timeout_lines
[0].split() if timeout_lines
else []
869 main
['TIMEOUT'] = timeout_version
and \
870 compareVersions(timeout_version
[-1], '8.13') >= 0
872 # filter out all existing swig scanners, they mess up the dependency
873 # stuff for some reason
875 for scanner
in main
['SCANNERS']:
876 skeys
= scanner
.skeys
880 if isinstance(skeys
, (list, tuple)) and '.i' in skeys
:
883 scanners
.append(scanner
)
885 # add the new swig scanner that we like better
886 from SCons
.Scanner
import ClassicCPP
as CPPScanner
887 swig_inc_re
= '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
888 scanners
.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re
))
890 # replace the scanners list that has what we want
891 main
['SCANNERS'] = scanners
893 # Add a custom Check function to test for structure members.
894 def CheckMember(context
, include
, decl
, member
, include_quotes
="<>"):
895 context
.Message("Checking for member %s in %s..." %
901 (void)test.%(member)s;
904 """ % { "header" : include_quotes
[0] + include
+ include_quotes
[1],
909 ret
= context
.TryCompile(text
, extension
=".cc")
913 # Platform-specific configuration. Note again that we assume that all
914 # builds under a given build root run on the same host platform.
915 conf
= Configure(main
,
916 conf_dir
= joinpath(build_root
, '.scons_config'),
917 log_file
= joinpath(build_root
, 'scons_config.log'),
919 'CheckMember' : CheckMember
,
922 # Check if we should compile a 64 bit binary on Mac OS X/Darwin
925 uname
= platform
.uname()
926 if uname
[0] == 'Darwin' and compareVersions(uname
[2], '9.0.0') >= 0:
927 if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
928 main
.Append(CCFLAGS
=['-arch', 'x86_64'])
929 main
.Append(CFLAGS
=['-arch', 'x86_64'])
930 main
.Append(LINKFLAGS
=['-arch', 'x86_64'])
931 main
.Append(ASFLAGS
=['-arch', 'x86_64'])
935 # Recent versions of scons substitute a "Null" object for Configure()
936 # when configuration isn't necessary, e.g., if the "--help" option is
937 # present. Unfortuantely this Null object always returns false,
938 # breaking all our configuration checks. We replace it with our own
939 # more optimistic null object that returns True instead.
941 def NullCheck(*args
, **kwargs
):
945 def __init__(self
, env
):
949 def __getattr__(self
, mname
):
952 conf
= NullConf(main
)
954 # Cache build files in the supplied directory.
955 if main
['M5_BUILD_CACHE']:
956 print 'Using build cache located at', main
['M5_BUILD_CACHE']
957 CacheDir(main
['M5_BUILD_CACHE'])
959 if not GetOption('without_python'):
960 # Find Python include and library directories for embedding the
961 # interpreter. We rely on python-config to resolve the appropriate
962 # includes and linker flags. ParseConfig does not seem to understand
963 # the more exotic linker flags such as -Xlinker and -export-dynamic so
964 # we add them explicitly below. If you want to link in an alternate
965 # version of python, see above for instructions on how to invoke
966 # scons with the appropriate PATH set.
968 # First we check if python2-config exists, else we use python-config
969 python_config
= readCommand(['which', 'python2-config'],
970 exception
='').strip()
971 if not os
.path
.exists(python_config
):
972 python_config
= readCommand(['which', 'python-config'],
973 exception
='').strip()
974 py_includes
= readCommand([python_config
, '--includes'],
975 exception
='').split()
976 # Strip the -I from the include folders before adding them to the
978 main
.Append(CPPPATH
=map(lambda inc
: inc
[2:], py_includes
))
980 # Read the linker flags and split them into libraries and other link
981 # flags. The libraries are added later through the call the CheckLib.
982 py_ld_flags
= readCommand([python_config
, '--ldflags'],
983 exception
='').split()
985 for lib
in py_ld_flags
:
986 if not lib
.startswith('-l'):
987 main
.Append(LINKFLAGS
=[lib
])
990 if lib
not in py_libs
:
993 # verify that this stuff works
994 if not conf
.CheckHeader('Python.h', '<>'):
995 print "Error: can't find Python.h header in", py_includes
996 print "Install Python headers (package python-dev on Ubuntu and RedHat)"
1000 if not conf
.CheckLib(lib
):
1001 print "Error: can't find library %s required by python" % lib
1004 # On Solaris you need to use libsocket for socket ops
1005 if not conf
.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
1006 if not conf
.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
1007 print "Can't find library with socket calls (e.g. accept())"
1010 # Check for zlib. If the check passes, libz will be automatically
1011 # added to the LIBS environment variable.
1012 if not conf
.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
1013 print 'Error: did not find needed zlib compression library '\
1014 'and/or zlib.h header file.'
1015 print ' Please install zlib and try again.'
1018 # If we have the protobuf compiler, also make sure we have the
1019 # development libraries. If the check passes, libprotobuf will be
1020 # automatically added to the LIBS environment variable. After
1021 # this, we can use the HAVE_PROTOBUF flag to determine if we have
1022 # got both protoc and libprotobuf available.
1023 main
['HAVE_PROTOBUF'] = main
['PROTOC'] and \
1024 conf
.CheckLibWithHeader('protobuf', 'google/protobuf/message.h',
1025 'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;')
1027 # If we have the compiler but not the library, print another warning.
1028 if main
['PROTOC'] and not main
['HAVE_PROTOBUF']:
1029 print termcap
.Yellow
+ termcap
.Bold
+ \
1030 'Warning: did not find protocol buffer library and/or headers.\n' + \
1031 ' Please install libprotobuf-dev for tracing support.' + \
1035 have_posix_clock
= \
1036 conf
.CheckLibWithHeader(None, 'time.h', 'C',
1037 'clock_nanosleep(0,0,NULL,NULL);') or \
1038 conf
.CheckLibWithHeader('rt', 'time.h', 'C',
1039 'clock_nanosleep(0,0,NULL,NULL);')
1041 have_posix_timers
= \
1042 conf
.CheckLibWithHeader([None, 'rt'], [ 'time.h', 'signal.h' ], 'C',
1043 'timer_create(CLOCK_MONOTONIC, NULL, NULL);')
1045 if not GetOption('without_tcmalloc'):
1046 if conf
.CheckLib('tcmalloc'):
1047 main
.Append(CCFLAGS
=main
['TCMALLOC_CCFLAGS'])
1048 elif conf
.CheckLib('tcmalloc_minimal'):
1049 main
.Append(CCFLAGS
=main
['TCMALLOC_CCFLAGS'])
1051 print termcap
.Yellow
+ termcap
.Bold
+ \
1052 "You can get a 12% performance improvement by "\
1053 "installing tcmalloc (libgoogle-perftools-dev package "\
1054 "on Ubuntu or RedHat)." + termcap
.Normal
1057 # Detect back trace implementations. The last implementation in the
1058 # list will be used by default.
1059 backtrace_impls
= [ "none" ]
1061 if conf
.CheckLibWithHeader(None, 'execinfo.h', 'C',
1062 'backtrace_symbols_fd((void*)0, 0, 0);'):
1063 backtrace_impls
.append("glibc")
1065 if backtrace_impls
[-1] == "none":
1066 default_backtrace_impl
= "none"
1067 print termcap
.Yellow
+ termcap
.Bold
+ \
1068 "No suitable back trace implementation found." + \
1071 if not have_posix_clock
:
1072 print "Can't find library for POSIX clocks."
1074 # Check for <fenv.h> (C99 FP environment control)
1075 have_fenv
= conf
.CheckHeader('fenv.h', '<>')
1077 print "Warning: Header file <fenv.h> not found."
1078 print " This host has no IEEE FP rounding mode control."
1080 # Check if we should enable KVM-based hardware virtualization. The API
1081 # we rely on exists since version 2.6.36 of the kernel, but somehow
1082 # the KVM_API_VERSION does not reflect the change. We test for one of
1083 # the types as a fall back.
1084 have_kvm
= conf
.CheckHeader('linux/kvm.h', '<>')
1086 print "Info: Compatible header file <linux/kvm.h> not found, " \
1087 "disabling KVM support."
1089 # x86 needs support for xsave. We test for the structure here since we
1090 # won't be able to run new tests by the time we know which ISA we're
1092 have_kvm_xsave
= conf
.CheckTypeSize('struct kvm_xsave',
1093 '#include <linux/kvm.h>') != 0
1095 # Check if the requested target ISA is compatible with the host
1096 def is_isa_kvm_compatible(isa
):
1099 host_isa
= platform
.machine()
1101 print "Warning: Failed to determine host ISA."
1104 if not have_posix_timers
:
1105 print "Warning: Can not enable KVM, host seems to lack support " \
1110 return host_isa
in ( "armv7l", "aarch64" )
1112 if host_isa
!= "x86_64":
1115 if not have_kvm_xsave
:
1116 print "KVM on x86 requires xsave support in kernel headers."
1124 # Check if the exclude_host attribute is available. We want this to
1125 # get accurate instruction counts in KVM.
1126 main
['HAVE_PERF_ATTR_EXCLUDE_HOST'] = conf
.CheckMember(
1127 'linux/perf_event.h', 'struct perf_event_attr', 'exclude_host')
1130 ######################################################################
1132 # Finish the configuration
1134 main
= conf
.Finish()
1136 ######################################################################
1138 # Collect all non-global variables
1141 # Define the universe of supported ISAs
1143 all_gpu_isa_list
= [ ]
1144 Export('all_isa_list')
1145 Export('all_gpu_isa_list')
1147 class CpuModel(object):
1148 '''The CpuModel class encapsulates everything the ISA parser needs to
1149 know about a particular CPU model.'''
1151 # Dict of available CPU model objects. Accessible as CpuModel.dict.
1154 # Constructor. Automatically adds models to CpuModel.dict.
1155 def __init__(self
, name
, default
=False):
1156 self
.name
= name
# name of model
1158 # This cpu is enabled by default
1159 self
.default
= default
1162 if name
in CpuModel
.dict:
1163 raise AttributeError, "CpuModel '%s' already registered" % name
1164 CpuModel
.dict[name
] = self
1168 # Sticky variables get saved in the variables file so they persist from
1169 # one invocation to the next (unless overridden, in which case the new
1170 # value becomes sticky).
1171 sticky_vars
= Variables(args
=ARGUMENTS
)
1172 Export('sticky_vars')
1174 # Sticky variables that should be exported
1176 Export('export_vars')
1180 Export('all_protocols')
1182 Export('protocol_dirs')
1184 Export('slicc_includes')
1186 # Walk the tree and execute all SConsopts scripts that wil add to the
1188 if GetOption('verbose'):
1189 print "Reading SConsopts"
1190 for bdir
in [ base_dir
] + extras_dir_list
:
1192 print "Error: directory '%s' does not exist" % bdir
1194 for root
, dirs
, files
in os
.walk(bdir
):
1195 if 'SConsopts' in files
:
1196 if GetOption('verbose'):
1197 print "Reading", joinpath(root
, 'SConsopts')
1198 SConscript(joinpath(root
, 'SConsopts'))
1201 all_gpu_isa_list
.sort()
1203 sticky_vars
.AddVariables(
1204 EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list
),
1205 EnumVariable('TARGET_GPU_ISA', 'Target GPU ISA', 'hsail', all_gpu_isa_list
),
1206 ListVariable('CPU_MODELS', 'CPU models',
1207 sorted(n
for n
,m
in CpuModel
.dict.iteritems() if m
.default
),
1208 sorted(CpuModel
.dict.keys())),
1209 BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
1211 BoolVariable('SS_COMPATIBLE_FP',
1212 'Make floating-point results compatible with SimpleScalar',
1214 BoolVariable('USE_SSE2',
1215 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
1217 BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock
),
1218 BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv
),
1219 BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False),
1220 BoolVariable('USE_KVM', 'Enable hardware virtualized (KVM) CPU models', have_kvm
),
1221 BoolVariable('BUILD_GPU', 'Build the compute-GPU model', False),
1222 EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None',
1224 EnumVariable('BACKTRACE_IMPL', 'Post-mortem dump implementation',
1225 backtrace_impls
[-1], backtrace_impls
)
1228 # These variables get exported to #defines in config/*.hh (see src/SConscript).
1229 export_vars
+= ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'TARGET_GPU_ISA',
1230 'CP_ANNOTATE', 'USE_POSIX_CLOCK', 'USE_KVM', 'PROTOCOL',
1231 'HAVE_PROTOBUF', 'HAVE_PERF_ATTR_EXCLUDE_HOST']
1233 ###################################################
1235 # Define a SCons builder for configuration flag headers.
1237 ###################################################
1239 # This function generates a config header file that #defines the
1240 # variable symbol to the current variable setting (0 or 1). The source
1241 # operands are the name of the variable and a Value node containing the
1242 # value of the variable.
1243 def build_config_file(target
, source
, env
):
1244 (variable
, value
) = [s
.get_contents() for s
in source
]
1245 f
= file(str(target
[0]), 'w')
1246 print >> f
, '#define', variable
, value
1250 # Combine the two functions into a scons Action object.
1251 config_action
= MakeAction(build_config_file
, Transform("CONFIG H", 2))
1253 # The emitter munges the source & target node lists to reflect what
1254 # we're really doing.
1255 def config_emitter(target
, source
, env
):
1256 # extract variable name from Builder arg
1257 variable
= str(target
[0])
1258 # True target is config header file
1259 target
= joinpath('config', variable
.lower() + '.hh')
1261 if isinstance(val
, bool):
1262 # Force value to 0/1
1264 elif isinstance(val
, str):
1265 val
= '"' + val
+ '"'
1267 # Sources are variable name & value (packaged in SCons Value nodes)
1268 return ([target
], [Value(variable
), Value(val
)])
1270 config_builder
= Builder(emitter
= config_emitter
, action
= config_action
)
1272 main
.Append(BUILDERS
= { 'ConfigFile' : config_builder
})
1274 # libelf build is shared across all configs in the build root.
1275 main
.SConscript('ext/libelf/SConscript',
1276 variant_dir
= joinpath(build_root
, 'libelf'))
1278 # iostream3 build is shared across all configs in the build root.
1279 main
.SConscript('ext/iostream3/SConscript',
1280 variant_dir
= joinpath(build_root
, 'iostream3'))
1282 # libfdt build is shared across all configs in the build root.
1283 main
.SConscript('ext/libfdt/SConscript',
1284 variant_dir
= joinpath(build_root
, 'libfdt'))
1286 # fputils build is shared across all configs in the build root.
1287 main
.SConscript('ext/fputils/SConscript',
1288 variant_dir
= joinpath(build_root
, 'fputils'))
1290 # DRAMSim2 build is shared across all configs in the build root.
1291 main
.SConscript('ext/dramsim2/SConscript',
1292 variant_dir
= joinpath(build_root
, 'dramsim2'))
1294 # DRAMPower build is shared across all configs in the build root.
1295 main
.SConscript('ext/drampower/SConscript',
1296 variant_dir
= joinpath(build_root
, 'drampower'))
1298 # nomali build is shared across all configs in the build root.
1299 main
.SConscript('ext/nomali/SConscript',
1300 variant_dir
= joinpath(build_root
, 'nomali'))
1302 ###################################################
1304 # This function is used to set up a directory with switching headers
1306 ###################################################
1308 main
['ALL_ISA_LIST'] = all_isa_list
1309 main
['ALL_GPU_ISA_LIST'] = all_gpu_isa_list
1311 def make_switching_dir(dname
, switch_headers
, env
):
1312 # Generate the header. target[0] is the full path of the output
1313 # header to generate. 'source' is a dummy variable, since we get the
1314 # list of ISAs from env['ALL_ISA_LIST'].
1315 def gen_switch_hdr(target
, source
, env
):
1316 fname
= str(target
[0])
1317 isa
= env
['TARGET_ISA'].lower()
1319 f
= open(fname
, 'w')
1320 print >>f
, '#include "%s/%s/%s"' % (dname
, isa
, basename(fname
))
1323 print "Failed to create %s" % fname
1326 # Build SCons Action object. 'varlist' specifies env vars that this
1327 # action depends on; when env['ALL_ISA_LIST'] changes these actions
1328 # should get re-executed.
1329 switch_hdr_action
= MakeAction(gen_switch_hdr
,
1330 Transform("GENERATE"), varlist
=['ALL_ISA_LIST'])
1332 # Instantiate actions for each header
1333 for hdr
in switch_headers
:
1334 env
.Command(hdr
, [], switch_hdr_action
)
1336 isa_target
= Dir('.').up().name
.lower().replace('_', '-')
1337 env
['PHONY_BASE'] = '#'+isa_target
1338 all_isa_deps
[isa_target
] = None
1340 Export('make_switching_dir')
1342 def make_gpu_switching_dir(dname
, switch_headers
, env
):
1343 # Generate the header. target[0] is the full path of the output
1344 # header to generate. 'source' is a dummy variable, since we get the
1345 # list of ISAs from env['ALL_ISA_LIST'].
1346 def gen_switch_hdr(target
, source
, env
):
1347 fname
= str(target
[0])
1349 isa
= env
['TARGET_GPU_ISA'].lower()
1352 f
= open(fname
, 'w')
1353 print >>f
, '#include "%s/%s/%s"' % (dname
, isa
, basename(fname
))
1356 print "Failed to create %s" % fname
1359 # Build SCons Action object. 'varlist' specifies env vars that this
1360 # action depends on; when env['ALL_ISA_LIST'] changes these actions
1361 # should get re-executed.
1362 switch_hdr_action
= MakeAction(gen_switch_hdr
,
1363 Transform("GENERATE"), varlist
=['ALL_ISA_GPU_LIST'])
1365 # Instantiate actions for each header
1366 for hdr
in switch_headers
:
1367 env
.Command(hdr
, [], switch_hdr_action
)
1369 Export('make_gpu_switching_dir')
1371 # all-isas -> all-deps -> all-environs -> all_targets
1372 main
.Alias('#all-isas', [])
1373 main
.Alias('#all-deps', '#all-isas')
1375 # Dummy target to ensure all environments are created before telling
1376 # SCons what to actually make (the command line arguments). We attach
1377 # them to the dependence graph after the environments are complete.
1378 ORIG_BUILD_TARGETS
= list(BUILD_TARGETS
) # force a copy; gets closure to work.
1379 def environsComplete(target
, source
, env
):
1380 for t
in ORIG_BUILD_TARGETS
:
1381 main
.Depends('#all-targets', t
)
1383 # Each build/* switching_dir attaches its *-environs target to #all-environs.
1384 main
.Append(BUILDERS
= {'CompleteEnvirons' :
1385 Builder(action
=MakeAction(environsComplete
, None))})
1386 main
.CompleteEnvirons('#all-environs', [])
1388 def doNothing(**ignored
): pass
1389 main
.Append(BUILDERS
= {'Dummy': Builder(action
=MakeAction(doNothing
, None))})
1391 # The final target to which all the original targets ultimately get attached.
1392 main
.Dummy('#all-targets', '#all-environs')
1393 BUILD_TARGETS
[:] = ['#all-targets']
1395 ###################################################
1397 # Define build environments for selected configurations.
1399 ###################################################
1401 for variant_path
in variant_paths
:
1402 if not GetOption('silent'):
1403 print "Building in", variant_path
1405 # Make a copy of the build-root environment to use for this config.
1407 env
['BUILDDIR'] = variant_path
1409 # variant_dir is the tail component of build path, and is used to
1410 # determine the build parameters (e.g., 'ALPHA_SE')
1411 (build_root
, variant_dir
) = splitpath(variant_path
)
1413 # Set env variables according to the build directory config.
1414 sticky_vars
.files
= []
1415 # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
1416 # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
1417 # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
1418 current_vars_file
= joinpath(build_root
, 'variables', variant_dir
)
1419 if isfile(current_vars_file
):
1420 sticky_vars
.files
.append(current_vars_file
)
1421 if not GetOption('silent'):
1422 print "Using saved variables file %s" % current_vars_file
1424 # Build dir-specific variables file doesn't exist.
1426 # Make sure the directory is there so we can create it later
1427 opt_dir
= dirname(current_vars_file
)
1428 if not isdir(opt_dir
):
1431 # Get default build variables from source tree. Variables are
1432 # normally determined by name of $VARIANT_DIR, but can be
1433 # overridden by '--default=' arg on command line.
1434 default
= GetOption('default')
1435 opts_dir
= joinpath(main
.root
.abspath
, 'build_opts')
1437 default_vars_files
= [joinpath(build_root
, 'variables', default
),
1438 joinpath(opts_dir
, default
)]
1440 default_vars_files
= [joinpath(opts_dir
, variant_dir
)]
1441 existing_files
= filter(isfile
, default_vars_files
)
1443 default_vars_file
= existing_files
[0]
1444 sticky_vars
.files
.append(default_vars_file
)
1445 print "Variables file %s not found,\n using defaults in %s" \
1446 % (current_vars_file
, default_vars_file
)
1448 print "Error: cannot find variables file %s or " \
1449 "default file(s) %s" \
1450 % (current_vars_file
, ' or '.join(default_vars_files
))
1453 # Apply current variable settings to env
1454 sticky_vars
.Update(env
)
1456 help_texts
["local_vars"] += \
1457 "Build variables for %s:\n" % variant_dir \
1458 + sticky_vars
.GenerateHelpText(env
)
1460 # Process variable settings.
1462 if not have_fenv
and env
['USE_FENV']:
1463 print "Warning: <fenv.h> not available; " \
1464 "forcing USE_FENV to False in", variant_dir
+ "."
1465 env
['USE_FENV'] = False
1467 if not env
['USE_FENV']:
1468 print "Warning: No IEEE FP rounding mode control in", variant_dir
+ "."
1469 print " FP results may deviate slightly from other platforms."
1472 env
.Append(LIBS
=['efence'])
1476 print "Warning: Can not enable KVM, host seems to lack KVM support"
1477 env
['USE_KVM'] = False
1478 elif not is_isa_kvm_compatible(env
['TARGET_ISA']):
1479 print "Info: KVM support disabled due to unsupported host and " \
1480 "target ISA combination"
1481 env
['USE_KVM'] = False
1483 # Warn about missing optional functionality
1485 if not main
['HAVE_PERF_ATTR_EXCLUDE_HOST']:
1486 print "Warning: perf_event headers lack support for the " \
1487 "exclude_host attribute. KVM instruction counts will " \
1490 # Save sticky variable settings back to current variables file
1491 sticky_vars
.Save(current_vars_file
, env
)
1494 env
.Append(CCFLAGS
=['-msse2'])
1496 # The src/SConscript file sets up the build rules in 'env' according
1497 # to the configured variables. It returns a list of environments,
1498 # one for each variant build (debug, opt, etc.)
1499 SConscript('src/SConscript', variant_dir
= variant_path
, exports
= 'env')
1501 def pairwise(iterable
):
1502 "s -> (s0,s1), (s1,s2), (s2, s3), ..."
1503 a
, b
= itertools
.tee(iterable
)
1505 return itertools
.izip(a
, b
)
1507 # Create false dependencies so SCons will parse ISAs, establish
1508 # dependencies, and setup the build Environments serially. Either
1509 # SCons (likely) and/or our SConscripts (possibly) cannot cope with -j
1510 # greater than 1. It appears to be standard race condition stuff; it
1511 # doesn't always fail, but usually, and the behaviors are different.
1512 # Every time I tried to remove this, builds would fail in some
1513 # creative new way. So, don't do that. You'll want to, though, because
1514 # tests/SConscript takes a long time to make its Environments.
1515 for t1
, t2
in pairwise(sorted(all_isa_deps
.iterkeys())):
1516 main
.Depends('#%s-deps' % t2
, '#%s-deps' % t1
)
1517 main
.Depends('#%s-environs' % t2
, '#%s-environs' % t1
)
1521 Usage: scons [scons options] [build variables] [target(s)]
1523 Extra scons options:
1526 Global build variables: